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/{hpa-attribute-key}/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: hpa-attribute-key
5406           in: path
5407           description: name of the specific HPA attribute
5408           required: true
5409           type: string
5410           example: __HPA-ATTRIBUTE-KEY__
5411         - name: body
5412           in: body
5413           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
5414           required: true
5415           schema:
5416             $ref: "#/definitions/relationship"
5417     delete:
5418       tags:
5419         - CloudInfrastructure
5420       summary: delete an existing relationship
5421       description: delete an existing relationship
5422       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
5423       consumes:
5424         - application/json
5425         - application/xml
5426       produces:
5427         - application/json
5428         - application/xml
5429       responses:
5430         "default":
5431           description: Response codes found in [response codes](https://wiki.onap.org/).
5432       parameters:
5433         - name: cloud-owner
5434           in: path
5435           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5436           required: true
5437           type: string
5438           example: __CLOUD-OWNER__
5439         - name: cloud-region-id
5440           in: path
5441           description: Identifier used by the vendor for the region. Second part of composite key
5442           required: true
5443           type: string
5444           example: __CLOUD-REGION-ID__
5445         - name: flavor-id
5446           in: path
5447           description: Flavor id, expected to be unique across cloud-region.
5448           required: true
5449           type: string
5450           example: __FLAVOR-ID__
5451         - name: hpa-capability-id
5452           in: path
5453           description: UUID to uniquely identify a HPA capability
5454           required: true
5455           type: string
5456           example: __HPA-CAPABILITY-ID__
5457         - name: hpa-attribute-key
5458           in: path
5459           description: name of the specific HPA attribute
5460           required: true
5461           type: string
5462           example: __HPA-ATTRIBUTE-KEY__
5463   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
5464     get:
5465       tags:
5466         - CloudInfrastructure
5467       summary: returns hpa-feature-attributes
5468       description: returns hpa-feature-attributes
5469       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
5470       produces:
5471         - application/json
5472         - application/xml
5473       responses:
5474         "200":
5475           description: successful operation
5476           schema:
5477               $ref: "#/getDefinitions/hpa-feature-attributes"
5478         "default":
5479           description: Response codes found in [response codes](https://wiki.onap.org/).
5480       parameters:
5481         - name: cloud-owner
5482           in: path
5483           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5484           required: true
5485           type: string
5486           example: __CLOUD-OWNER__
5487         - name: cloud-region-id
5488           in: path
5489           description: Identifier used by the vendor for the region. Second part of composite key
5490           required: true
5491           type: string
5492           example: __CLOUD-REGION-ID__
5493         - name: flavor-id
5494           in: path
5495           description: Flavor id, expected to be unique across cloud-region.
5496           required: true
5497           type: string
5498           example: __FLAVOR-ID__
5499         - name: hpa-capability-id
5500           in: path
5501           description: UUID to uniquely identify a HPA capability
5502           required: true
5503           type: string
5504           example: __HPA-CAPABILITY-ID__
5505         - name: hpa-attribute-key
5506           in: path
5507           description: name of the specific HPA attribute
5508           required: true
5509           type: string
5510           example: __HPA-ATTRIBUTE-KEY__
5511         - name: cloud-type
5512           in: query
5513           description: Type of the cloud (e.g., openstack)
5514           required: false
5515           type: string
5516         - name: owner-defined-type
5517           in: query
5518           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5519           required: false
5520           type: string
5521         - name: flavor-name
5522           in: query
5523           description: Cloud Region Flavor name
5524           required: false
5525           type: string
5526         - name: hpa-feature
5527           in: query
5528           description: Name of the HPACapability
5529           required: false
5530           type: string
5531         - name: architecture
5532           in: query
5533           description: Hardware architecture
5534           required: false
5535           type: string
5536     put:
5537       tags:
5538         - CloudInfrastructure
5539       summary: create or update an existing hpa-feature-attributes
5540       description: |
5541         Create or update an existing hpa-feature-attributes.
5542         #
5543         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5544       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
5545       consumes:
5546         - application/json
5547         - application/xml
5548       produces:
5549         - application/json
5550         - application/xml
5551       responses:
5552         "default":
5553           description: Response codes found in [response codes](https://wiki.onap.org/).
5554       parameters:
5555         - name: cloud-owner
5556           in: path
5557           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5558           required: true
5559           type: string
5560           example: __CLOUD-OWNER__
5561         - name: cloud-region-id
5562           in: path
5563           description: Identifier used by the vendor for the region. Second part of composite key
5564           required: true
5565           type: string
5566           example: __CLOUD-REGION-ID__
5567         - name: flavor-id
5568           in: path
5569           description: Flavor id, expected to be unique across cloud-region.
5570           required: true
5571           type: string
5572           example: __FLAVOR-ID__
5573         - name: hpa-capability-id
5574           in: path
5575           description: UUID to uniquely identify a HPA capability
5576           required: true
5577           type: string
5578           example: __HPA-CAPABILITY-ID__
5579         - name: hpa-attribute-key
5580           in: path
5581           description: name of the specific HPA attribute
5582           required: true
5583           type: string
5584           example: __HPA-ATTRIBUTE-KEY__
5585         - name: body
5586           in: body
5587           description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
5588           required: true
5589           schema:
5590             $ref: "#/definitions/hpa-feature-attributes"
5591     patch:
5592       tags:
5593         - CloudInfrastructure
5594       summary: update an existing hpa-feature-attributes
5595       description: |
5596         Update an existing hpa-feature-attributes
5597         #
5598         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5599         The PUT operation will entirely replace an existing object.
5600         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5601         #
5602         Other differences between PUT and PATCH are:
5603         #
5604         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5605         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5606         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5607       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
5608       consumes:
5609         - application/json
5610         - application/xml
5611       produces:
5612         - application/json
5613         - application/xml
5614       responses:
5615         "default":
5616           description: Response codes found in [response codes](https://wiki.onap.org/).
5617       parameters:
5618         - name: cloud-owner
5619           in: path
5620           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5621           required: true
5622           type: string
5623           example: __CLOUD-OWNER__
5624         - name: cloud-region-id
5625           in: path
5626           description: Identifier used by the vendor for the region. Second part of composite key
5627           required: true
5628           type: string
5629           example: __CLOUD-REGION-ID__
5630         - name: flavor-id
5631           in: path
5632           description: Flavor id, expected to be unique across cloud-region.
5633           required: true
5634           type: string
5635           example: __FLAVOR-ID__
5636         - name: hpa-capability-id
5637           in: path
5638           description: UUID to uniquely identify a HPA capability
5639           required: true
5640           type: string
5641           example: __HPA-CAPABILITY-ID__
5642         - name: hpa-attribute-key
5643           in: path
5644           description: name of the specific HPA attribute
5645           required: true
5646           type: string
5647           example: __HPA-ATTRIBUTE-KEY__
5648         - name: body
5649           in: body
5650           description: hpa-feature-attributes object that needs to be created or updated.
5651           required: true
5652           schema:
5653             $ref: "#/patchDefinitions/hpa-feature-attributes"
5654     delete:
5655       tags:
5656         - CloudInfrastructure
5657       summary: delete an existing hpa-feature-attributes
5658       description: delete an existing hpa-feature-attributes
5659       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
5660       consumes:
5661         - application/json
5662         - application/xml
5663       produces:
5664         - application/json
5665         - application/xml
5666       responses:
5667         "default":
5668           description: Response codes found in [response codes](https://wiki.onap.org/).
5669       parameters:
5670         - name: cloud-owner
5671           in: path
5672           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5673           required: true
5674           type: string
5675           example: __CLOUD-OWNER__
5676         - name: cloud-region-id
5677           in: path
5678           description: Identifier used by the vendor for the region. Second part of composite key
5679           required: true
5680           type: string
5681           example: __CLOUD-REGION-ID__
5682         - name: flavor-id
5683           in: path
5684           description: Flavor id, expected to be unique across cloud-region.
5685           required: true
5686           type: string
5687           example: __FLAVOR-ID__
5688         - name: hpa-capability-id
5689           in: path
5690           description: UUID to uniquely identify a HPA capability
5691           required: true
5692           type: string
5693           example: __HPA-CAPABILITY-ID__
5694         - name: hpa-attribute-key
5695           in: path
5696           description: name of the specific HPA attribute
5697           required: true
5698           type: string
5699           example: __HPA-ATTRIBUTE-KEY__
5700         - name: resource-version
5701           in: query
5702           description: resource-version for concurrency
5703           required: true
5704           type: string
5705   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
5706     get:
5707       tags:
5708         - CloudInfrastructure
5709       summary: returns hpa-capability
5710       description: returns hpa-capability
5711       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5712       produces:
5713         - application/json
5714         - application/xml
5715       responses:
5716         "200":
5717           description: successful operation
5718           schema:
5719               $ref: "#/getDefinitions/hpa-capability"
5720         "default":
5721           description: Response codes found in [response codes](https://wiki.onap.org/).
5722       parameters:
5723         - name: cloud-owner
5724           in: path
5725           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5726           required: true
5727           type: string
5728           example: __CLOUD-OWNER__
5729         - name: cloud-region-id
5730           in: path
5731           description: Identifier used by the vendor for the region. Second part of composite key
5732           required: true
5733           type: string
5734           example: __CLOUD-REGION-ID__
5735         - name: flavor-id
5736           in: path
5737           description: Flavor id, expected to be unique across cloud-region.
5738           required: true
5739           type: string
5740           example: __FLAVOR-ID__
5741         - name: hpa-capability-id
5742           in: path
5743           description: UUID to uniquely identify a HPA capability
5744           required: true
5745           type: string
5746           example: __HPA-CAPABILITY-ID__
5747         - name: cloud-type
5748           in: query
5749           description: Type of the cloud (e.g., openstack)
5750           required: false
5751           type: string
5752         - name: owner-defined-type
5753           in: query
5754           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5755           required: false
5756           type: string
5757         - name: flavor-name
5758           in: query
5759           description: Cloud Region Flavor name
5760           required: false
5761           type: string
5762         - name: hpa-feature
5763           in: query
5764           description: Name of the HPACapability
5765           required: false
5766           type: string
5767         - name: architecture
5768           in: query
5769           description: Hardware architecture
5770           required: false
5771           type: string
5772     put:
5773       tags:
5774         - CloudInfrastructure
5775       summary: create or update an existing hpa-capability
5776       description: |
5777         Create or update an existing hpa-capability.
5778         #
5779         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5780       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5781       consumes:
5782         - application/json
5783         - application/xml
5784       produces:
5785         - application/json
5786         - application/xml
5787       responses:
5788         "default":
5789           description: Response codes found in [response codes](https://wiki.onap.org/).
5790       parameters:
5791         - name: cloud-owner
5792           in: path
5793           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5794           required: true
5795           type: string
5796           example: __CLOUD-OWNER__
5797         - name: cloud-region-id
5798           in: path
5799           description: Identifier used by the vendor for the region. Second part of composite key
5800           required: true
5801           type: string
5802           example: __CLOUD-REGION-ID__
5803         - name: flavor-id
5804           in: path
5805           description: Flavor id, expected to be unique across cloud-region.
5806           required: true
5807           type: string
5808           example: __FLAVOR-ID__
5809         - name: hpa-capability-id
5810           in: path
5811           description: UUID to uniquely identify a HPA capability
5812           required: true
5813           type: string
5814           example: __HPA-CAPABILITY-ID__
5815         - name: body
5816           in: body
5817           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
5818           required: true
5819           schema:
5820             $ref: "#/definitions/hpa-capability"
5821     patch:
5822       tags:
5823         - CloudInfrastructure
5824       summary: update an existing hpa-capability
5825       description: |
5826         Update an existing hpa-capability
5827         #
5828         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5829         The PUT operation will entirely replace an existing object.
5830         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5831         #
5832         Other differences between PUT and PATCH are:
5833         #
5834         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5835         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5836         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5837       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5838       consumes:
5839         - application/json
5840         - application/xml
5841       produces:
5842         - application/json
5843         - application/xml
5844       responses:
5845         "default":
5846           description: Response codes found in [response codes](https://wiki.onap.org/).
5847       parameters:
5848         - name: cloud-owner
5849           in: path
5850           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5851           required: true
5852           type: string
5853           example: __CLOUD-OWNER__
5854         - name: cloud-region-id
5855           in: path
5856           description: Identifier used by the vendor for the region. Second part of composite key
5857           required: true
5858           type: string
5859           example: __CLOUD-REGION-ID__
5860         - name: flavor-id
5861           in: path
5862           description: Flavor id, expected to be unique across cloud-region.
5863           required: true
5864           type: string
5865           example: __FLAVOR-ID__
5866         - name: hpa-capability-id
5867           in: path
5868           description: UUID to uniquely identify a HPA capability
5869           required: true
5870           type: string
5871           example: __HPA-CAPABILITY-ID__
5872         - name: body
5873           in: body
5874           description: hpa-capability object that needs to be created or updated.
5875           required: true
5876           schema:
5877             $ref: "#/patchDefinitions/hpa-capability"
5878     delete:
5879       tags:
5880         - CloudInfrastructure
5881       summary: delete an existing hpa-capability
5882       description: delete an existing hpa-capability
5883       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5884       consumes:
5885         - application/json
5886         - application/xml
5887       produces:
5888         - application/json
5889         - application/xml
5890       responses:
5891         "default":
5892           description: Response codes found in [response codes](https://wiki.onap.org/).
5893       parameters:
5894         - name: cloud-owner
5895           in: path
5896           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5897           required: true
5898           type: string
5899           example: __CLOUD-OWNER__
5900         - name: cloud-region-id
5901           in: path
5902           description: Identifier used by the vendor for the region. Second part of composite key
5903           required: true
5904           type: string
5905           example: __CLOUD-REGION-ID__
5906         - name: flavor-id
5907           in: path
5908           description: Flavor id, expected to be unique across cloud-region.
5909           required: true
5910           type: string
5911           example: __FLAVOR-ID__
5912         - name: hpa-capability-id
5913           in: path
5914           description: UUID to uniquely identify a HPA capability
5915           required: true
5916           type: string
5917           example: __HPA-CAPABILITY-ID__
5918         - name: resource-version
5919           in: query
5920           description: resource-version for concurrency
5921           required: true
5922           type: string
5923   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
5924     get:
5925       tags:
5926         - CloudInfrastructure
5927       summary: returns hpa-capabilities
5928       description: returns hpa-capabilities
5929       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
5930       produces:
5931         - application/json
5932         - application/xml
5933       responses:
5934         "200":
5935           description: successful operation
5936           schema:
5937               $ref: "#/getDefinitions/hpa-capabilities"
5938         "default":
5939           description: Response codes found in [response codes](https://wiki.onap.org/).
5940       parameters:
5941         - name: cloud-owner
5942           in: path
5943           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5944           required: true
5945           type: string
5946           example: __CLOUD-OWNER__
5947         - name: cloud-region-id
5948           in: path
5949           description: Identifier used by the vendor for the region. Second part of composite key
5950           required: true
5951           type: string
5952           example: __CLOUD-REGION-ID__
5953         - name: flavor-id
5954           in: path
5955           description: Flavor id, expected to be unique across cloud-region.
5956           required: true
5957           type: string
5958           example: __FLAVOR-ID__
5959         - name: cloud-type
5960           in: query
5961           description: Type of the cloud (e.g., openstack)
5962           required: false
5963           type: string
5964         - name: owner-defined-type
5965           in: query
5966           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5967           required: false
5968           type: string
5969         - name: flavor-name
5970           in: query
5971           description: Cloud Region Flavor name
5972           required: false
5973           type: string
5974   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5975     put:
5976       tags:
5977         - CloudInfrastructure
5978       summary: see node definition for valid relationships
5979       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5980       consumes:
5981         - application/json
5982         - application/xml
5983       produces:
5984         - application/json
5985         - application/xml
5986       responses:
5987         "default":
5988           description: Response codes found in [response codes](https://wiki.onap.org/).
5989       parameters:
5990         - name: cloud-owner
5991           in: path
5992           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5993           required: true
5994           type: string
5995           example: __CLOUD-OWNER__
5996         - name: cloud-region-id
5997           in: path
5998           description: Identifier used by the vendor for the region. Second part of composite key
5999           required: true
6000           type: string
6001           example: __CLOUD-REGION-ID__
6002         - name: flavor-id
6003           in: path
6004           description: Flavor id, expected to be unique across cloud-region.
6005           required: true
6006           type: string
6007           example: __FLAVOR-ID__
6008         - name: body
6009           in: body
6010           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
6011           required: true
6012           schema:
6013             $ref: "#/definitions/relationship"
6014     delete:
6015       tags:
6016         - CloudInfrastructure
6017       summary: delete an existing relationship
6018       description: delete an existing relationship
6019       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
6020       consumes:
6021         - application/json
6022         - application/xml
6023       produces:
6024         - application/json
6025         - application/xml
6026       responses:
6027         "default":
6028           description: Response codes found in [response codes](https://wiki.onap.org/).
6029       parameters:
6030         - name: cloud-owner
6031           in: path
6032           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6033           required: true
6034           type: string
6035           example: __CLOUD-OWNER__
6036         - name: cloud-region-id
6037           in: path
6038           description: Identifier used by the vendor for the region. Second part of composite key
6039           required: true
6040           type: string
6041           example: __CLOUD-REGION-ID__
6042         - name: flavor-id
6043           in: path
6044           description: Flavor id, expected to be unique across cloud-region.
6045           required: true
6046           type: string
6047           example: __FLAVOR-ID__
6048   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
6049     get:
6050       tags:
6051         - CloudInfrastructure
6052       summary: returns flavor
6053       description: returns flavor
6054       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
6055       produces:
6056         - application/json
6057         - application/xml
6058       responses:
6059         "200":
6060           description: successful operation
6061           schema:
6062               $ref: "#/getDefinitions/flavor"
6063         "default":
6064           description: Response codes found in [response codes](https://wiki.onap.org/).
6065       parameters:
6066         - name: cloud-owner
6067           in: path
6068           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6069           required: true
6070           type: string
6071           example: __CLOUD-OWNER__
6072         - name: cloud-region-id
6073           in: path
6074           description: Identifier used by the vendor for the region. Second part of composite key
6075           required: true
6076           type: string
6077           example: __CLOUD-REGION-ID__
6078         - name: flavor-id
6079           in: path
6080           description: Flavor id, expected to be unique across cloud-region.
6081           required: true
6082           type: string
6083           example: __FLAVOR-ID__
6084         - name: cloud-type
6085           in: query
6086           description: Type of the cloud (e.g., openstack)
6087           required: false
6088           type: string
6089         - name: owner-defined-type
6090           in: query
6091           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6092           required: false
6093           type: string
6094         - name: flavor-name
6095           in: query
6096           description: Cloud Region Flavor name
6097           required: false
6098           type: string
6099     put:
6100       tags:
6101         - CloudInfrastructure
6102       summary: create or update an existing flavor
6103       description: |
6104         Create or update an existing flavor.
6105         #
6106         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6107       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
6108       consumes:
6109         - application/json
6110         - application/xml
6111       produces:
6112         - application/json
6113         - application/xml
6114       responses:
6115         "default":
6116           description: Response codes found in [response codes](https://wiki.onap.org/).
6117       parameters:
6118         - name: cloud-owner
6119           in: path
6120           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6121           required: true
6122           type: string
6123           example: __CLOUD-OWNER__
6124         - name: cloud-region-id
6125           in: path
6126           description: Identifier used by the vendor for the region. Second part of composite key
6127           required: true
6128           type: string
6129           example: __CLOUD-REGION-ID__
6130         - name: flavor-id
6131           in: path
6132           description: Flavor id, expected to be unique across cloud-region.
6133           required: true
6134           type: string
6135           example: __FLAVOR-ID__
6136         - name: body
6137           in: body
6138           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
6139           required: true
6140           schema:
6141             $ref: "#/definitions/flavor"
6142     patch:
6143       tags:
6144         - CloudInfrastructure
6145       summary: update an existing flavor
6146       description: |
6147         Update an existing flavor
6148         #
6149         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6150         The PUT operation will entirely replace an existing object.
6151         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6152         #
6153         Other differences between PUT and PATCH are:
6154         #
6155         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6156         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6157         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6158       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
6159       consumes:
6160         - application/json
6161         - application/xml
6162       produces:
6163         - application/json
6164         - application/xml
6165       responses:
6166         "default":
6167           description: Response codes found in [response codes](https://wiki.onap.org/).
6168       parameters:
6169         - name: cloud-owner
6170           in: path
6171           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6172           required: true
6173           type: string
6174           example: __CLOUD-OWNER__
6175         - name: cloud-region-id
6176           in: path
6177           description: Identifier used by the vendor for the region. Second part of composite key
6178           required: true
6179           type: string
6180           example: __CLOUD-REGION-ID__
6181         - name: flavor-id
6182           in: path
6183           description: Flavor id, expected to be unique across cloud-region.
6184           required: true
6185           type: string
6186           example: __FLAVOR-ID__
6187         - name: body
6188           in: body
6189           description: flavor object that needs to be created or updated.
6190           required: true
6191           schema:
6192             $ref: "#/patchDefinitions/flavor"
6193     delete:
6194       tags:
6195         - CloudInfrastructure
6196       summary: delete an existing flavor
6197       description: delete an existing flavor
6198       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
6199       consumes:
6200         - application/json
6201         - application/xml
6202       produces:
6203         - application/json
6204         - application/xml
6205       responses:
6206         "default":
6207           description: Response codes found in [response codes](https://wiki.onap.org/).
6208       parameters:
6209         - name: cloud-owner
6210           in: path
6211           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6212           required: true
6213           type: string
6214           example: __CLOUD-OWNER__
6215         - name: cloud-region-id
6216           in: path
6217           description: Identifier used by the vendor for the region. Second part of composite key
6218           required: true
6219           type: string
6220           example: __CLOUD-REGION-ID__
6221         - name: flavor-id
6222           in: path
6223           description: Flavor id, expected to be unique across cloud-region.
6224           required: true
6225           type: string
6226           example: __FLAVOR-ID__
6227         - name: resource-version
6228           in: query
6229           description: resource-version for concurrency
6230           required: true
6231           type: string
6232   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
6233     get:
6234       tags:
6235         - CloudInfrastructure
6236       summary: returns flavors
6237       description: returns flavors
6238       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
6239       produces:
6240         - application/json
6241         - application/xml
6242       responses:
6243         "200":
6244           description: successful operation
6245           schema:
6246               $ref: "#/getDefinitions/flavors"
6247         "default":
6248           description: Response codes found in [response codes](https://wiki.onap.org/).
6249       parameters:
6250         - name: cloud-owner
6251           in: path
6252           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6253           required: true
6254           type: string
6255           example: __CLOUD-OWNER__
6256         - name: cloud-region-id
6257           in: path
6258           description: Identifier used by the vendor for the region. Second part of composite key
6259           required: true
6260           type: string
6261           example: __CLOUD-REGION-ID__
6262         - name: cloud-type
6263           in: query
6264           description: Type of the cloud (e.g., openstack)
6265           required: false
6266           type: string
6267         - name: owner-defined-type
6268           in: query
6269           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6270           required: false
6271           type: string
6272   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
6273     put:
6274       tags:
6275         - CloudInfrastructure
6276       summary: see node definition for valid relationships
6277       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
6278       consumes:
6279         - application/json
6280         - application/xml
6281       produces:
6282         - application/json
6283         - application/xml
6284       responses:
6285         "default":
6286           description: Response codes found in [response codes](https://wiki.onap.org/).
6287       parameters:
6288         - name: cloud-owner
6289           in: path
6290           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6291           required: true
6292           type: string
6293           example: __CLOUD-OWNER__
6294         - name: cloud-region-id
6295           in: path
6296           description: Identifier used by the vendor for the region. Second part of composite key
6297           required: true
6298           type: string
6299           example: __CLOUD-REGION-ID__
6300         - name: group-id
6301           in: path
6302           description: Group id, expected to be unique across cloud-region.
6303           required: true
6304           type: string
6305           example: __GROUP-ID__
6306         - name: body
6307           in: body
6308           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
6309           required: true
6310           schema:
6311             $ref: "#/definitions/relationship"
6312     delete:
6313       tags:
6314         - CloudInfrastructure
6315       summary: delete an existing relationship
6316       description: delete an existing relationship
6317       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
6318       consumes:
6319         - application/json
6320         - application/xml
6321       produces:
6322         - application/json
6323         - application/xml
6324       responses:
6325         "default":
6326           description: Response codes found in [response codes](https://wiki.onap.org/).
6327       parameters:
6328         - name: cloud-owner
6329           in: path
6330           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6331           required: true
6332           type: string
6333           example: __CLOUD-OWNER__
6334         - name: cloud-region-id
6335           in: path
6336           description: Identifier used by the vendor for the region. Second part of composite key
6337           required: true
6338           type: string
6339           example: __CLOUD-REGION-ID__
6340         - name: group-id
6341           in: path
6342           description: Group id, expected to be unique across cloud-region.
6343           required: true
6344           type: string
6345           example: __GROUP-ID__
6346   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
6347     get:
6348       tags:
6349         - CloudInfrastructure
6350       summary: returns group-assignment
6351       description: returns group-assignment
6352       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6353       produces:
6354         - application/json
6355         - application/xml
6356       responses:
6357         "200":
6358           description: successful operation
6359           schema:
6360               $ref: "#/getDefinitions/group-assignment"
6361         "default":
6362           description: Response codes found in [response codes](https://wiki.onap.org/).
6363       parameters:
6364         - name: cloud-owner
6365           in: path
6366           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6367           required: true
6368           type: string
6369           example: __CLOUD-OWNER__
6370         - name: cloud-region-id
6371           in: path
6372           description: Identifier used by the vendor for the region. Second part of composite key
6373           required: true
6374           type: string
6375           example: __CLOUD-REGION-ID__
6376         - name: group-id
6377           in: path
6378           description: Group id, expected to be unique across cloud-region.
6379           required: true
6380           type: string
6381           example: __GROUP-ID__
6382         - name: cloud-type
6383           in: query
6384           description: Type of the cloud (e.g., openstack)
6385           required: false
6386           type: string
6387         - name: owner-defined-type
6388           in: query
6389           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6390           required: false
6391           type: string
6392         - name: group-type
6393           in: query
6394           description: Group type - the type of group this instance refers to
6395           required: false
6396           type: string
6397         - name: group-name
6398           in: query
6399           description: Group name - name assigned to the group
6400           required: false
6401           type: string
6402     put:
6403       tags:
6404         - CloudInfrastructure
6405       summary: create or update an existing group-assignment
6406       description: |
6407         Create or update an existing group-assignment.
6408         #
6409         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6410       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6411       consumes:
6412         - application/json
6413         - application/xml
6414       produces:
6415         - application/json
6416         - application/xml
6417       responses:
6418         "default":
6419           description: Response codes found in [response codes](https://wiki.onap.org/).
6420       parameters:
6421         - name: cloud-owner
6422           in: path
6423           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6424           required: true
6425           type: string
6426           example: __CLOUD-OWNER__
6427         - name: cloud-region-id
6428           in: path
6429           description: Identifier used by the vendor for the region. Second part of composite key
6430           required: true
6431           type: string
6432           example: __CLOUD-REGION-ID__
6433         - name: group-id
6434           in: path
6435           description: Group id, expected to be unique across cloud-region.
6436           required: true
6437           type: string
6438           example: __GROUP-ID__
6439         - name: body
6440           in: body
6441           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
6442           required: true
6443           schema:
6444             $ref: "#/definitions/group-assignment"
6445     patch:
6446       tags:
6447         - CloudInfrastructure
6448       summary: update an existing group-assignment
6449       description: |
6450         Update an existing group-assignment
6451         #
6452         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6453         The PUT operation will entirely replace an existing object.
6454         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6455         #
6456         Other differences between PUT and PATCH are:
6457         #
6458         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6459         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6460         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6461       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6462       consumes:
6463         - application/json
6464         - application/xml
6465       produces:
6466         - application/json
6467         - application/xml
6468       responses:
6469         "default":
6470           description: Response codes found in [response codes](https://wiki.onap.org/).
6471       parameters:
6472         - name: cloud-owner
6473           in: path
6474           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6475           required: true
6476           type: string
6477           example: __CLOUD-OWNER__
6478         - name: cloud-region-id
6479           in: path
6480           description: Identifier used by the vendor for the region. Second part of composite key
6481           required: true
6482           type: string
6483           example: __CLOUD-REGION-ID__
6484         - name: group-id
6485           in: path
6486           description: Group id, expected to be unique across cloud-region.
6487           required: true
6488           type: string
6489           example: __GROUP-ID__
6490         - name: body
6491           in: body
6492           description: group-assignment object that needs to be created or updated.
6493           required: true
6494           schema:
6495             $ref: "#/patchDefinitions/group-assignment"
6496     delete:
6497       tags:
6498         - CloudInfrastructure
6499       summary: delete an existing group-assignment
6500       description: delete an existing group-assignment
6501       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6502       consumes:
6503         - application/json
6504         - application/xml
6505       produces:
6506         - application/json
6507         - application/xml
6508       responses:
6509         "default":
6510           description: Response codes found in [response codes](https://wiki.onap.org/).
6511       parameters:
6512         - name: cloud-owner
6513           in: path
6514           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6515           required: true
6516           type: string
6517           example: __CLOUD-OWNER__
6518         - name: cloud-region-id
6519           in: path
6520           description: Identifier used by the vendor for the region. Second part of composite key
6521           required: true
6522           type: string
6523           example: __CLOUD-REGION-ID__
6524         - name: group-id
6525           in: path
6526           description: Group id, expected to be unique across cloud-region.
6527           required: true
6528           type: string
6529           example: __GROUP-ID__
6530         - name: resource-version
6531           in: query
6532           description: resource-version for concurrency
6533           required: true
6534           type: string
6535   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
6536     get:
6537       tags:
6538         - CloudInfrastructure
6539       summary: returns group-assignments
6540       description: returns group-assignments
6541       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
6542       produces:
6543         - application/json
6544         - application/xml
6545       responses:
6546         "200":
6547           description: successful operation
6548           schema:
6549               $ref: "#/getDefinitions/group-assignments"
6550         "default":
6551           description: Response codes found in [response codes](https://wiki.onap.org/).
6552       parameters:
6553         - name: cloud-owner
6554           in: path
6555           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6556           required: true
6557           type: string
6558           example: __CLOUD-OWNER__
6559         - name: cloud-region-id
6560           in: path
6561           description: Identifier used by the vendor for the region. Second part of composite key
6562           required: true
6563           type: string
6564           example: __CLOUD-REGION-ID__
6565         - name: cloud-type
6566           in: query
6567           description: Type of the cloud (e.g., openstack)
6568           required: false
6569           type: string
6570         - name: owner-defined-type
6571           in: query
6572           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6573           required: false
6574           type: string
6575   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
6576     put:
6577       tags:
6578         - CloudInfrastructure
6579       summary: see node definition for valid relationships
6580       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
6581       consumes:
6582         - application/json
6583         - application/xml
6584       produces:
6585         - application/json
6586         - application/xml
6587       responses:
6588         "default":
6589           description: Response codes found in [response codes](https://wiki.onap.org/).
6590       parameters:
6591         - name: cloud-owner
6592           in: path
6593           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6594           required: true
6595           type: string
6596           example: __CLOUD-OWNER__
6597         - name: cloud-region-id
6598           in: path
6599           description: Identifier used by the vendor for the region. Second part of composite key
6600           required: true
6601           type: string
6602           example: __CLOUD-REGION-ID__
6603         - name: snapshot-id
6604           in: path
6605           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6606           required: true
6607           type: string
6608           example: __SNAPSHOT-ID__
6609         - name: body
6610           in: body
6611           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
6612           required: true
6613           schema:
6614             $ref: "#/definitions/relationship"
6615     delete:
6616       tags:
6617         - CloudInfrastructure
6618       summary: delete an existing relationship
6619       description: delete an existing relationship
6620       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
6621       consumes:
6622         - application/json
6623         - application/xml
6624       produces:
6625         - application/json
6626         - application/xml
6627       responses:
6628         "default":
6629           description: Response codes found in [response codes](https://wiki.onap.org/).
6630       parameters:
6631         - name: cloud-owner
6632           in: path
6633           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6634           required: true
6635           type: string
6636           example: __CLOUD-OWNER__
6637         - name: cloud-region-id
6638           in: path
6639           description: Identifier used by the vendor for the region. Second part of composite key
6640           required: true
6641           type: string
6642           example: __CLOUD-REGION-ID__
6643         - name: snapshot-id
6644           in: path
6645           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6646           required: true
6647           type: string
6648           example: __SNAPSHOT-ID__
6649   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
6650     get:
6651       tags:
6652         - CloudInfrastructure
6653       summary: returns snapshot
6654       description: returns snapshot
6655       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6656       produces:
6657         - application/json
6658         - application/xml
6659       responses:
6660         "200":
6661           description: successful operation
6662           schema:
6663               $ref: "#/getDefinitions/snapshot"
6664         "default":
6665           description: Response codes found in [response codes](https://wiki.onap.org/).
6666       parameters:
6667         - name: cloud-owner
6668           in: path
6669           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6670           required: true
6671           type: string
6672           example: __CLOUD-OWNER__
6673         - name: cloud-region-id
6674           in: path
6675           description: Identifier used by the vendor for the region. Second part of composite key
6676           required: true
6677           type: string
6678           example: __CLOUD-REGION-ID__
6679         - name: snapshot-id
6680           in: path
6681           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6682           required: true
6683           type: string
6684           example: __SNAPSHOT-ID__
6685         - name: cloud-type
6686           in: query
6687           description: Type of the cloud (e.g., openstack)
6688           required: false
6689           type: string
6690         - name: owner-defined-type
6691           in: query
6692           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6693           required: false
6694           type: string
6695         - name: snapshot-name
6696           in: query
6697           description: Snapshot name
6698           required: false
6699           type: string
6700         - name: application
6701           in: query
6702           description: The application that the image instantiates.
6703           required: false
6704           type: string
6705         - name: application-vendor
6706           in: query
6707           description: The vendor of the application.
6708           required: false
6709           type: string
6710         - name: application-version
6711           in: query
6712           description: The version of the application.
6713           required: false
6714           type: string
6715         - name: prev-snapshot-id
6716           in: query
6717           description: This field contains the UUID of the previous snapshot (if any).
6718           required: false
6719           type: string
6720     put:
6721       tags:
6722         - CloudInfrastructure
6723       summary: create or update an existing snapshot
6724       description: |
6725         Create or update an existing snapshot.
6726         #
6727         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6728       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6729       consumes:
6730         - application/json
6731         - application/xml
6732       produces:
6733         - application/json
6734         - application/xml
6735       responses:
6736         "default":
6737           description: Response codes found in [response codes](https://wiki.onap.org/).
6738       parameters:
6739         - name: cloud-owner
6740           in: path
6741           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6742           required: true
6743           type: string
6744           example: __CLOUD-OWNER__
6745         - name: cloud-region-id
6746           in: path
6747           description: Identifier used by the vendor for the region. Second part of composite key
6748           required: true
6749           type: string
6750           example: __CLOUD-REGION-ID__
6751         - name: snapshot-id
6752           in: path
6753           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6754           required: true
6755           type: string
6756           example: __SNAPSHOT-ID__
6757         - name: body
6758           in: body
6759           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
6760           required: true
6761           schema:
6762             $ref: "#/definitions/snapshot"
6763     patch:
6764       tags:
6765         - CloudInfrastructure
6766       summary: update an existing snapshot
6767       description: |
6768         Update an existing snapshot
6769         #
6770         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6771         The PUT operation will entirely replace an existing object.
6772         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6773         #
6774         Other differences between PUT and PATCH are:
6775         #
6776         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6777         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6778         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6779       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6780       consumes:
6781         - application/json
6782         - application/xml
6783       produces:
6784         - application/json
6785         - application/xml
6786       responses:
6787         "default":
6788           description: Response codes found in [response codes](https://wiki.onap.org/).
6789       parameters:
6790         - name: cloud-owner
6791           in: path
6792           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6793           required: true
6794           type: string
6795           example: __CLOUD-OWNER__
6796         - name: cloud-region-id
6797           in: path
6798           description: Identifier used by the vendor for the region. Second part of composite key
6799           required: true
6800           type: string
6801           example: __CLOUD-REGION-ID__
6802         - name: snapshot-id
6803           in: path
6804           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6805           required: true
6806           type: string
6807           example: __SNAPSHOT-ID__
6808         - name: body
6809           in: body
6810           description: snapshot object that needs to be created or updated.
6811           required: true
6812           schema:
6813             $ref: "#/patchDefinitions/snapshot"
6814     delete:
6815       tags:
6816         - CloudInfrastructure
6817       summary: delete an existing snapshot
6818       description: delete an existing snapshot
6819       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6820       consumes:
6821         - application/json
6822         - application/xml
6823       produces:
6824         - application/json
6825         - application/xml
6826       responses:
6827         "default":
6828           description: Response codes found in [response codes](https://wiki.onap.org/).
6829       parameters:
6830         - name: cloud-owner
6831           in: path
6832           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6833           required: true
6834           type: string
6835           example: __CLOUD-OWNER__
6836         - name: cloud-region-id
6837           in: path
6838           description: Identifier used by the vendor for the region. Second part of composite key
6839           required: true
6840           type: string
6841           example: __CLOUD-REGION-ID__
6842         - name: snapshot-id
6843           in: path
6844           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6845           required: true
6846           type: string
6847           example: __SNAPSHOT-ID__
6848         - name: resource-version
6849           in: query
6850           description: resource-version for concurrency
6851           required: true
6852           type: string
6853   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
6854     get:
6855       tags:
6856         - CloudInfrastructure
6857       summary: returns snapshots
6858       description: returns snapshots
6859       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
6860       produces:
6861         - application/json
6862         - application/xml
6863       responses:
6864         "200":
6865           description: successful operation
6866           schema:
6867               $ref: "#/getDefinitions/snapshots"
6868         "default":
6869           description: Response codes found in [response codes](https://wiki.onap.org/).
6870       parameters:
6871         - name: cloud-owner
6872           in: path
6873           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6874           required: true
6875           type: string
6876           example: __CLOUD-OWNER__
6877         - name: cloud-region-id
6878           in: path
6879           description: Identifier used by the vendor for the region. Second part of composite key
6880           required: true
6881           type: string
6882           example: __CLOUD-REGION-ID__
6883         - name: cloud-type
6884           in: query
6885           description: Type of the cloud (e.g., openstack)
6886           required: false
6887           type: string
6888         - name: owner-defined-type
6889           in: query
6890           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6891           required: false
6892           type: string
6893   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6894     put:
6895       tags:
6896         - CloudInfrastructure
6897       summary: see node definition for valid relationships
6898       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6899       consumes:
6900         - application/json
6901         - application/xml
6902       produces:
6903         - application/json
6904         - application/xml
6905       responses:
6906         "default":
6907           description: Response codes found in [response codes](https://wiki.onap.org/).
6908       parameters:
6909         - name: cloud-owner
6910           in: path
6911           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6912           required: true
6913           type: string
6914           example: __CLOUD-OWNER__
6915         - name: cloud-region-id
6916           in: path
6917           description: Identifier used by the vendor for the region. Second part of composite key
6918           required: true
6919           type: string
6920           example: __CLOUD-REGION-ID__
6921         - name: image-id
6922           in: path
6923           description: Image id, expected to be unique across cloud region
6924           required: true
6925           type: string
6926           example: __IMAGE-ID__
6927         - name: body
6928           in: body
6929           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6930           required: true
6931           schema:
6932             $ref: "#/definitions/relationship"
6933     delete:
6934       tags:
6935         - CloudInfrastructure
6936       summary: delete an existing relationship
6937       description: delete an existing relationship
6938       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6939       consumes:
6940         - application/json
6941         - application/xml
6942       produces:
6943         - application/json
6944         - application/xml
6945       responses:
6946         "default":
6947           description: Response codes found in [response codes](https://wiki.onap.org/).
6948       parameters:
6949         - name: cloud-owner
6950           in: path
6951           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6952           required: true
6953           type: string
6954           example: __CLOUD-OWNER__
6955         - name: cloud-region-id
6956           in: path
6957           description: Identifier used by the vendor for the region. Second part of composite key
6958           required: true
6959           type: string
6960           example: __CLOUD-REGION-ID__
6961         - name: image-id
6962           in: path
6963           description: Image id, expected to be unique across cloud region
6964           required: true
6965           type: string
6966           example: __IMAGE-ID__
6967   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6968     get:
6969       tags:
6970         - CloudInfrastructure
6971       summary: returns metadatum
6972       description: returns metadatum
6973       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6974       produces:
6975         - application/json
6976         - application/xml
6977       responses:
6978         "200":
6979           description: successful operation
6980           schema:
6981               $ref: "#/getDefinitions/metadatum"
6982         "default":
6983           description: Response codes found in [response codes](https://wiki.onap.org/).
6984       parameters:
6985         - name: cloud-owner
6986           in: path
6987           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6988           required: true
6989           type: string
6990           example: __CLOUD-OWNER__
6991         - name: cloud-region-id
6992           in: path
6993           description: Identifier used by the vendor for the region. Second part of composite key
6994           required: true
6995           type: string
6996           example: __CLOUD-REGION-ID__
6997         - name: image-id
6998           in: path
6999           description: Image id, expected to be unique across cloud region
7000           required: true
7001           type: string
7002           example: __IMAGE-ID__
7003         - name: metaname
7004           in: path
7005           required: true
7006           type: string
7007           example: __METANAME__
7008         - name: cloud-type
7009           in: query
7010           description: Type of the cloud (e.g., openstack)
7011           required: false
7012           type: string
7013         - name: owner-defined-type
7014           in: query
7015           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7016           required: false
7017           type: string
7018         - name: image-name
7019           in: query
7020           description: Image name
7021           required: false
7022           type: string
7023         - name: application
7024           in: query
7025           description: The application that the image instantiates.
7026           required: false
7027           type: string
7028         - name: application-vendor
7029           in: query
7030           description: The vendor of the application.
7031           required: false
7032           type: string
7033         - name: application-version
7034           in: query
7035           description: The version of the application.
7036           required: false
7037           type: string
7038     put:
7039       tags:
7040         - CloudInfrastructure
7041       summary: create or update an existing metadatum
7042       description: |
7043         Create or update an existing metadatum.
7044         #
7045         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7046       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
7047       consumes:
7048         - application/json
7049         - application/xml
7050       produces:
7051         - application/json
7052         - application/xml
7053       responses:
7054         "default":
7055           description: Response codes found in [response codes](https://wiki.onap.org/).
7056       parameters:
7057         - name: cloud-owner
7058           in: path
7059           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7060           required: true
7061           type: string
7062           example: __CLOUD-OWNER__
7063         - name: cloud-region-id
7064           in: path
7065           description: Identifier used by the vendor for the region. Second part of composite key
7066           required: true
7067           type: string
7068           example: __CLOUD-REGION-ID__
7069         - name: image-id
7070           in: path
7071           description: Image id, expected to be unique across cloud region
7072           required: true
7073           type: string
7074           example: __IMAGE-ID__
7075         - name: metaname
7076           in: path
7077           required: true
7078           type: string
7079           example: __METANAME__
7080         - name: body
7081           in: body
7082           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
7083           required: true
7084           schema:
7085             $ref: "#/definitions/metadatum"
7086     patch:
7087       tags:
7088         - CloudInfrastructure
7089       summary: update an existing metadatum
7090       description: |
7091         Update an existing metadatum
7092         #
7093         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7094         The PUT operation will entirely replace an existing object.
7095         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7096         #
7097         Other differences between PUT and PATCH are:
7098         #
7099         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7100         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7101         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7102       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
7103       consumes:
7104         - application/json
7105         - application/xml
7106       produces:
7107         - application/json
7108         - application/xml
7109       responses:
7110         "default":
7111           description: Response codes found in [response codes](https://wiki.onap.org/).
7112       parameters:
7113         - name: cloud-owner
7114           in: path
7115           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7116           required: true
7117           type: string
7118           example: __CLOUD-OWNER__
7119         - name: cloud-region-id
7120           in: path
7121           description: Identifier used by the vendor for the region. Second part of composite key
7122           required: true
7123           type: string
7124           example: __CLOUD-REGION-ID__
7125         - name: image-id
7126           in: path
7127           description: Image id, expected to be unique across cloud region
7128           required: true
7129           type: string
7130           example: __IMAGE-ID__
7131         - name: metaname
7132           in: path
7133           required: true
7134           type: string
7135           example: __METANAME__
7136         - name: body
7137           in: body
7138           description: metadatum object that needs to be created or updated.
7139           required: true
7140           schema:
7141             $ref: "#/patchDefinitions/metadatum"
7142     delete:
7143       tags:
7144         - CloudInfrastructure
7145       summary: delete an existing metadatum
7146       description: delete an existing metadatum
7147       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
7148       consumes:
7149         - application/json
7150         - application/xml
7151       produces:
7152         - application/json
7153         - application/xml
7154       responses:
7155         "default":
7156           description: Response codes found in [response codes](https://wiki.onap.org/).
7157       parameters:
7158         - name: cloud-owner
7159           in: path
7160           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7161           required: true
7162           type: string
7163           example: __CLOUD-OWNER__
7164         - name: cloud-region-id
7165           in: path
7166           description: Identifier used by the vendor for the region. Second part of composite key
7167           required: true
7168           type: string
7169           example: __CLOUD-REGION-ID__
7170         - name: image-id
7171           in: path
7172           description: Image id, expected to be unique across cloud region
7173           required: true
7174           type: string
7175           example: __IMAGE-ID__
7176         - name: metaname
7177           in: path
7178           required: true
7179           type: string
7180           example: __METANAME__
7181         - name: resource-version
7182           in: query
7183           description: resource-version for concurrency
7184           required: true
7185           type: string
7186   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
7187     get:
7188       tags:
7189         - CloudInfrastructure
7190       summary: returns metadata
7191       description: returns metadata
7192       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
7193       produces:
7194         - application/json
7195         - application/xml
7196       responses:
7197         "200":
7198           description: successful operation
7199           schema:
7200               $ref: "#/getDefinitions/metadata"
7201         "default":
7202           description: Response codes found in [response codes](https://wiki.onap.org/).
7203       parameters:
7204         - name: cloud-owner
7205           in: path
7206           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7207           required: true
7208           type: string
7209           example: __CLOUD-OWNER__
7210         - name: cloud-region-id
7211           in: path
7212           description: Identifier used by the vendor for the region. Second part of composite key
7213           required: true
7214           type: string
7215           example: __CLOUD-REGION-ID__
7216         - name: image-id
7217           in: path
7218           description: Image id, expected to be unique across cloud region
7219           required: true
7220           type: string
7221           example: __IMAGE-ID__
7222         - name: cloud-type
7223           in: query
7224           description: Type of the cloud (e.g., openstack)
7225           required: false
7226           type: string
7227         - name: owner-defined-type
7228           in: query
7229           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7230           required: false
7231           type: string
7232         - name: image-name
7233           in: query
7234           description: Image name
7235           required: false
7236           type: string
7237         - name: application
7238           in: query
7239           description: The application that the image instantiates.
7240           required: false
7241           type: string
7242         - name: application-vendor
7243           in: query
7244           description: The vendor of the application.
7245           required: false
7246           type: string
7247         - name: application-version
7248           in: query
7249           description: The version of the application.
7250           required: false
7251           type: string
7252   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
7253     get:
7254       tags:
7255         - CloudInfrastructure
7256       summary: returns image
7257       description: returns image
7258       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
7259       produces:
7260         - application/json
7261         - application/xml
7262       responses:
7263         "200":
7264           description: successful operation
7265           schema:
7266               $ref: "#/getDefinitions/image"
7267         "default":
7268           description: Response codes found in [response codes](https://wiki.onap.org/).
7269       parameters:
7270         - name: cloud-owner
7271           in: path
7272           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7273           required: true
7274           type: string
7275           example: __CLOUD-OWNER__
7276         - name: cloud-region-id
7277           in: path
7278           description: Identifier used by the vendor for the region. Second part of composite key
7279           required: true
7280           type: string
7281           example: __CLOUD-REGION-ID__
7282         - name: image-id
7283           in: path
7284           description: Image id, expected to be unique across cloud region
7285           required: true
7286           type: string
7287           example: __IMAGE-ID__
7288         - name: cloud-type
7289           in: query
7290           description: Type of the cloud (e.g., openstack)
7291           required: false
7292           type: string
7293         - name: owner-defined-type
7294           in: query
7295           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7296           required: false
7297           type: string
7298         - name: image-name
7299           in: query
7300           description: Image name
7301           required: false
7302           type: string
7303         - name: application
7304           in: query
7305           description: The application that the image instantiates.
7306           required: false
7307           type: string
7308         - name: application-vendor
7309           in: query
7310           description: The vendor of the application.
7311           required: false
7312           type: string
7313         - name: application-version
7314           in: query
7315           description: The version of the application.
7316           required: false
7317           type: string
7318     put:
7319       tags:
7320         - CloudInfrastructure
7321       summary: create or update an existing image
7322       description: |
7323         Create or update an existing image.
7324         #
7325         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7326       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
7327       consumes:
7328         - application/json
7329         - application/xml
7330       produces:
7331         - application/json
7332         - application/xml
7333       responses:
7334         "default":
7335           description: Response codes found in [response codes](https://wiki.onap.org/).
7336       parameters:
7337         - name: cloud-owner
7338           in: path
7339           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7340           required: true
7341           type: string
7342           example: __CLOUD-OWNER__
7343         - name: cloud-region-id
7344           in: path
7345           description: Identifier used by the vendor for the region. Second part of composite key
7346           required: true
7347           type: string
7348           example: __CLOUD-REGION-ID__
7349         - name: image-id
7350           in: path
7351           description: Image id, expected to be unique across cloud region
7352           required: true
7353           type: string
7354           example: __IMAGE-ID__
7355         - name: body
7356           in: body
7357           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
7358           required: true
7359           schema:
7360             $ref: "#/definitions/image"
7361     patch:
7362       tags:
7363         - CloudInfrastructure
7364       summary: update an existing image
7365       description: |
7366         Update an existing image
7367         #
7368         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7369         The PUT operation will entirely replace an existing object.
7370         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7371         #
7372         Other differences between PUT and PATCH are:
7373         #
7374         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7375         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7376         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7377       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
7378       consumes:
7379         - application/json
7380         - application/xml
7381       produces:
7382         - application/json
7383         - application/xml
7384       responses:
7385         "default":
7386           description: Response codes found in [response codes](https://wiki.onap.org/).
7387       parameters:
7388         - name: cloud-owner
7389           in: path
7390           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7391           required: true
7392           type: string
7393           example: __CLOUD-OWNER__
7394         - name: cloud-region-id
7395           in: path
7396           description: Identifier used by the vendor for the region. Second part of composite key
7397           required: true
7398           type: string
7399           example: __CLOUD-REGION-ID__
7400         - name: image-id
7401           in: path
7402           description: Image id, expected to be unique across cloud region
7403           required: true
7404           type: string
7405           example: __IMAGE-ID__
7406         - name: body
7407           in: body
7408           description: image object that needs to be created or updated.
7409           required: true
7410           schema:
7411             $ref: "#/patchDefinitions/image"
7412     delete:
7413       tags:
7414         - CloudInfrastructure
7415       summary: delete an existing image
7416       description: delete an existing image
7417       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
7418       consumes:
7419         - application/json
7420         - application/xml
7421       produces:
7422         - application/json
7423         - application/xml
7424       responses:
7425         "default":
7426           description: Response codes found in [response codes](https://wiki.onap.org/).
7427       parameters:
7428         - name: cloud-owner
7429           in: path
7430           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7431           required: true
7432           type: string
7433           example: __CLOUD-OWNER__
7434         - name: cloud-region-id
7435           in: path
7436           description: Identifier used by the vendor for the region. Second part of composite key
7437           required: true
7438           type: string
7439           example: __CLOUD-REGION-ID__
7440         - name: image-id
7441           in: path
7442           description: Image id, expected to be unique across cloud region
7443           required: true
7444           type: string
7445           example: __IMAGE-ID__
7446         - name: resource-version
7447           in: query
7448           description: resource-version for concurrency
7449           required: true
7450           type: string
7451   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
7452     get:
7453       tags:
7454         - CloudInfrastructure
7455       summary: returns images
7456       description: returns images
7457       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
7458       produces:
7459         - application/json
7460         - application/xml
7461       responses:
7462         "200":
7463           description: successful operation
7464           schema:
7465               $ref: "#/getDefinitions/images"
7466         "default":
7467           description: Response codes found in [response codes](https://wiki.onap.org/).
7468       parameters:
7469         - name: cloud-owner
7470           in: path
7471           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7472           required: true
7473           type: string
7474           example: __CLOUD-OWNER__
7475         - name: cloud-region-id
7476           in: path
7477           description: Identifier used by the vendor for the region. Second part of composite key
7478           required: true
7479           type: string
7480           example: __CLOUD-REGION-ID__
7481         - name: cloud-type
7482           in: query
7483           description: Type of the cloud (e.g., openstack)
7484           required: false
7485           type: string
7486         - name: owner-defined-type
7487           in: query
7488           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7489           required: false
7490           type: string
7491   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
7492     put:
7493       tags:
7494         - CloudInfrastructure
7495       summary: see node definition for valid relationships
7496       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
7497       consumes:
7498         - application/json
7499         - application/xml
7500       produces:
7501         - application/json
7502         - application/xml
7503       responses:
7504         "default":
7505           description: Response codes found in [response codes](https://wiki.onap.org/).
7506       parameters:
7507         - name: cloud-owner
7508           in: path
7509           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7510           required: true
7511           type: string
7512           example: __CLOUD-OWNER__
7513         - name: cloud-region-id
7514           in: path
7515           description: Identifier used by the vendor for the region. Second part of composite key
7516           required: true
7517           type: string
7518           example: __CLOUD-REGION-ID__
7519         - name: switch-name
7520           in: path
7521           description: DVS switch name
7522           required: true
7523           type: string
7524           example: __SWITCH-NAME__
7525         - name: body
7526           in: body
7527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
7528           required: true
7529           schema:
7530             $ref: "#/definitions/relationship"
7531     delete:
7532       tags:
7533         - CloudInfrastructure
7534       summary: delete an existing relationship
7535       description: delete an existing relationship
7536       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
7537       consumes:
7538         - application/json
7539         - application/xml
7540       produces:
7541         - application/json
7542         - application/xml
7543       responses:
7544         "default":
7545           description: Response codes found in [response codes](https://wiki.onap.org/).
7546       parameters:
7547         - name: cloud-owner
7548           in: path
7549           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7550           required: true
7551           type: string
7552           example: __CLOUD-OWNER__
7553         - name: cloud-region-id
7554           in: path
7555           description: Identifier used by the vendor for the region. Second part of composite key
7556           required: true
7557           type: string
7558           example: __CLOUD-REGION-ID__
7559         - name: switch-name
7560           in: path
7561           description: DVS switch name
7562           required: true
7563           type: string
7564           example: __SWITCH-NAME__
7565   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
7566     get:
7567       tags:
7568         - CloudInfrastructure
7569       summary: returns dvs-switch
7570       description: returns dvs-switch
7571       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7572       produces:
7573         - application/json
7574         - application/xml
7575       responses:
7576         "200":
7577           description: successful operation
7578           schema:
7579               $ref: "#/getDefinitions/dvs-switch"
7580         "default":
7581           description: Response codes found in [response codes](https://wiki.onap.org/).
7582       parameters:
7583         - name: cloud-owner
7584           in: path
7585           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7586           required: true
7587           type: string
7588           example: __CLOUD-OWNER__
7589         - name: cloud-region-id
7590           in: path
7591           description: Identifier used by the vendor for the region. Second part of composite key
7592           required: true
7593           type: string
7594           example: __CLOUD-REGION-ID__
7595         - name: switch-name
7596           in: path
7597           description: DVS switch name
7598           required: true
7599           type: string
7600           example: __SWITCH-NAME__
7601         - name: cloud-type
7602           in: query
7603           description: Type of the cloud (e.g., openstack)
7604           required: false
7605           type: string
7606         - name: owner-defined-type
7607           in: query
7608           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7609           required: false
7610           type: string
7611         - name: vcenter-url
7612           in: query
7613           description: URL used to reach the vcenter
7614           required: false
7615           type: string
7616     put:
7617       tags:
7618         - CloudInfrastructure
7619       summary: create or update an existing dvs-switch
7620       description: |
7621         Create or update an existing dvs-switch.
7622         #
7623         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7624       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7625       consumes:
7626         - application/json
7627         - application/xml
7628       produces:
7629         - application/json
7630         - application/xml
7631       responses:
7632         "default":
7633           description: Response codes found in [response codes](https://wiki.onap.org/).
7634       parameters:
7635         - name: cloud-owner
7636           in: path
7637           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7638           required: true
7639           type: string
7640           example: __CLOUD-OWNER__
7641         - name: cloud-region-id
7642           in: path
7643           description: Identifier used by the vendor for the region. Second part of composite key
7644           required: true
7645           type: string
7646           example: __CLOUD-REGION-ID__
7647         - name: switch-name
7648           in: path
7649           description: DVS switch name
7650           required: true
7651           type: string
7652           example: __SWITCH-NAME__
7653         - name: body
7654           in: body
7655           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
7656           required: true
7657           schema:
7658             $ref: "#/definitions/dvs-switch"
7659     patch:
7660       tags:
7661         - CloudInfrastructure
7662       summary: update an existing dvs-switch
7663       description: |
7664         Update an existing dvs-switch
7665         #
7666         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7667         The PUT operation will entirely replace an existing object.
7668         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7669         #
7670         Other differences between PUT and PATCH are:
7671         #
7672         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7673         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7674         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7675       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7676       consumes:
7677         - application/json
7678         - application/xml
7679       produces:
7680         - application/json
7681         - application/xml
7682       responses:
7683         "default":
7684           description: Response codes found in [response codes](https://wiki.onap.org/).
7685       parameters:
7686         - name: cloud-owner
7687           in: path
7688           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7689           required: true
7690           type: string
7691           example: __CLOUD-OWNER__
7692         - name: cloud-region-id
7693           in: path
7694           description: Identifier used by the vendor for the region. Second part of composite key
7695           required: true
7696           type: string
7697           example: __CLOUD-REGION-ID__
7698         - name: switch-name
7699           in: path
7700           description: DVS switch name
7701           required: true
7702           type: string
7703           example: __SWITCH-NAME__
7704         - name: body
7705           in: body
7706           description: dvs-switch object that needs to be created or updated.
7707           required: true
7708           schema:
7709             $ref: "#/patchDefinitions/dvs-switch"
7710     delete:
7711       tags:
7712         - CloudInfrastructure
7713       summary: delete an existing dvs-switch
7714       description: delete an existing dvs-switch
7715       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7716       consumes:
7717         - application/json
7718         - application/xml
7719       produces:
7720         - application/json
7721         - application/xml
7722       responses:
7723         "default":
7724           description: Response codes found in [response codes](https://wiki.onap.org/).
7725       parameters:
7726         - name: cloud-owner
7727           in: path
7728           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7729           required: true
7730           type: string
7731           example: __CLOUD-OWNER__
7732         - name: cloud-region-id
7733           in: path
7734           description: Identifier used by the vendor for the region. Second part of composite key
7735           required: true
7736           type: string
7737           example: __CLOUD-REGION-ID__
7738         - name: switch-name
7739           in: path
7740           description: DVS switch name
7741           required: true
7742           type: string
7743           example: __SWITCH-NAME__
7744         - name: resource-version
7745           in: query
7746           description: resource-version for concurrency
7747           required: true
7748           type: string
7749   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
7750     get:
7751       tags:
7752         - CloudInfrastructure
7753       summary: returns dvs-switches
7754       description: returns dvs-switches
7755       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
7756       produces:
7757         - application/json
7758         - application/xml
7759       responses:
7760         "200":
7761           description: successful operation
7762           schema:
7763               $ref: "#/getDefinitions/dvs-switches"
7764         "default":
7765           description: Response codes found in [response codes](https://wiki.onap.org/).
7766       parameters:
7767         - name: cloud-owner
7768           in: path
7769           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7770           required: true
7771           type: string
7772           example: __CLOUD-OWNER__
7773         - name: cloud-region-id
7774           in: path
7775           description: Identifier used by the vendor for the region. Second part of composite key
7776           required: true
7777           type: string
7778           example: __CLOUD-REGION-ID__
7779         - name: cloud-type
7780           in: query
7781           description: Type of the cloud (e.g., openstack)
7782           required: false
7783           type: string
7784         - name: owner-defined-type
7785           in: query
7786           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7787           required: false
7788           type: string
7789   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
7790     put:
7791       tags:
7792         - CloudInfrastructure
7793       summary: see node definition for valid relationships
7794       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7795       consumes:
7796         - application/json
7797         - application/xml
7798       produces:
7799         - application/json
7800         - application/xml
7801       responses:
7802         "default":
7803           description: Response codes found in [response codes](https://wiki.onap.org/).
7804       parameters:
7805         - name: cloud-owner
7806           in: path
7807           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7808           required: true
7809           type: string
7810           example: __CLOUD-OWNER__
7811         - name: cloud-region-id
7812           in: path
7813           description: Identifier used by the vendor for the region. Second part of composite key
7814           required: true
7815           type: string
7816           example: __CLOUD-REGION-ID__
7817         - name: network-uuid
7818           in: path
7819           description: UUID of the network. Unique across a cloud-region
7820           required: true
7821           type: string
7822           example: __NETWORK-UUID__
7823         - name: body
7824           in: body
7825           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7826           required: true
7827           schema:
7828             $ref: "#/definitions/relationship"
7829     delete:
7830       tags:
7831         - CloudInfrastructure
7832       summary: delete an existing relationship
7833       description: delete an existing relationship
7834       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7835       consumes:
7836         - application/json
7837         - application/xml
7838       produces:
7839         - application/json
7840         - application/xml
7841       responses:
7842         "default":
7843           description: Response codes found in [response codes](https://wiki.onap.org/).
7844       parameters:
7845         - name: cloud-owner
7846           in: path
7847           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7848           required: true
7849           type: string
7850           example: __CLOUD-OWNER__
7851         - name: cloud-region-id
7852           in: path
7853           description: Identifier used by the vendor for the region. Second part of composite key
7854           required: true
7855           type: string
7856           example: __CLOUD-REGION-ID__
7857         - name: network-uuid
7858           in: path
7859           description: UUID of the network. Unique across a cloud-region
7860           required: true
7861           type: string
7862           example: __NETWORK-UUID__
7863   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
7864     get:
7865       tags:
7866         - CloudInfrastructure
7867       summary: returns oam-network
7868       description: returns oam-network
7869       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7870       produces:
7871         - application/json
7872         - application/xml
7873       responses:
7874         "200":
7875           description: successful operation
7876           schema:
7877               $ref: "#/getDefinitions/oam-network"
7878         "default":
7879           description: Response codes found in [response codes](https://wiki.onap.org/).
7880       parameters:
7881         - name: cloud-owner
7882           in: path
7883           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7884           required: true
7885           type: string
7886           example: __CLOUD-OWNER__
7887         - name: cloud-region-id
7888           in: path
7889           description: Identifier used by the vendor for the region. Second part of composite key
7890           required: true
7891           type: string
7892           example: __CLOUD-REGION-ID__
7893         - name: network-uuid
7894           in: path
7895           description: UUID of the network. Unique across a cloud-region
7896           required: true
7897           type: string
7898           example: __NETWORK-UUID__
7899         - name: cloud-type
7900           in: query
7901           description: Type of the cloud (e.g., openstack)
7902           required: false
7903           type: string
7904         - name: owner-defined-type
7905           in: query
7906           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7907           required: false
7908           type: string
7909         - name: network-name
7910           in: query
7911           description: Name of the network.
7912           required: false
7913           type: string
7914         - name: cvlan-tag
7915           in: query
7916           description: cvlan-id
7917           required: false
7918           type: integer
7919           format: int64
7920     put:
7921       tags:
7922         - CloudInfrastructure
7923       summary: create or update an existing oam-network
7924       description: |
7925         Create or update an existing oam-network.
7926         #
7927         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7928       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7929       consumes:
7930         - application/json
7931         - application/xml
7932       produces:
7933         - application/json
7934         - application/xml
7935       responses:
7936         "default":
7937           description: Response codes found in [response codes](https://wiki.onap.org/).
7938       parameters:
7939         - name: cloud-owner
7940           in: path
7941           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7942           required: true
7943           type: string
7944           example: __CLOUD-OWNER__
7945         - name: cloud-region-id
7946           in: path
7947           description: Identifier used by the vendor for the region. Second part of composite key
7948           required: true
7949           type: string
7950           example: __CLOUD-REGION-ID__
7951         - name: network-uuid
7952           in: path
7953           description: UUID of the network. Unique across a cloud-region
7954           required: true
7955           type: string
7956           example: __NETWORK-UUID__
7957         - name: body
7958           in: body
7959           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7960           required: true
7961           schema:
7962             $ref: "#/definitions/oam-network"
7963     patch:
7964       tags:
7965         - CloudInfrastructure
7966       summary: update an existing oam-network
7967       description: |
7968         Update an existing oam-network
7969         #
7970         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7971         The PUT operation will entirely replace an existing object.
7972         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7973         #
7974         Other differences between PUT and PATCH are:
7975         #
7976         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7977         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7978         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7979       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7980       consumes:
7981         - application/json
7982         - application/xml
7983       produces:
7984         - application/json
7985         - application/xml
7986       responses:
7987         "default":
7988           description: Response codes found in [response codes](https://wiki.onap.org/).
7989       parameters:
7990         - name: cloud-owner
7991           in: path
7992           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7993           required: true
7994           type: string
7995           example: __CLOUD-OWNER__
7996         - name: cloud-region-id
7997           in: path
7998           description: Identifier used by the vendor for the region. Second part of composite key
7999           required: true
8000           type: string
8001           example: __CLOUD-REGION-ID__
8002         - name: network-uuid
8003           in: path
8004           description: UUID of the network. Unique across a cloud-region
8005           required: true
8006           type: string
8007           example: __NETWORK-UUID__
8008         - name: body
8009           in: body
8010           description: oam-network object that needs to be created or updated.
8011           required: true
8012           schema:
8013             $ref: "#/patchDefinitions/oam-network"
8014     delete:
8015       tags:
8016         - CloudInfrastructure
8017       summary: delete an existing oam-network
8018       description: delete an existing oam-network
8019       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
8020       consumes:
8021         - application/json
8022         - application/xml
8023       produces:
8024         - application/json
8025         - application/xml
8026       responses:
8027         "default":
8028           description: Response codes found in [response codes](https://wiki.onap.org/).
8029       parameters:
8030         - name: cloud-owner
8031           in: path
8032           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8033           required: true
8034           type: string
8035           example: __CLOUD-OWNER__
8036         - name: cloud-region-id
8037           in: path
8038           description: Identifier used by the vendor for the region. Second part of composite key
8039           required: true
8040           type: string
8041           example: __CLOUD-REGION-ID__
8042         - name: network-uuid
8043           in: path
8044           description: UUID of the network. Unique across a cloud-region
8045           required: true
8046           type: string
8047           example: __NETWORK-UUID__
8048         - name: resource-version
8049           in: query
8050           description: resource-version for concurrency
8051           required: true
8052           type: string
8053   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
8054     get:
8055       tags:
8056         - CloudInfrastructure
8057       summary: returns oam-networks
8058       description: returns oam-networks
8059       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
8060       produces:
8061         - application/json
8062         - application/xml
8063       responses:
8064         "200":
8065           description: successful operation
8066           schema:
8067               $ref: "#/getDefinitions/oam-networks"
8068         "default":
8069           description: Response codes found in [response codes](https://wiki.onap.org/).
8070       parameters:
8071         - name: cloud-owner
8072           in: path
8073           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8074           required: true
8075           type: string
8076           example: __CLOUD-OWNER__
8077         - name: cloud-region-id
8078           in: path
8079           description: Identifier used by the vendor for the region. Second part of composite key
8080           required: true
8081           type: string
8082           example: __CLOUD-REGION-ID__
8083         - name: cloud-type
8084           in: query
8085           description: Type of the cloud (e.g., openstack)
8086           required: false
8087           type: string
8088         - name: owner-defined-type
8089           in: query
8090           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8091           required: false
8092           type: string
8093   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
8094     put:
8095       tags:
8096         - CloudInfrastructure
8097       summary: see node definition for valid relationships
8098       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
8099       consumes:
8100         - application/json
8101         - application/xml
8102       produces:
8103         - application/json
8104         - application/xml
8105       responses:
8106         "default":
8107           description: Response codes found in [response codes](https://wiki.onap.org/).
8108       parameters:
8109         - name: cloud-owner
8110           in: path
8111           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8112           required: true
8113           type: string
8114           example: __CLOUD-OWNER__
8115         - name: cloud-region-id
8116           in: path
8117           description: Identifier used by the vendor for the region. Second part of composite key
8118           required: true
8119           type: string
8120           example: __CLOUD-REGION-ID__
8121         - name: availability-zone-name
8122           in: path
8123           description: Name of the availability zone.  Unique across a cloud region
8124           required: true
8125           type: string
8126           example: __AVAILABILITY-ZONE-NAME__
8127         - name: body
8128           in: body
8129           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
8130           required: true
8131           schema:
8132             $ref: "#/definitions/relationship"
8133     delete:
8134       tags:
8135         - CloudInfrastructure
8136       summary: delete an existing relationship
8137       description: delete an existing relationship
8138       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
8139       consumes:
8140         - application/json
8141         - application/xml
8142       produces:
8143         - application/json
8144         - application/xml
8145       responses:
8146         "default":
8147           description: Response codes found in [response codes](https://wiki.onap.org/).
8148       parameters:
8149         - name: cloud-owner
8150           in: path
8151           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8152           required: true
8153           type: string
8154           example: __CLOUD-OWNER__
8155         - name: cloud-region-id
8156           in: path
8157           description: Identifier used by the vendor for the region. Second part of composite key
8158           required: true
8159           type: string
8160           example: __CLOUD-REGION-ID__
8161         - name: availability-zone-name
8162           in: path
8163           description: Name of the availability zone.  Unique across a cloud region
8164           required: true
8165           type: string
8166           example: __AVAILABILITY-ZONE-NAME__
8167   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
8168     get:
8169       tags:
8170         - CloudInfrastructure
8171       summary: returns availability-zone
8172       description: returns availability-zone
8173       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8174       produces:
8175         - application/json
8176         - application/xml
8177       responses:
8178         "200":
8179           description: successful operation
8180           schema:
8181               $ref: "#/getDefinitions/availability-zone"
8182         "default":
8183           description: Response codes found in [response codes](https://wiki.onap.org/).
8184       parameters:
8185         - name: cloud-owner
8186           in: path
8187           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8188           required: true
8189           type: string
8190           example: __CLOUD-OWNER__
8191         - name: cloud-region-id
8192           in: path
8193           description: Identifier used by the vendor for the region. Second part of composite key
8194           required: true
8195           type: string
8196           example: __CLOUD-REGION-ID__
8197         - name: availability-zone-name
8198           in: path
8199           description: Name of the availability zone.  Unique across a cloud region
8200           required: true
8201           type: string
8202           example: __AVAILABILITY-ZONE-NAME__
8203         - name: cloud-type
8204           in: query
8205           description: Type of the cloud (e.g., openstack)
8206           required: false
8207           type: string
8208         - name: owner-defined-type
8209           in: query
8210           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8211           required: false
8212           type: string
8213     put:
8214       tags:
8215         - CloudInfrastructure
8216       summary: create or update an existing availability-zone
8217       description: |
8218         Create or update an existing availability-zone.
8219         #
8220         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8221       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8222       consumes:
8223         - application/json
8224         - application/xml
8225       produces:
8226         - application/json
8227         - application/xml
8228       responses:
8229         "default":
8230           description: Response codes found in [response codes](https://wiki.onap.org/).
8231       parameters:
8232         - name: cloud-owner
8233           in: path
8234           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8235           required: true
8236           type: string
8237           example: __CLOUD-OWNER__
8238         - name: cloud-region-id
8239           in: path
8240           description: Identifier used by the vendor for the region. Second part of composite key
8241           required: true
8242           type: string
8243           example: __CLOUD-REGION-ID__
8244         - name: availability-zone-name
8245           in: path
8246           description: Name of the availability zone.  Unique across a cloud region
8247           required: true
8248           type: string
8249           example: __AVAILABILITY-ZONE-NAME__
8250         - name: body
8251           in: body
8252           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
8253           required: true
8254           schema:
8255             $ref: "#/definitions/availability-zone"
8256     patch:
8257       tags:
8258         - CloudInfrastructure
8259       summary: update an existing availability-zone
8260       description: |
8261         Update an existing availability-zone
8262         #
8263         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8264         The PUT operation will entirely replace an existing object.
8265         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8266         #
8267         Other differences between PUT and PATCH are:
8268         #
8269         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8270         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8271         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8272       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8273       consumes:
8274         - application/json
8275         - application/xml
8276       produces:
8277         - application/json
8278         - application/xml
8279       responses:
8280         "default":
8281           description: Response codes found in [response codes](https://wiki.onap.org/).
8282       parameters:
8283         - name: cloud-owner
8284           in: path
8285           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8286           required: true
8287           type: string
8288           example: __CLOUD-OWNER__
8289         - name: cloud-region-id
8290           in: path
8291           description: Identifier used by the vendor for the region. Second part of composite key
8292           required: true
8293           type: string
8294           example: __CLOUD-REGION-ID__
8295         - name: availability-zone-name
8296           in: path
8297           description: Name of the availability zone.  Unique across a cloud region
8298           required: true
8299           type: string
8300           example: __AVAILABILITY-ZONE-NAME__
8301         - name: body
8302           in: body
8303           description: availability-zone object that needs to be created or updated.
8304           required: true
8305           schema:
8306             $ref: "#/patchDefinitions/availability-zone"
8307     delete:
8308       tags:
8309         - CloudInfrastructure
8310       summary: delete an existing availability-zone
8311       description: delete an existing availability-zone
8312       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8313       consumes:
8314         - application/json
8315         - application/xml
8316       produces:
8317         - application/json
8318         - application/xml
8319       responses:
8320         "default":
8321           description: Response codes found in [response codes](https://wiki.onap.org/).
8322       parameters:
8323         - name: cloud-owner
8324           in: path
8325           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8326           required: true
8327           type: string
8328           example: __CLOUD-OWNER__
8329         - name: cloud-region-id
8330           in: path
8331           description: Identifier used by the vendor for the region. Second part of composite key
8332           required: true
8333           type: string
8334           example: __CLOUD-REGION-ID__
8335         - name: availability-zone-name
8336           in: path
8337           description: Name of the availability zone.  Unique across a cloud region
8338           required: true
8339           type: string
8340           example: __AVAILABILITY-ZONE-NAME__
8341         - name: resource-version
8342           in: query
8343           description: resource-version for concurrency
8344           required: true
8345           type: string
8346   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
8347     get:
8348       tags:
8349         - CloudInfrastructure
8350       summary: returns availability-zones
8351       description: returns availability-zones
8352       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
8353       produces:
8354         - application/json
8355         - application/xml
8356       responses:
8357         "200":
8358           description: successful operation
8359           schema:
8360               $ref: "#/getDefinitions/availability-zones"
8361         "default":
8362           description: Response codes found in [response codes](https://wiki.onap.org/).
8363       parameters:
8364         - name: cloud-owner
8365           in: path
8366           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8367           required: true
8368           type: string
8369           example: __CLOUD-OWNER__
8370         - name: cloud-region-id
8371           in: path
8372           description: Identifier used by the vendor for the region. Second part of composite key
8373           required: true
8374           type: string
8375           example: __CLOUD-REGION-ID__
8376         - name: cloud-type
8377           in: query
8378           description: Type of the cloud (e.g., openstack)
8379           required: false
8380           type: string
8381         - name: owner-defined-type
8382           in: query
8383           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8384           required: false
8385           type: string
8386   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
8387     put:
8388       tags:
8389         - CloudInfrastructure
8390       summary: see node definition for valid relationships
8391       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
8392       consumes:
8393         - application/json
8394         - application/xml
8395       produces:
8396         - application/json
8397         - application/xml
8398       responses:
8399         "default":
8400           description: Response codes found in [response codes](https://wiki.onap.org/).
8401       parameters:
8402         - name: cloud-owner
8403           in: path
8404           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8405           required: true
8406           type: string
8407           example: __CLOUD-OWNER__
8408         - name: cloud-region-id
8409           in: path
8410           description: Identifier used by the vendor for the region. Second part of composite key
8411           required: true
8412           type: string
8413           example: __CLOUD-REGION-ID__
8414         - name: body
8415           in: body
8416           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
8417           required: true
8418           schema:
8419             $ref: "#/definitions/relationship"
8420     delete:
8421       tags:
8422         - CloudInfrastructure
8423       summary: delete an existing relationship
8424       description: delete an existing relationship
8425       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
8426       consumes:
8427         - application/json
8428         - application/xml
8429       produces:
8430         - application/json
8431         - application/xml
8432       responses:
8433         "default":
8434           description: Response codes found in [response codes](https://wiki.onap.org/).
8435       parameters:
8436         - name: cloud-owner
8437           in: path
8438           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8439           required: true
8440           type: string
8441           example: __CLOUD-OWNER__
8442         - name: cloud-region-id
8443           in: path
8444           description: Identifier used by the vendor for the region. Second part of composite key
8445           required: true
8446           type: string
8447           example: __CLOUD-REGION-ID__
8448   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
8449     put:
8450       tags:
8451         - CloudInfrastructure
8452       summary: see node definition for valid relationships
8453       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8454       consumes:
8455         - application/json
8456         - application/xml
8457       produces:
8458         - application/json
8459         - application/xml
8460       responses:
8461         "default":
8462           description: Response codes found in [response codes](https://wiki.onap.org/).
8463       parameters:
8464         - name: cloud-owner
8465           in: path
8466           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8467           required: true
8468           type: string
8469           example: __CLOUD-OWNER__
8470         - name: cloud-region-id
8471           in: path
8472           description: Identifier used by the vendor for the region. Second part of composite key
8473           required: true
8474           type: string
8475           example: __CLOUD-REGION-ID__
8476         - name: vip-ipv4-address
8477           in: path
8478           description: IP address
8479           required: true
8480           type: string
8481           example: __VIP-IPV4-ADDRESS__
8482         - name: body
8483           in: body
8484           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8485           required: true
8486           schema:
8487             $ref: "#/definitions/relationship"
8488     delete:
8489       tags:
8490         - CloudInfrastructure
8491       summary: delete an existing relationship
8492       description: delete an existing relationship
8493       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8494       consumes:
8495         - application/json
8496         - application/xml
8497       produces:
8498         - application/json
8499         - application/xml
8500       responses:
8501         "default":
8502           description: Response codes found in [response codes](https://wiki.onap.org/).
8503       parameters:
8504         - name: cloud-owner
8505           in: path
8506           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8507           required: true
8508           type: string
8509           example: __CLOUD-OWNER__
8510         - name: cloud-region-id
8511           in: path
8512           description: Identifier used by the vendor for the region. Second part of composite key
8513           required: true
8514           type: string
8515           example: __CLOUD-REGION-ID__
8516         - name: vip-ipv4-address
8517           in: path
8518           description: IP address
8519           required: true
8520           type: string
8521           example: __VIP-IPV4-ADDRESS__
8522   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
8523     get:
8524       tags:
8525         - CloudInfrastructure
8526       summary: returns vip-ipv4-address-list
8527       description: returns vip-ipv4-address-list
8528       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8529       produces:
8530         - application/json
8531         - application/xml
8532       responses:
8533         "200":
8534           description: successful operation
8535           schema:
8536               $ref: "#/getDefinitions/vip-ipv4-address-list"
8537         "default":
8538           description: Response codes found in [response codes](https://wiki.onap.org/).
8539       parameters:
8540         - name: cloud-owner
8541           in: path
8542           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8543           required: true
8544           type: string
8545           example: __CLOUD-OWNER__
8546         - name: cloud-region-id
8547           in: path
8548           description: Identifier used by the vendor for the region. Second part of composite key
8549           required: true
8550           type: string
8551           example: __CLOUD-REGION-ID__
8552         - name: vip-ipv4-address
8553           in: path
8554           description: IP address
8555           required: true
8556           type: string
8557           example: __VIP-IPV4-ADDRESS__
8558         - name: cloud-type
8559           in: query
8560           description: Type of the cloud (e.g., openstack)
8561           required: false
8562           type: string
8563         - name: owner-defined-type
8564           in: query
8565           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8566           required: false
8567           type: string
8568         - name: vlan-id-inner
8569           in: query
8570           description: Inner VLAN tag
8571           required: false
8572           type: integer
8573           format: int64
8574         - name: neutron-network-id
8575           in: query
8576           description: Neutron network id of the interface that address belongs to
8577           required: false
8578           type: string
8579         - name: neutron-subnet-id
8580           in: query
8581           description: Neutron id of subnet that address belongs to
8582           required: false
8583           type: string
8584     put:
8585       tags:
8586         - CloudInfrastructure
8587       summary: create or update an existing vip-ipv4-address-list
8588       description: |
8589         Create or update an existing vip-ipv4-address-list.
8590         #
8591         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8592       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8593       consumes:
8594         - application/json
8595         - application/xml
8596       produces:
8597         - application/json
8598         - application/xml
8599       responses:
8600         "default":
8601           description: Response codes found in [response codes](https://wiki.onap.org/).
8602       parameters:
8603         - name: cloud-owner
8604           in: path
8605           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8606           required: true
8607           type: string
8608           example: __CLOUD-OWNER__
8609         - name: cloud-region-id
8610           in: path
8611           description: Identifier used by the vendor for the region. Second part of composite key
8612           required: true
8613           type: string
8614           example: __CLOUD-REGION-ID__
8615         - name: vip-ipv4-address
8616           in: path
8617           description: IP address
8618           required: true
8619           type: string
8620           example: __VIP-IPV4-ADDRESS__
8621         - name: body
8622           in: body
8623           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8624           required: true
8625           schema:
8626             $ref: "#/definitions/vip-ipv4-address-list"
8627     patch:
8628       tags:
8629         - CloudInfrastructure
8630       summary: update an existing vip-ipv4-address-list
8631       description: |
8632         Update an existing vip-ipv4-address-list
8633         #
8634         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8635         The PUT operation will entirely replace an existing object.
8636         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8637         #
8638         Other differences between PUT and PATCH are:
8639         #
8640         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8641         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8642         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8643       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8644       consumes:
8645         - application/json
8646         - application/xml
8647       produces:
8648         - application/json
8649         - application/xml
8650       responses:
8651         "default":
8652           description: Response codes found in [response codes](https://wiki.onap.org/).
8653       parameters:
8654         - name: cloud-owner
8655           in: path
8656           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8657           required: true
8658           type: string
8659           example: __CLOUD-OWNER__
8660         - name: cloud-region-id
8661           in: path
8662           description: Identifier used by the vendor for the region. Second part of composite key
8663           required: true
8664           type: string
8665           example: __CLOUD-REGION-ID__
8666         - name: vip-ipv4-address
8667           in: path
8668           description: IP address
8669           required: true
8670           type: string
8671           example: __VIP-IPV4-ADDRESS__
8672         - name: body
8673           in: body
8674           description: vip-ipv4-address-list object that needs to be created or updated.
8675           required: true
8676           schema:
8677             $ref: "#/patchDefinitions/vip-ipv4-address-list"
8678     delete:
8679       tags:
8680         - CloudInfrastructure
8681       summary: delete an existing vip-ipv4-address-list
8682       description: delete an existing vip-ipv4-address-list
8683       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8684       consumes:
8685         - application/json
8686         - application/xml
8687       produces:
8688         - application/json
8689         - application/xml
8690       responses:
8691         "default":
8692           description: Response codes found in [response codes](https://wiki.onap.org/).
8693       parameters:
8694         - name: cloud-owner
8695           in: path
8696           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8697           required: true
8698           type: string
8699           example: __CLOUD-OWNER__
8700         - name: cloud-region-id
8701           in: path
8702           description: Identifier used by the vendor for the region. Second part of composite key
8703           required: true
8704           type: string
8705           example: __CLOUD-REGION-ID__
8706         - name: vip-ipv4-address
8707           in: path
8708           description: IP address
8709           required: true
8710           type: string
8711           example: __VIP-IPV4-ADDRESS__
8712         - name: resource-version
8713           in: query
8714           description: resource-version for concurrency
8715           required: true
8716           type: string
8717   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
8718     put:
8719       tags:
8720         - CloudInfrastructure
8721       summary: see node definition for valid relationships
8722       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8723       consumes:
8724         - application/json
8725         - application/xml
8726       produces:
8727         - application/json
8728         - application/xml
8729       responses:
8730         "default":
8731           description: Response codes found in [response codes](https://wiki.onap.org/).
8732       parameters:
8733         - name: cloud-owner
8734           in: path
8735           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8736           required: true
8737           type: string
8738           example: __CLOUD-OWNER__
8739         - name: cloud-region-id
8740           in: path
8741           description: Identifier used by the vendor for the region. Second part of composite key
8742           required: true
8743           type: string
8744           example: __CLOUD-REGION-ID__
8745         - name: vip-ipv6-address
8746           in: path
8747           description: IP address
8748           required: true
8749           type: string
8750           example: __VIP-IPV6-ADDRESS__
8751         - name: body
8752           in: body
8753           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8754           required: true
8755           schema:
8756             $ref: "#/definitions/relationship"
8757     delete:
8758       tags:
8759         - CloudInfrastructure
8760       summary: delete an existing relationship
8761       description: delete an existing relationship
8762       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8763       consumes:
8764         - application/json
8765         - application/xml
8766       produces:
8767         - application/json
8768         - application/xml
8769       responses:
8770         "default":
8771           description: Response codes found in [response codes](https://wiki.onap.org/).
8772       parameters:
8773         - name: cloud-owner
8774           in: path
8775           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8776           required: true
8777           type: string
8778           example: __CLOUD-OWNER__
8779         - name: cloud-region-id
8780           in: path
8781           description: Identifier used by the vendor for the region. Second part of composite key
8782           required: true
8783           type: string
8784           example: __CLOUD-REGION-ID__
8785         - name: vip-ipv6-address
8786           in: path
8787           description: IP address
8788           required: true
8789           type: string
8790           example: __VIP-IPV6-ADDRESS__
8791   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
8792     get:
8793       tags:
8794         - CloudInfrastructure
8795       summary: returns vip-ipv6-address-list
8796       description: returns vip-ipv6-address-list
8797       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8798       produces:
8799         - application/json
8800         - application/xml
8801       responses:
8802         "200":
8803           description: successful operation
8804           schema:
8805               $ref: "#/getDefinitions/vip-ipv6-address-list"
8806         "default":
8807           description: Response codes found in [response codes](https://wiki.onap.org/).
8808       parameters:
8809         - name: cloud-owner
8810           in: path
8811           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8812           required: true
8813           type: string
8814           example: __CLOUD-OWNER__
8815         - name: cloud-region-id
8816           in: path
8817           description: Identifier used by the vendor for the region. Second part of composite key
8818           required: true
8819           type: string
8820           example: __CLOUD-REGION-ID__
8821         - name: vip-ipv6-address
8822           in: path
8823           description: IP address
8824           required: true
8825           type: string
8826           example: __VIP-IPV6-ADDRESS__
8827         - name: cloud-type
8828           in: query
8829           description: Type of the cloud (e.g., openstack)
8830           required: false
8831           type: string
8832         - name: owner-defined-type
8833           in: query
8834           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8835           required: false
8836           type: string
8837         - name: vlan-id-inner
8838           in: query
8839           description: Inner VLAN tag
8840           required: false
8841           type: integer
8842           format: int64
8843         - name: neutron-network-id
8844           in: query
8845           description: Neutron network id of the interface that address belongs to
8846           required: false
8847           type: string
8848         - name: neutron-subnet-id
8849           in: query
8850           description: Neutron id of subnet that address belongs to
8851           required: false
8852           type: string
8853     put:
8854       tags:
8855         - CloudInfrastructure
8856       summary: create or update an existing vip-ipv6-address-list
8857       description: |
8858         Create or update an existing vip-ipv6-address-list.
8859         #
8860         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8861       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8862       consumes:
8863         - application/json
8864         - application/xml
8865       produces:
8866         - application/json
8867         - application/xml
8868       responses:
8869         "default":
8870           description: Response codes found in [response codes](https://wiki.onap.org/).
8871       parameters:
8872         - name: cloud-owner
8873           in: path
8874           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8875           required: true
8876           type: string
8877           example: __CLOUD-OWNER__
8878         - name: cloud-region-id
8879           in: path
8880           description: Identifier used by the vendor for the region. Second part of composite key
8881           required: true
8882           type: string
8883           example: __CLOUD-REGION-ID__
8884         - name: vip-ipv6-address
8885           in: path
8886           description: IP address
8887           required: true
8888           type: string
8889           example: __VIP-IPV6-ADDRESS__
8890         - name: body
8891           in: body
8892           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8893           required: true
8894           schema:
8895             $ref: "#/definitions/vip-ipv6-address-list"
8896     patch:
8897       tags:
8898         - CloudInfrastructure
8899       summary: update an existing vip-ipv6-address-list
8900       description: |
8901         Update an existing vip-ipv6-address-list
8902         #
8903         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8904         The PUT operation will entirely replace an existing object.
8905         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8906         #
8907         Other differences between PUT and PATCH are:
8908         #
8909         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8910         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8911         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8912       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8913       consumes:
8914         - application/json
8915         - application/xml
8916       produces:
8917         - application/json
8918         - application/xml
8919       responses:
8920         "default":
8921           description: Response codes found in [response codes](https://wiki.onap.org/).
8922       parameters:
8923         - name: cloud-owner
8924           in: path
8925           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8926           required: true
8927           type: string
8928           example: __CLOUD-OWNER__
8929         - name: cloud-region-id
8930           in: path
8931           description: Identifier used by the vendor for the region. Second part of composite key
8932           required: true
8933           type: string
8934           example: __CLOUD-REGION-ID__
8935         - name: vip-ipv6-address
8936           in: path
8937           description: IP address
8938           required: true
8939           type: string
8940           example: __VIP-IPV6-ADDRESS__
8941         - name: body
8942           in: body
8943           description: vip-ipv6-address-list object that needs to be created or updated.
8944           required: true
8945           schema:
8946             $ref: "#/patchDefinitions/vip-ipv6-address-list"
8947     delete:
8948       tags:
8949         - CloudInfrastructure
8950       summary: delete an existing vip-ipv6-address-list
8951       description: delete an existing vip-ipv6-address-list
8952       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8953       consumes:
8954         - application/json
8955         - application/xml
8956       produces:
8957         - application/json
8958         - application/xml
8959       responses:
8960         "default":
8961           description: Response codes found in [response codes](https://wiki.onap.org/).
8962       parameters:
8963         - name: cloud-owner
8964           in: path
8965           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8966           required: true
8967           type: string
8968           example: __CLOUD-OWNER__
8969         - name: cloud-region-id
8970           in: path
8971           description: Identifier used by the vendor for the region. Second part of composite key
8972           required: true
8973           type: string
8974           example: __CLOUD-REGION-ID__
8975         - name: vip-ipv6-address
8976           in: path
8977           description: IP address
8978           required: true
8979           type: string
8980           example: __VIP-IPV6-ADDRESS__
8981         - name: resource-version
8982           in: query
8983           description: resource-version for concurrency
8984           required: true
8985           type: string
8986   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
8987     put:
8988       tags:
8989         - CloudInfrastructure
8990       summary: see node definition for valid relationships
8991       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
8992       consumes:
8993         - application/json
8994         - application/xml
8995       produces:
8996         - application/json
8997         - application/xml
8998       responses:
8999         "default":
9000           description: Response codes found in [response codes](https://wiki.onap.org/).
9001       parameters:
9002         - name: cloud-owner
9003           in: path
9004           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9005           required: true
9006           type: string
9007           example: __CLOUD-OWNER__
9008         - name: cloud-region-id
9009           in: path
9010           description: Identifier used by the vendor for the region. Second part of composite key
9011           required: true
9012           type: string
9013           example: __CLOUD-REGION-ID__
9014         - name: hpa-capability-id
9015           in: path
9016           description: UUID to uniquely identify a HPA capability
9017           required: true
9018           type: string
9019           example: __HPA-CAPABILITY-ID__
9020         - name: body
9021           in: body
9022           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
9023           required: true
9024           schema:
9025             $ref: "#/definitions/relationship"
9026     delete:
9027       tags:
9028         - CloudInfrastructure
9029       summary: delete an existing relationship
9030       description: delete an existing relationship
9031       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
9032       consumes:
9033         - application/json
9034         - application/xml
9035       produces:
9036         - application/json
9037         - application/xml
9038       responses:
9039         "default":
9040           description: Response codes found in [response codes](https://wiki.onap.org/).
9041       parameters:
9042         - name: cloud-owner
9043           in: path
9044           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9045           required: true
9046           type: string
9047           example: __CLOUD-OWNER__
9048         - name: cloud-region-id
9049           in: path
9050           description: Identifier used by the vendor for the region. Second part of composite key
9051           required: true
9052           type: string
9053           example: __CLOUD-REGION-ID__
9054         - name: hpa-capability-id
9055           in: path
9056           description: UUID to uniquely identify a HPA capability
9057           required: true
9058           type: string
9059           example: __HPA-CAPABILITY-ID__
9060   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
9061     put:
9062       tags:
9063         - CloudInfrastructure
9064       summary: see node definition for valid relationships
9065       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
9066       consumes:
9067         - application/json
9068         - application/xml
9069       produces:
9070         - application/json
9071         - application/xml
9072       responses:
9073         "default":
9074           description: Response codes found in [response codes](https://wiki.onap.org/).
9075       parameters:
9076         - name: cloud-owner
9077           in: path
9078           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9079           required: true
9080           type: string
9081           example: __CLOUD-OWNER__
9082         - name: cloud-region-id
9083           in: path
9084           description: Identifier used by the vendor for the region. Second part of composite key
9085           required: true
9086           type: string
9087           example: __CLOUD-REGION-ID__
9088         - name: hpa-capability-id
9089           in: path
9090           description: UUID to uniquely identify a HPA capability
9091           required: true
9092           type: string
9093           example: __HPA-CAPABILITY-ID__
9094         - name: hpa-attribute-key
9095           in: path
9096           description: name of the specific HPA attribute
9097           required: true
9098           type: string
9099           example: __HPA-ATTRIBUTE-KEY__
9100         - name: body
9101           in: body
9102           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
9103           required: true
9104           schema:
9105             $ref: "#/definitions/relationship"
9106     delete:
9107       tags:
9108         - CloudInfrastructure
9109       summary: delete an existing relationship
9110       description: delete an existing relationship
9111       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
9112       consumes:
9113         - application/json
9114         - application/xml
9115       produces:
9116         - application/json
9117         - application/xml
9118       responses:
9119         "default":
9120           description: Response codes found in [response codes](https://wiki.onap.org/).
9121       parameters:
9122         - name: cloud-owner
9123           in: path
9124           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9125           required: true
9126           type: string
9127           example: __CLOUD-OWNER__
9128         - name: cloud-region-id
9129           in: path
9130           description: Identifier used by the vendor for the region. Second part of composite key
9131           required: true
9132           type: string
9133           example: __CLOUD-REGION-ID__
9134         - name: hpa-capability-id
9135           in: path
9136           description: UUID to uniquely identify a HPA capability
9137           required: true
9138           type: string
9139           example: __HPA-CAPABILITY-ID__
9140         - name: hpa-attribute-key
9141           in: path
9142           description: name of the specific HPA attribute
9143           required: true
9144           type: string
9145           example: __HPA-ATTRIBUTE-KEY__
9146   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
9147     get:
9148       tags:
9149         - CloudInfrastructure
9150       summary: returns hpa-feature-attributes
9151       description: returns hpa-feature-attributes
9152       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
9153       produces:
9154         - application/json
9155         - application/xml
9156       responses:
9157         "200":
9158           description: successful operation
9159           schema:
9160               $ref: "#/getDefinitions/hpa-feature-attributes"
9161         "default":
9162           description: Response codes found in [response codes](https://wiki.onap.org/).
9163       parameters:
9164         - name: cloud-owner
9165           in: path
9166           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9167           required: true
9168           type: string
9169           example: __CLOUD-OWNER__
9170         - name: cloud-region-id
9171           in: path
9172           description: Identifier used by the vendor for the region. Second part of composite key
9173           required: true
9174           type: string
9175           example: __CLOUD-REGION-ID__
9176         - name: hpa-capability-id
9177           in: path
9178           description: UUID to uniquely identify a HPA capability
9179           required: true
9180           type: string
9181           example: __HPA-CAPABILITY-ID__
9182         - name: hpa-attribute-key
9183           in: path
9184           description: name of the specific HPA attribute
9185           required: true
9186           type: string
9187           example: __HPA-ATTRIBUTE-KEY__
9188         - name: cloud-type
9189           in: query
9190           description: Type of the cloud (e.g., openstack)
9191           required: false
9192           type: string
9193         - name: owner-defined-type
9194           in: query
9195           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9196           required: false
9197           type: string
9198         - name: hpa-feature
9199           in: query
9200           description: Name of the HPACapability
9201           required: false
9202           type: string
9203         - name: architecture
9204           in: query
9205           description: Hardware architecture
9206           required: false
9207           type: string
9208     put:
9209       tags:
9210         - CloudInfrastructure
9211       summary: create or update an existing hpa-feature-attributes
9212       description: |
9213         Create or update an existing hpa-feature-attributes.
9214         #
9215         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9216       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
9217       consumes:
9218         - application/json
9219         - application/xml
9220       produces:
9221         - application/json
9222         - application/xml
9223       responses:
9224         "default":
9225           description: Response codes found in [response codes](https://wiki.onap.org/).
9226       parameters:
9227         - name: cloud-owner
9228           in: path
9229           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9230           required: true
9231           type: string
9232           example: __CLOUD-OWNER__
9233         - name: cloud-region-id
9234           in: path
9235           description: Identifier used by the vendor for the region. Second part of composite key
9236           required: true
9237           type: string
9238           example: __CLOUD-REGION-ID__
9239         - name: hpa-capability-id
9240           in: path
9241           description: UUID to uniquely identify a HPA capability
9242           required: true
9243           type: string
9244           example: __HPA-CAPABILITY-ID__
9245         - name: hpa-attribute-key
9246           in: path
9247           description: name of the specific HPA attribute
9248           required: true
9249           type: string
9250           example: __HPA-ATTRIBUTE-KEY__
9251         - name: body
9252           in: body
9253           description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
9254           required: true
9255           schema:
9256             $ref: "#/definitions/hpa-feature-attributes"
9257     patch:
9258       tags:
9259         - CloudInfrastructure
9260       summary: update an existing hpa-feature-attributes
9261       description: |
9262         Update an existing hpa-feature-attributes
9263         #
9264         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9265         The PUT operation will entirely replace an existing object.
9266         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9267         #
9268         Other differences between PUT and PATCH are:
9269         #
9270         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9271         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9272         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9273       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
9274       consumes:
9275         - application/json
9276         - application/xml
9277       produces:
9278         - application/json
9279         - application/xml
9280       responses:
9281         "default":
9282           description: Response codes found in [response codes](https://wiki.onap.org/).
9283       parameters:
9284         - name: cloud-owner
9285           in: path
9286           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9287           required: true
9288           type: string
9289           example: __CLOUD-OWNER__
9290         - name: cloud-region-id
9291           in: path
9292           description: Identifier used by the vendor for the region. Second part of composite key
9293           required: true
9294           type: string
9295           example: __CLOUD-REGION-ID__
9296         - name: hpa-capability-id
9297           in: path
9298           description: UUID to uniquely identify a HPA capability
9299           required: true
9300           type: string
9301           example: __HPA-CAPABILITY-ID__
9302         - name: hpa-attribute-key
9303           in: path
9304           description: name of the specific HPA attribute
9305           required: true
9306           type: string
9307           example: __HPA-ATTRIBUTE-KEY__
9308         - name: body
9309           in: body
9310           description: hpa-feature-attributes object that needs to be created or updated.
9311           required: true
9312           schema:
9313             $ref: "#/patchDefinitions/hpa-feature-attributes"
9314     delete:
9315       tags:
9316         - CloudInfrastructure
9317       summary: delete an existing hpa-feature-attributes
9318       description: delete an existing hpa-feature-attributes
9319       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
9320       consumes:
9321         - application/json
9322         - application/xml
9323       produces:
9324         - application/json
9325         - application/xml
9326       responses:
9327         "default":
9328           description: Response codes found in [response codes](https://wiki.onap.org/).
9329       parameters:
9330         - name: cloud-owner
9331           in: path
9332           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9333           required: true
9334           type: string
9335           example: __CLOUD-OWNER__
9336         - name: cloud-region-id
9337           in: path
9338           description: Identifier used by the vendor for the region. Second part of composite key
9339           required: true
9340           type: string
9341           example: __CLOUD-REGION-ID__
9342         - name: hpa-capability-id
9343           in: path
9344           description: UUID to uniquely identify a HPA capability
9345           required: true
9346           type: string
9347           example: __HPA-CAPABILITY-ID__
9348         - name: hpa-attribute-key
9349           in: path
9350           description: name of the specific HPA attribute
9351           required: true
9352           type: string
9353           example: __HPA-ATTRIBUTE-KEY__
9354         - name: resource-version
9355           in: query
9356           description: resource-version for concurrency
9357           required: true
9358           type: string
9359   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
9360     get:
9361       tags:
9362         - CloudInfrastructure
9363       summary: returns hpa-capability
9364       description: returns hpa-capability
9365       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9366       produces:
9367         - application/json
9368         - application/xml
9369       responses:
9370         "200":
9371           description: successful operation
9372           schema:
9373               $ref: "#/getDefinitions/hpa-capability"
9374         "default":
9375           description: Response codes found in [response codes](https://wiki.onap.org/).
9376       parameters:
9377         - name: cloud-owner
9378           in: path
9379           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9380           required: true
9381           type: string
9382           example: __CLOUD-OWNER__
9383         - name: cloud-region-id
9384           in: path
9385           description: Identifier used by the vendor for the region. Second part of composite key
9386           required: true
9387           type: string
9388           example: __CLOUD-REGION-ID__
9389         - name: hpa-capability-id
9390           in: path
9391           description: UUID to uniquely identify a HPA capability
9392           required: true
9393           type: string
9394           example: __HPA-CAPABILITY-ID__
9395         - name: cloud-type
9396           in: query
9397           description: Type of the cloud (e.g., openstack)
9398           required: false
9399           type: string
9400         - name: owner-defined-type
9401           in: query
9402           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9403           required: false
9404           type: string
9405         - name: hpa-feature
9406           in: query
9407           description: Name of the HPACapability
9408           required: false
9409           type: string
9410         - name: architecture
9411           in: query
9412           description: Hardware architecture
9413           required: false
9414           type: string
9415     put:
9416       tags:
9417         - CloudInfrastructure
9418       summary: create or update an existing hpa-capability
9419       description: |
9420         Create or update an existing hpa-capability.
9421         #
9422         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9423       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9424       consumes:
9425         - application/json
9426         - application/xml
9427       produces:
9428         - application/json
9429         - application/xml
9430       responses:
9431         "default":
9432           description: Response codes found in [response codes](https://wiki.onap.org/).
9433       parameters:
9434         - name: cloud-owner
9435           in: path
9436           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9437           required: true
9438           type: string
9439           example: __CLOUD-OWNER__
9440         - name: cloud-region-id
9441           in: path
9442           description: Identifier used by the vendor for the region. Second part of composite key
9443           required: true
9444           type: string
9445           example: __CLOUD-REGION-ID__
9446         - name: hpa-capability-id
9447           in: path
9448           description: UUID to uniquely identify a HPA capability
9449           required: true
9450           type: string
9451           example: __HPA-CAPABILITY-ID__
9452         - name: body
9453           in: body
9454           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
9455           required: true
9456           schema:
9457             $ref: "#/definitions/hpa-capability"
9458     patch:
9459       tags:
9460         - CloudInfrastructure
9461       summary: update an existing hpa-capability
9462       description: |
9463         Update an existing hpa-capability
9464         #
9465         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9466         The PUT operation will entirely replace an existing object.
9467         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9468         #
9469         Other differences between PUT and PATCH are:
9470         #
9471         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9472         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9473         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9474       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9475       consumes:
9476         - application/json
9477         - application/xml
9478       produces:
9479         - application/json
9480         - application/xml
9481       responses:
9482         "default":
9483           description: Response codes found in [response codes](https://wiki.onap.org/).
9484       parameters:
9485         - name: cloud-owner
9486           in: path
9487           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9488           required: true
9489           type: string
9490           example: __CLOUD-OWNER__
9491         - name: cloud-region-id
9492           in: path
9493           description: Identifier used by the vendor for the region. Second part of composite key
9494           required: true
9495           type: string
9496           example: __CLOUD-REGION-ID__
9497         - name: hpa-capability-id
9498           in: path
9499           description: UUID to uniquely identify a HPA capability
9500           required: true
9501           type: string
9502           example: __HPA-CAPABILITY-ID__
9503         - name: body
9504           in: body
9505           description: hpa-capability object that needs to be created or updated.
9506           required: true
9507           schema:
9508             $ref: "#/patchDefinitions/hpa-capability"
9509     delete:
9510       tags:
9511         - CloudInfrastructure
9512       summary: delete an existing hpa-capability
9513       description: delete an existing hpa-capability
9514       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9515       consumes:
9516         - application/json
9517         - application/xml
9518       produces:
9519         - application/json
9520         - application/xml
9521       responses:
9522         "default":
9523           description: Response codes found in [response codes](https://wiki.onap.org/).
9524       parameters:
9525         - name: cloud-owner
9526           in: path
9527           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9528           required: true
9529           type: string
9530           example: __CLOUD-OWNER__
9531         - name: cloud-region-id
9532           in: path
9533           description: Identifier used by the vendor for the region. Second part of composite key
9534           required: true
9535           type: string
9536           example: __CLOUD-REGION-ID__
9537         - name: hpa-capability-id
9538           in: path
9539           description: UUID to uniquely identify a HPA capability
9540           required: true
9541           type: string
9542           example: __HPA-CAPABILITY-ID__
9543         - name: resource-version
9544           in: query
9545           description: resource-version for concurrency
9546           required: true
9547           type: string
9548   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities:
9549     get:
9550       tags:
9551         - CloudInfrastructure
9552       summary: returns hpa-capabilities
9553       description: returns hpa-capabilities
9554       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
9555       produces:
9556         - application/json
9557         - application/xml
9558       responses:
9559         "200":
9560           description: successful operation
9561           schema:
9562               $ref: "#/getDefinitions/hpa-capabilities"
9563         "default":
9564           description: Response codes found in [response codes](https://wiki.onap.org/).
9565       parameters:
9566         - name: cloud-owner
9567           in: path
9568           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9569           required: true
9570           type: string
9571           example: __CLOUD-OWNER__
9572         - name: cloud-region-id
9573           in: path
9574           description: Identifier used by the vendor for the region. Second part of composite key
9575           required: true
9576           type: string
9577           example: __CLOUD-REGION-ID__
9578         - name: cloud-type
9579           in: query
9580           description: Type of the cloud (e.g., openstack)
9581           required: false
9582           type: string
9583         - name: owner-defined-type
9584           in: query
9585           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9586           required: false
9587           type: string
9588   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
9589     get:
9590       tags:
9591         - CloudInfrastructure
9592       summary: returns cloud-region
9593       description: returns cloud-region
9594       operationId: getCloudInfrastructureCloudRegionsCloudRegion
9595       produces:
9596         - application/json
9597         - application/xml
9598       responses:
9599         "200":
9600           description: successful operation
9601           schema:
9602               $ref: "#/getDefinitions/cloud-region"
9603         "default":
9604           description: Response codes found in [response codes](https://wiki.onap.org/).
9605       parameters:
9606         - name: cloud-owner
9607           in: path
9608           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9609           required: true
9610           type: string
9611           example: __CLOUD-OWNER__
9612         - name: cloud-region-id
9613           in: path
9614           description: Identifier used by the vendor for the region. Second part of composite key
9615           required: true
9616           type: string
9617           example: __CLOUD-REGION-ID__
9618         - name: cloud-type
9619           in: query
9620           description: Type of the cloud (e.g., openstack)
9621           required: false
9622           type: string
9623         - name: owner-defined-type
9624           in: query
9625           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9626           required: false
9627           type: string
9628     put:
9629       tags:
9630         - CloudInfrastructure
9631       summary: create or update an existing cloud-region
9632       description: |
9633         Create or update an existing cloud-region.
9634         #
9635         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9636       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
9637       consumes:
9638         - application/json
9639         - application/xml
9640       produces:
9641         - application/json
9642         - application/xml
9643       responses:
9644         "default":
9645           description: Response codes found in [response codes](https://wiki.onap.org/).
9646       parameters:
9647         - name: cloud-owner
9648           in: path
9649           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9650           required: true
9651           type: string
9652           example: __CLOUD-OWNER__
9653         - name: cloud-region-id
9654           in: path
9655           description: Identifier used by the vendor for the region. Second part of composite key
9656           required: true
9657           type: string
9658           example: __CLOUD-REGION-ID__
9659         - name: body
9660           in: body
9661           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
9662           required: true
9663           schema:
9664             $ref: "#/definitions/cloud-region"
9665     patch:
9666       tags:
9667         - CloudInfrastructure
9668       summary: update an existing cloud-region
9669       description: |
9670         Update an existing cloud-region
9671         #
9672         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9673         The PUT operation will entirely replace an existing object.
9674         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9675         #
9676         Other differences between PUT and PATCH are:
9677         #
9678         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9679         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9680         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9681       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
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: cloud-owner
9693           in: path
9694           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9695           required: true
9696           type: string
9697           example: __CLOUD-OWNER__
9698         - name: cloud-region-id
9699           in: path
9700           description: Identifier used by the vendor for the region. Second part of composite key
9701           required: true
9702           type: string
9703           example: __CLOUD-REGION-ID__
9704         - name: body
9705           in: body
9706           description: cloud-region object that needs to be created or updated.
9707           required: true
9708           schema:
9709             $ref: "#/patchDefinitions/cloud-region"
9710     delete:
9711       tags:
9712         - CloudInfrastructure
9713       summary: delete an existing cloud-region
9714       description: delete an existing cloud-region
9715       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
9716       consumes:
9717         - application/json
9718         - application/xml
9719       produces:
9720         - application/json
9721         - application/xml
9722       responses:
9723         "default":
9724           description: Response codes found in [response codes](https://wiki.onap.org/).
9725       parameters:
9726         - name: cloud-owner
9727           in: path
9728           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9729           required: true
9730           type: string
9731           example: __CLOUD-OWNER__
9732         - name: cloud-region-id
9733           in: path
9734           description: Identifier used by the vendor for the region. Second part of composite key
9735           required: true
9736           type: string
9737           example: __CLOUD-REGION-ID__
9738         - name: resource-version
9739           in: query
9740           description: resource-version for concurrency
9741           required: true
9742           type: string
9743   /cloud-infrastructure/cloud-regions:
9744     get:
9745       tags:
9746         - CloudInfrastructure
9747       summary: returns cloud-regions
9748       description: returns cloud-regions
9749       operationId: getCloudInfrastructureCloudRegions
9750       produces:
9751         - application/json
9752         - application/xml
9753       responses:
9754         "200":
9755           description: successful operation
9756           schema:
9757               $ref: "#/getDefinitions/cloud-regions"
9758         "default":
9759           description: Response codes found in [response codes](https://wiki.onap.org/).
9760   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
9761     put:
9762       tags:
9763         - CloudInfrastructure
9764       summary: see node definition for valid relationships
9765       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
9766       consumes:
9767         - application/json
9768         - application/xml
9769       produces:
9770         - application/json
9771         - application/xml
9772       responses:
9773         "default":
9774           description: Response codes found in [response codes](https://wiki.onap.org/).
9775       parameters:
9776         - name: nm-profile-name
9777           in: path
9778           description: Unique name of network profile.
9779           required: true
9780           type: string
9781           example: __NM-PROFILE-NAME__
9782         - name: body
9783           in: body
9784           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9785           required: true
9786           schema:
9787             $ref: "#/definitions/relationship"
9788     delete:
9789       tags:
9790         - CloudInfrastructure
9791       summary: delete an existing relationship
9792       description: delete an existing relationship
9793       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
9794       consumes:
9795         - application/json
9796         - application/xml
9797       produces:
9798         - application/json
9799         - application/xml
9800       responses:
9801         "default":
9802           description: Response codes found in [response codes](https://wiki.onap.org/).
9803       parameters:
9804         - name: nm-profile-name
9805           in: path
9806           description: Unique name of network profile.
9807           required: true
9808           type: string
9809           example: __NM-PROFILE-NAME__
9810   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
9811     get:
9812       tags:
9813         - CloudInfrastructure
9814       summary: returns network-profile
9815       description: returns network-profile
9816       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
9817       produces:
9818         - application/json
9819         - application/xml
9820       responses:
9821         "200":
9822           description: successful operation
9823           schema:
9824               $ref: "#/getDefinitions/network-profile"
9825         "default":
9826           description: Response codes found in [response codes](https://wiki.onap.org/).
9827       parameters:
9828         - name: nm-profile-name
9829           in: path
9830           description: Unique name of network profile.
9831           required: true
9832           type: string
9833           example: __NM-PROFILE-NAME__
9834     put:
9835       tags:
9836         - CloudInfrastructure
9837       summary: create or update an existing network-profile
9838       description: |
9839         Create or update an existing network-profile.
9840         #
9841         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9842       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
9843       consumes:
9844         - application/json
9845         - application/xml
9846       produces:
9847         - application/json
9848         - application/xml
9849       responses:
9850         "default":
9851           description: Response codes found in [response codes](https://wiki.onap.org/).
9852       parameters:
9853         - name: nm-profile-name
9854           in: path
9855           description: Unique name of network profile.
9856           required: true
9857           type: string
9858           example: __NM-PROFILE-NAME__
9859         - name: body
9860           in: body
9861           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9862           required: true
9863           schema:
9864             $ref: "#/definitions/network-profile"
9865     patch:
9866       tags:
9867         - CloudInfrastructure
9868       summary: update an existing network-profile
9869       description: |
9870         Update an existing network-profile
9871         #
9872         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9873         The PUT operation will entirely replace an existing object.
9874         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9875         #
9876         Other differences between PUT and PATCH are:
9877         #
9878         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9879         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9880         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9881       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
9882       consumes:
9883         - application/json
9884         - application/xml
9885       produces:
9886         - application/json
9887         - application/xml
9888       responses:
9889         "default":
9890           description: Response codes found in [response codes](https://wiki.onap.org/).
9891       parameters:
9892         - name: nm-profile-name
9893           in: path
9894           description: Unique name of network profile.
9895           required: true
9896           type: string
9897           example: __NM-PROFILE-NAME__
9898         - name: body
9899           in: body
9900           description: network-profile object that needs to be created or updated.
9901           required: true
9902           schema:
9903             $ref: "#/patchDefinitions/network-profile"
9904     delete:
9905       tags:
9906         - CloudInfrastructure
9907       summary: delete an existing network-profile
9908       description: delete an existing network-profile
9909       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
9910       consumes:
9911         - application/json
9912         - application/xml
9913       produces:
9914         - application/json
9915         - application/xml
9916       responses:
9917         "default":
9918           description: Response codes found in [response codes](https://wiki.onap.org/).
9919       parameters:
9920         - name: nm-profile-name
9921           in: path
9922           description: Unique name of network profile.
9923           required: true
9924           type: string
9925           example: __NM-PROFILE-NAME__
9926         - name: resource-version
9927           in: query
9928           description: resource-version for concurrency
9929           required: true
9930           type: string
9931   /cloud-infrastructure/network-profiles:
9932     get:
9933       tags:
9934         - CloudInfrastructure
9935       summary: returns network-profiles
9936       description: returns network-profiles
9937       operationId: getCloudInfrastructureNetworkProfiles
9938       produces:
9939         - application/json
9940         - application/xml
9941       responses:
9942         "200":
9943           description: successful operation
9944           schema:
9945               $ref: "#/getDefinitions/network-profiles"
9946         "default":
9947           description: Response codes found in [response codes](https://wiki.onap.org/).
9948   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
9949     put:
9950       tags:
9951         - CloudInfrastructure
9952       summary: see node definition for valid relationships
9953       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
9954       consumes:
9955         - application/json
9956         - application/xml
9957       produces:
9958         - application/json
9959         - application/xml
9960       responses:
9961         "default":
9962           description: Response codes found in [response codes](https://wiki.onap.org/).
9963       parameters:
9964         - name: hostname
9965           in: path
9966           description: Value from executing hostname on the compute node.
9967           required: true
9968           type: string
9969           example: __HOSTNAME__
9970         - name: body
9971           in: body
9972           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
9973           required: true
9974           schema:
9975             $ref: "#/definitions/relationship"
9976     delete:
9977       tags:
9978         - CloudInfrastructure
9979       summary: delete an existing relationship
9980       description: delete an existing relationship
9981       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
9982       consumes:
9983         - application/json
9984         - application/xml
9985       produces:
9986         - application/json
9987         - application/xml
9988       responses:
9989         "default":
9990           description: Response codes found in [response codes](https://wiki.onap.org/).
9991       parameters:
9992         - name: hostname
9993           in: path
9994           description: Value from executing hostname on the compute node.
9995           required: true
9996           type: string
9997           example: __HOSTNAME__
9998   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
9999     put:
10000       tags:
10001         - CloudInfrastructure
10002       summary: see node definition for valid relationships
10003       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
10004       consumes:
10005         - application/json
10006         - application/xml
10007       produces:
10008         - application/json
10009         - application/xml
10010       responses:
10011         "default":
10012           description: Response codes found in [response codes](https://wiki.onap.org/).
10013       parameters:
10014         - name: hostname
10015           in: path
10016           description: Value from executing hostname on the compute node.
10017           required: true
10018           type: string
10019           example: __HOSTNAME__
10020         - name: interface-name
10021           in: path
10022           description: Name that identifies the physical interface
10023           required: true
10024           type: string
10025           example: __INTERFACE-NAME__
10026         - name: body
10027           in: body
10028           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10029           required: true
10030           schema:
10031             $ref: "#/definitions/relationship"
10032     delete:
10033       tags:
10034         - CloudInfrastructure
10035       summary: delete an existing relationship
10036       description: delete an existing relationship
10037       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
10038       consumes:
10039         - application/json
10040         - application/xml
10041       produces:
10042         - application/json
10043         - application/xml
10044       responses:
10045         "default":
10046           description: Response codes found in [response codes](https://wiki.onap.org/).
10047       parameters:
10048         - name: hostname
10049           in: path
10050           description: Value from executing hostname on the compute node.
10051           required: true
10052           type: string
10053           example: __HOSTNAME__
10054         - name: interface-name
10055           in: path
10056           description: Name that identifies the physical interface
10057           required: true
10058           type: string
10059           example: __INTERFACE-NAME__
10060   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
10061     put:
10062       tags:
10063         - CloudInfrastructure
10064       summary: see node definition for valid relationships
10065       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
10066       consumes:
10067         - application/json
10068         - application/xml
10069       produces:
10070         - application/json
10071         - application/xml
10072       responses:
10073         "default":
10074           description: Response codes found in [response codes](https://wiki.onap.org/).
10075       parameters:
10076         - name: hostname
10077           in: path
10078           description: Value from executing hostname on the compute node.
10079           required: true
10080           type: string
10081           example: __HOSTNAME__
10082         - name: interface-name
10083           in: path
10084           description: Name that identifies the physical interface
10085           required: true
10086           type: string
10087           example: __INTERFACE-NAME__
10088         - name: pf-pci-id
10089           in: path
10090           description: Identifier for the sriov-pf
10091           required: true
10092           type: string
10093           example: __PF-PCI-ID__
10094         - name: body
10095           in: body
10096           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
10097           required: true
10098           schema:
10099             $ref: "#/definitions/relationship"
10100     delete:
10101       tags:
10102         - CloudInfrastructure
10103       summary: delete an existing relationship
10104       description: delete an existing relationship
10105       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
10106       consumes:
10107         - application/json
10108         - application/xml
10109       produces:
10110         - application/json
10111         - application/xml
10112       responses:
10113         "default":
10114           description: Response codes found in [response codes](https://wiki.onap.org/).
10115       parameters:
10116         - name: hostname
10117           in: path
10118           description: Value from executing hostname on the compute node.
10119           required: true
10120           type: string
10121           example: __HOSTNAME__
10122         - name: interface-name
10123           in: path
10124           description: Name that identifies the physical interface
10125           required: true
10126           type: string
10127           example: __INTERFACE-NAME__
10128         - name: pf-pci-id
10129           in: path
10130           description: Identifier for the sriov-pf
10131           required: true
10132           type: string
10133           example: __PF-PCI-ID__
10134   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
10135     get:
10136       tags:
10137         - CloudInfrastructure
10138       summary: returns sriov-pf
10139       description: returns sriov-pf
10140       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
10141       produces:
10142         - application/json
10143         - application/xml
10144       responses:
10145         "200":
10146           description: successful operation
10147           schema:
10148               $ref: "#/getDefinitions/sriov-pf"
10149         "default":
10150           description: Response codes found in [response codes](https://wiki.onap.org/).
10151       parameters:
10152         - name: hostname
10153           in: path
10154           description: Value from executing hostname on the compute node.
10155           required: true
10156           type: string
10157           example: __HOSTNAME__
10158         - name: interface-name
10159           in: path
10160           description: Name that identifies the physical interface
10161           required: true
10162           type: string
10163           example: __INTERFACE-NAME__
10164         - name: pf-pci-id
10165           in: path
10166           description: Identifier for the sriov-pf
10167           required: true
10168           type: string
10169           example: __PF-PCI-ID__
10170         - name: inv-status
10171           in: query
10172           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10173           required: false
10174           type: string
10175         - name: pserver-id
10176           in: query
10177           description: ID of Pserver
10178           required: false
10179           type: string
10180         - name: in-maint
10181           in: query
10182           required: false
10183           type: boolean
10184         - name: pserver-name2
10185           in: query
10186           description: alternative pserver name
10187           required: false
10188           type: string
10189         - name: prov-status
10190           in: query
10191           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10192           required: false
10193           type: string
10194     put:
10195       tags:
10196         - CloudInfrastructure
10197       summary: create or update an existing sriov-pf
10198       description: |
10199         Create or update an existing sriov-pf.
10200         #
10201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10202       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
10203       consumes:
10204         - application/json
10205         - application/xml
10206       produces:
10207         - application/json
10208         - application/xml
10209       responses:
10210         "default":
10211           description: Response codes found in [response codes](https://wiki.onap.org/).
10212       parameters:
10213         - name: hostname
10214           in: path
10215           description: Value from executing hostname on the compute node.
10216           required: true
10217           type: string
10218           example: __HOSTNAME__
10219         - name: interface-name
10220           in: path
10221           description: Name that identifies the physical interface
10222           required: true
10223           type: string
10224           example: __INTERFACE-NAME__
10225         - name: pf-pci-id
10226           in: path
10227           description: Identifier for the sriov-pf
10228           required: true
10229           type: string
10230           example: __PF-PCI-ID__
10231         - name: body
10232           in: body
10233           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
10234           required: true
10235           schema:
10236             $ref: "#/definitions/sriov-pf"
10237     patch:
10238       tags:
10239         - CloudInfrastructure
10240       summary: update an existing sriov-pf
10241       description: |
10242         Update an existing sriov-pf
10243         #
10244         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10245         The PUT operation will entirely replace an existing object.
10246         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10247         #
10248         Other differences between PUT and PATCH are:
10249         #
10250         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10251         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10252         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10253       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
10254       consumes:
10255         - application/json
10256         - application/xml
10257       produces:
10258         - application/json
10259         - application/xml
10260       responses:
10261         "default":
10262           description: Response codes found in [response codes](https://wiki.onap.org/).
10263       parameters:
10264         - name: hostname
10265           in: path
10266           description: Value from executing hostname on the compute node.
10267           required: true
10268           type: string
10269           example: __HOSTNAME__
10270         - name: interface-name
10271           in: path
10272           description: Name that identifies the physical interface
10273           required: true
10274           type: string
10275           example: __INTERFACE-NAME__
10276         - name: pf-pci-id
10277           in: path
10278           description: Identifier for the sriov-pf
10279           required: true
10280           type: string
10281           example: __PF-PCI-ID__
10282         - name: body
10283           in: body
10284           description: sriov-pf object that needs to be created or updated.
10285           required: true
10286           schema:
10287             $ref: "#/patchDefinitions/sriov-pf"
10288     delete:
10289       tags:
10290         - CloudInfrastructure
10291       summary: delete an existing sriov-pf
10292       description: delete an existing sriov-pf
10293       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
10294       consumes:
10295         - application/json
10296         - application/xml
10297       produces:
10298         - application/json
10299         - application/xml
10300       responses:
10301         "default":
10302           description: Response codes found in [response codes](https://wiki.onap.org/).
10303       parameters:
10304         - name: hostname
10305           in: path
10306           description: Value from executing hostname on the compute node.
10307           required: true
10308           type: string
10309           example: __HOSTNAME__
10310         - name: interface-name
10311           in: path
10312           description: Name that identifies the physical interface
10313           required: true
10314           type: string
10315           example: __INTERFACE-NAME__
10316         - name: pf-pci-id
10317           in: path
10318           description: Identifier for the sriov-pf
10319           required: true
10320           type: string
10321           example: __PF-PCI-ID__
10322         - name: resource-version
10323           in: query
10324           description: resource-version for concurrency
10325           required: true
10326           type: string
10327   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
10328     get:
10329       tags:
10330         - CloudInfrastructure
10331       summary: returns sriov-pfs
10332       description: returns sriov-pfs
10333       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
10334       produces:
10335         - application/json
10336         - application/xml
10337       responses:
10338         "200":
10339           description: successful operation
10340           schema:
10341               $ref: "#/getDefinitions/sriov-pfs"
10342         "default":
10343           description: Response codes found in [response codes](https://wiki.onap.org/).
10344       parameters:
10345         - name: hostname
10346           in: path
10347           description: Value from executing hostname on the compute node.
10348           required: true
10349           type: string
10350           example: __HOSTNAME__
10351         - name: interface-name
10352           in: path
10353           description: Name that identifies the physical interface
10354           required: true
10355           type: string
10356           example: __INTERFACE-NAME__
10357         - name: inv-status
10358           in: query
10359           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10360           required: false
10361           type: string
10362         - name: pserver-id
10363           in: query
10364           description: ID of Pserver
10365           required: false
10366           type: string
10367         - name: in-maint
10368           in: query
10369           required: false
10370           type: boolean
10371         - name: pserver-name2
10372           in: query
10373           description: alternative pserver name
10374           required: false
10375           type: string
10376         - name: prov-status
10377           in: query
10378           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10379           required: false
10380           type: string
10381   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
10382     put:
10383       tags:
10384         - CloudInfrastructure
10385       summary: see node definition for valid relationships
10386       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10387       consumes:
10388         - application/json
10389         - application/xml
10390       produces:
10391         - application/json
10392         - application/xml
10393       responses:
10394         "default":
10395           description: Response codes found in [response codes](https://wiki.onap.org/).
10396       parameters:
10397         - name: hostname
10398           in: path
10399           description: Value from executing hostname on the compute node.
10400           required: true
10401           type: string
10402           example: __HOSTNAME__
10403         - name: interface-name
10404           in: path
10405           description: Name that identifies the physical interface
10406           required: true
10407           type: string
10408           example: __INTERFACE-NAME__
10409         - name: interface-name
10410           in: path
10411           description: Name given to the interface
10412           required: true
10413           type: string
10414           example: __INTERFACE-NAME__
10415         - name: vlan-interface
10416           in: path
10417           description: String that identifies the interface
10418           required: true
10419           type: string
10420           example: __VLAN-INTERFACE__
10421         - name: body
10422           in: body
10423           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10424           required: true
10425           schema:
10426             $ref: "#/definitions/relationship"
10427     delete:
10428       tags:
10429         - CloudInfrastructure
10430       summary: delete an existing relationship
10431       description: delete an existing relationship
10432       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10433       consumes:
10434         - application/json
10435         - application/xml
10436       produces:
10437         - application/json
10438         - application/xml
10439       responses:
10440         "default":
10441           description: Response codes found in [response codes](https://wiki.onap.org/).
10442       parameters:
10443         - name: hostname
10444           in: path
10445           description: Value from executing hostname on the compute node.
10446           required: true
10447           type: string
10448           example: __HOSTNAME__
10449         - name: interface-name
10450           in: path
10451           description: Name that identifies the physical interface
10452           required: true
10453           type: string
10454           example: __INTERFACE-NAME__
10455         - name: interface-name
10456           in: path
10457           description: Name given to the interface
10458           required: true
10459           type: string
10460           example: __INTERFACE-NAME__
10461         - name: vlan-interface
10462           in: path
10463           description: String that identifies the interface
10464           required: true
10465           type: string
10466           example: __VLAN-INTERFACE__
10467   /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:
10468     put:
10469       tags:
10470         - CloudInfrastructure
10471       summary: see node definition for valid relationships
10472       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10473       consumes:
10474         - application/json
10475         - application/xml
10476       produces:
10477         - application/json
10478         - application/xml
10479       responses:
10480         "default":
10481           description: Response codes found in [response codes](https://wiki.onap.org/).
10482       parameters:
10483         - name: hostname
10484           in: path
10485           description: Value from executing hostname on the compute node.
10486           required: true
10487           type: string
10488           example: __HOSTNAME__
10489         - name: interface-name
10490           in: path
10491           description: Name that identifies the physical interface
10492           required: true
10493           type: string
10494           example: __INTERFACE-NAME__
10495         - name: interface-name
10496           in: path
10497           description: Name given to the interface
10498           required: true
10499           type: string
10500           example: __INTERFACE-NAME__
10501         - name: vlan-interface
10502           in: path
10503           description: String that identifies the interface
10504           required: true
10505           type: string
10506           example: __VLAN-INTERFACE__
10507         - name: l3-interface-ipv4-address
10508           in: path
10509           description: IP address
10510           required: true
10511           type: string
10512           example: __L3-INTERFACE-IPV4-ADDRESS__
10513         - name: body
10514           in: body
10515           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
10516           required: true
10517           schema:
10518             $ref: "#/definitions/relationship"
10519     delete:
10520       tags:
10521         - CloudInfrastructure
10522       summary: delete an existing relationship
10523       description: delete an existing relationship
10524       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10525       consumes:
10526         - application/json
10527         - application/xml
10528       produces:
10529         - application/json
10530         - application/xml
10531       responses:
10532         "default":
10533           description: Response codes found in [response codes](https://wiki.onap.org/).
10534       parameters:
10535         - name: hostname
10536           in: path
10537           description: Value from executing hostname on the compute node.
10538           required: true
10539           type: string
10540           example: __HOSTNAME__
10541         - name: interface-name
10542           in: path
10543           description: Name that identifies the physical interface
10544           required: true
10545           type: string
10546           example: __INTERFACE-NAME__
10547         - name: interface-name
10548           in: path
10549           description: Name given to the interface
10550           required: true
10551           type: string
10552           example: __INTERFACE-NAME__
10553         - name: vlan-interface
10554           in: path
10555           description: String that identifies the interface
10556           required: true
10557           type: string
10558           example: __VLAN-INTERFACE__
10559         - name: l3-interface-ipv4-address
10560           in: path
10561           description: IP address
10562           required: true
10563           type: string
10564           example: __L3-INTERFACE-IPV4-ADDRESS__
10565   /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}:
10566     get:
10567       tags:
10568         - CloudInfrastructure
10569       summary: returns l3-interface-ipv4-address-list
10570       description: returns l3-interface-ipv4-address-list
10571       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10572       produces:
10573         - application/json
10574         - application/xml
10575       responses:
10576         "200":
10577           description: successful operation
10578           schema:
10579               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10580         "default":
10581           description: Response codes found in [response codes](https://wiki.onap.org/).
10582       parameters:
10583         - name: hostname
10584           in: path
10585           description: Value from executing hostname on the compute node.
10586           required: true
10587           type: string
10588           example: __HOSTNAME__
10589         - name: interface-name
10590           in: path
10591           description: Name that identifies the physical interface
10592           required: true
10593           type: string
10594           example: __INTERFACE-NAME__
10595         - name: interface-name
10596           in: path
10597           description: Name given to the interface
10598           required: true
10599           type: string
10600           example: __INTERFACE-NAME__
10601         - name: vlan-interface
10602           in: path
10603           description: String that identifies the interface
10604           required: true
10605           type: string
10606           example: __VLAN-INTERFACE__
10607         - name: l3-interface-ipv4-address
10608           in: path
10609           description: IP address
10610           required: true
10611           type: string
10612           example: __L3-INTERFACE-IPV4-ADDRESS__
10613         - name: inv-status
10614           in: query
10615           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10616           required: false
10617           type: string
10618         - name: pserver-id
10619           in: query
10620           description: ID of Pserver
10621           required: false
10622           type: string
10623         - name: in-maint
10624           in: query
10625           required: false
10626           type: boolean
10627         - name: pserver-name2
10628           in: query
10629           description: alternative pserver name
10630           required: false
10631           type: string
10632         - name: prov-status
10633           in: query
10634           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10635           required: false
10636           type: string
10637         - name: interface-id
10638           in: query
10639           description: ID of interface
10640           required: false
10641           type: string
10642         - name: macaddr
10643           in: query
10644           description: MAC address for the interface
10645           required: false
10646           type: string
10647         - name: network-name
10648           in: query
10649           description: Name of the network
10650           required: false
10651           type: string
10652         - name: vlan-id-inner
10653           in: query
10654           description: Inner VLAN tag
10655           required: false
10656           type: integer
10657           format: int64
10658         - name: vpn-key
10659           in: query
10660           description: This indicates the customers VPN ID associated with this vlan
10661           required: false
10662           type: string
10663         - name: vlan-id-inner
10664           in: query
10665           description: Inner VLAN tag
10666           required: false
10667           type: integer
10668           format: int64
10669         - name: neutron-network-id
10670           in: query
10671           description: Neutron network id of the interface that address belongs to
10672           required: false
10673           type: string
10674         - name: neutron-subnet-id
10675           in: query
10676           description: Neutron id of subnet that address belongs to
10677           required: false
10678           type: string
10679     put:
10680       tags:
10681         - CloudInfrastructure
10682       summary: create or update an existing l3-interface-ipv4-address-list
10683       description: |
10684         Create or update an existing l3-interface-ipv4-address-list.
10685         #
10686         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10687       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10688       consumes:
10689         - application/json
10690         - application/xml
10691       produces:
10692         - application/json
10693         - application/xml
10694       responses:
10695         "default":
10696           description: Response codes found in [response codes](https://wiki.onap.org/).
10697       parameters:
10698         - name: hostname
10699           in: path
10700           description: Value from executing hostname on the compute node.
10701           required: true
10702           type: string
10703           example: __HOSTNAME__
10704         - name: interface-name
10705           in: path
10706           description: Name that identifies the physical interface
10707           required: true
10708           type: string
10709           example: __INTERFACE-NAME__
10710         - name: interface-name
10711           in: path
10712           description: Name given to the interface
10713           required: true
10714           type: string
10715           example: __INTERFACE-NAME__
10716         - name: vlan-interface
10717           in: path
10718           description: String that identifies the interface
10719           required: true
10720           type: string
10721           example: __VLAN-INTERFACE__
10722         - name: l3-interface-ipv4-address
10723           in: path
10724           description: IP address
10725           required: true
10726           type: string
10727           example: __L3-INTERFACE-IPV4-ADDRESS__
10728         - name: body
10729           in: body
10730           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
10731           required: true
10732           schema:
10733             $ref: "#/definitions/l3-interface-ipv4-address-list"
10734     patch:
10735       tags:
10736         - CloudInfrastructure
10737       summary: update an existing l3-interface-ipv4-address-list
10738       description: |
10739         Update an existing l3-interface-ipv4-address-list
10740         #
10741         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10742         The PUT operation will entirely replace an existing object.
10743         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10744         #
10745         Other differences between PUT and PATCH are:
10746         #
10747         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10748         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10749         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10750       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10751       consumes:
10752         - application/json
10753         - application/xml
10754       produces:
10755         - application/json
10756         - application/xml
10757       responses:
10758         "default":
10759           description: Response codes found in [response codes](https://wiki.onap.org/).
10760       parameters:
10761         - name: hostname
10762           in: path
10763           description: Value from executing hostname on the compute node.
10764           required: true
10765           type: string
10766           example: __HOSTNAME__
10767         - name: interface-name
10768           in: path
10769           description: Name that identifies the physical interface
10770           required: true
10771           type: string
10772           example: __INTERFACE-NAME__
10773         - name: interface-name
10774           in: path
10775           description: Name given to the interface
10776           required: true
10777           type: string
10778           example: __INTERFACE-NAME__
10779         - name: vlan-interface
10780           in: path
10781           description: String that identifies the interface
10782           required: true
10783           type: string
10784           example: __VLAN-INTERFACE__
10785         - name: l3-interface-ipv4-address
10786           in: path
10787           description: IP address
10788           required: true
10789           type: string
10790           example: __L3-INTERFACE-IPV4-ADDRESS__
10791         - name: body
10792           in: body
10793           description: l3-interface-ipv4-address-list object that needs to be created or updated.
10794           required: true
10795           schema:
10796             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10797     delete:
10798       tags:
10799         - CloudInfrastructure
10800       summary: delete an existing l3-interface-ipv4-address-list
10801       description: delete an existing l3-interface-ipv4-address-list
10802       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10803       consumes:
10804         - application/json
10805         - application/xml
10806       produces:
10807         - application/json
10808         - application/xml
10809       responses:
10810         "default":
10811           description: Response codes found in [response codes](https://wiki.onap.org/).
10812       parameters:
10813         - name: hostname
10814           in: path
10815           description: Value from executing hostname on the compute node.
10816           required: true
10817           type: string
10818           example: __HOSTNAME__
10819         - name: interface-name
10820           in: path
10821           description: Name that identifies the physical interface
10822           required: true
10823           type: string
10824           example: __INTERFACE-NAME__
10825         - name: interface-name
10826           in: path
10827           description: Name given to the interface
10828           required: true
10829           type: string
10830           example: __INTERFACE-NAME__
10831         - name: vlan-interface
10832           in: path
10833           description: String that identifies the interface
10834           required: true
10835           type: string
10836           example: __VLAN-INTERFACE__
10837         - name: l3-interface-ipv4-address
10838           in: path
10839           description: IP address
10840           required: true
10841           type: string
10842           example: __L3-INTERFACE-IPV4-ADDRESS__
10843         - name: resource-version
10844           in: query
10845           description: resource-version for concurrency
10846           required: true
10847           type: string
10848   /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:
10849     put:
10850       tags:
10851         - CloudInfrastructure
10852       summary: see node definition for valid relationships
10853       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10854       consumes:
10855         - application/json
10856         - application/xml
10857       produces:
10858         - application/json
10859         - application/xml
10860       responses:
10861         "default":
10862           description: Response codes found in [response codes](https://wiki.onap.org/).
10863       parameters:
10864         - name: hostname
10865           in: path
10866           description: Value from executing hostname on the compute node.
10867           required: true
10868           type: string
10869           example: __HOSTNAME__
10870         - name: interface-name
10871           in: path
10872           description: Name that identifies the physical interface
10873           required: true
10874           type: string
10875           example: __INTERFACE-NAME__
10876         - name: interface-name
10877           in: path
10878           description: Name given to the interface
10879           required: true
10880           type: string
10881           example: __INTERFACE-NAME__
10882         - name: vlan-interface
10883           in: path
10884           description: String that identifies the interface
10885           required: true
10886           type: string
10887           example: __VLAN-INTERFACE__
10888         - name: l3-interface-ipv6-address
10889           in: path
10890           description: IP address
10891           required: true
10892           type: string
10893           example: __L3-INTERFACE-IPV6-ADDRESS__
10894         - name: body
10895           in: body
10896           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10897           required: true
10898           schema:
10899             $ref: "#/definitions/relationship"
10900     delete:
10901       tags:
10902         - CloudInfrastructure
10903       summary: delete an existing relationship
10904       description: delete an existing relationship
10905       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10906       consumes:
10907         - application/json
10908         - application/xml
10909       produces:
10910         - application/json
10911         - application/xml
10912       responses:
10913         "default":
10914           description: Response codes found in [response codes](https://wiki.onap.org/).
10915       parameters:
10916         - name: hostname
10917           in: path
10918           description: Value from executing hostname on the compute node.
10919           required: true
10920           type: string
10921           example: __HOSTNAME__
10922         - name: interface-name
10923           in: path
10924           description: Name that identifies the physical interface
10925           required: true
10926           type: string
10927           example: __INTERFACE-NAME__
10928         - name: interface-name
10929           in: path
10930           description: Name given to the interface
10931           required: true
10932           type: string
10933           example: __INTERFACE-NAME__
10934         - name: vlan-interface
10935           in: path
10936           description: String that identifies the interface
10937           required: true
10938           type: string
10939           example: __VLAN-INTERFACE__
10940         - name: l3-interface-ipv6-address
10941           in: path
10942           description: IP address
10943           required: true
10944           type: string
10945           example: __L3-INTERFACE-IPV6-ADDRESS__
10946   /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}:
10947     get:
10948       tags:
10949         - CloudInfrastructure
10950       summary: returns l3-interface-ipv6-address-list
10951       description: returns l3-interface-ipv6-address-list
10952       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10953       produces:
10954         - application/json
10955         - application/xml
10956       responses:
10957         "200":
10958           description: successful operation
10959           schema:
10960               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10961         "default":
10962           description: Response codes found in [response codes](https://wiki.onap.org/).
10963       parameters:
10964         - name: hostname
10965           in: path
10966           description: Value from executing hostname on the compute node.
10967           required: true
10968           type: string
10969           example: __HOSTNAME__
10970         - name: interface-name
10971           in: path
10972           description: Name that identifies the physical interface
10973           required: true
10974           type: string
10975           example: __INTERFACE-NAME__
10976         - name: interface-name
10977           in: path
10978           description: Name given to the interface
10979           required: true
10980           type: string
10981           example: __INTERFACE-NAME__
10982         - name: vlan-interface
10983           in: path
10984           description: String that identifies the interface
10985           required: true
10986           type: string
10987           example: __VLAN-INTERFACE__
10988         - name: l3-interface-ipv6-address
10989           in: path
10990           description: IP address
10991           required: true
10992           type: string
10993           example: __L3-INTERFACE-IPV6-ADDRESS__
10994         - name: inv-status
10995           in: query
10996           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10997           required: false
10998           type: string
10999         - name: pserver-id
11000           in: query
11001           description: ID of Pserver
11002           required: false
11003           type: string
11004         - name: in-maint
11005           in: query
11006           required: false
11007           type: boolean
11008         - name: pserver-name2
11009           in: query
11010           description: alternative pserver name
11011           required: false
11012           type: string
11013         - name: prov-status
11014           in: query
11015           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11016           required: false
11017           type: string
11018         - name: interface-id
11019           in: query
11020           description: ID of interface
11021           required: false
11022           type: string
11023         - name: macaddr
11024           in: query
11025           description: MAC address for the interface
11026           required: false
11027           type: string
11028         - name: network-name
11029           in: query
11030           description: Name of the network
11031           required: false
11032           type: string
11033         - name: vlan-id-inner
11034           in: query
11035           description: Inner VLAN tag
11036           required: false
11037           type: integer
11038           format: int64
11039         - name: vpn-key
11040           in: query
11041           description: This indicates the customers VPN ID associated with this vlan
11042           required: false
11043           type: string
11044         - name: vlan-id-inner
11045           in: query
11046           description: Inner VLAN tag
11047           required: false
11048           type: integer
11049           format: int64
11050         - name: neutron-network-id
11051           in: query
11052           description: Neutron network id of the interface that address belongs to
11053           required: false
11054           type: string
11055         - name: neutron-subnet-id
11056           in: query
11057           description: Neutron id of subnet that address belongs to
11058           required: false
11059           type: string
11060     put:
11061       tags:
11062         - CloudInfrastructure
11063       summary: create or update an existing l3-interface-ipv6-address-list
11064       description: |
11065         Create or update an existing l3-interface-ipv6-address-list.
11066         #
11067         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11068       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11069       consumes:
11070         - application/json
11071         - application/xml
11072       produces:
11073         - application/json
11074         - application/xml
11075       responses:
11076         "default":
11077           description: Response codes found in [response codes](https://wiki.onap.org/).
11078       parameters:
11079         - name: hostname
11080           in: path
11081           description: Value from executing hostname on the compute node.
11082           required: true
11083           type: string
11084           example: __HOSTNAME__
11085         - name: interface-name
11086           in: path
11087           description: Name that identifies the physical interface
11088           required: true
11089           type: string
11090           example: __INTERFACE-NAME__
11091         - name: interface-name
11092           in: path
11093           description: Name given to the interface
11094           required: true
11095           type: string
11096           example: __INTERFACE-NAME__
11097         - name: vlan-interface
11098           in: path
11099           description: String that identifies the interface
11100           required: true
11101           type: string
11102           example: __VLAN-INTERFACE__
11103         - name: l3-interface-ipv6-address
11104           in: path
11105           description: IP address
11106           required: true
11107           type: string
11108           example: __L3-INTERFACE-IPV6-ADDRESS__
11109         - name: body
11110           in: body
11111           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11112           required: true
11113           schema:
11114             $ref: "#/definitions/l3-interface-ipv6-address-list"
11115     patch:
11116       tags:
11117         - CloudInfrastructure
11118       summary: update an existing l3-interface-ipv6-address-list
11119       description: |
11120         Update an existing l3-interface-ipv6-address-list
11121         #
11122         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11123         The PUT operation will entirely replace an existing object.
11124         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11125         #
11126         Other differences between PUT and PATCH are:
11127         #
11128         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11129         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11130         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11131       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11132       consumes:
11133         - application/json
11134         - application/xml
11135       produces:
11136         - application/json
11137         - application/xml
11138       responses:
11139         "default":
11140           description: Response codes found in [response codes](https://wiki.onap.org/).
11141       parameters:
11142         - name: hostname
11143           in: path
11144           description: Value from executing hostname on the compute node.
11145           required: true
11146           type: string
11147           example: __HOSTNAME__
11148         - name: interface-name
11149           in: path
11150           description: Name that identifies the physical interface
11151           required: true
11152           type: string
11153           example: __INTERFACE-NAME__
11154         - name: interface-name
11155           in: path
11156           description: Name given to the interface
11157           required: true
11158           type: string
11159           example: __INTERFACE-NAME__
11160         - name: vlan-interface
11161           in: path
11162           description: String that identifies the interface
11163           required: true
11164           type: string
11165           example: __VLAN-INTERFACE__
11166         - name: l3-interface-ipv6-address
11167           in: path
11168           description: IP address
11169           required: true
11170           type: string
11171           example: __L3-INTERFACE-IPV6-ADDRESS__
11172         - name: body
11173           in: body
11174           description: l3-interface-ipv6-address-list object that needs to be created or updated.
11175           required: true
11176           schema:
11177             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11178     delete:
11179       tags:
11180         - CloudInfrastructure
11181       summary: delete an existing l3-interface-ipv6-address-list
11182       description: delete an existing l3-interface-ipv6-address-list
11183       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11184       consumes:
11185         - application/json
11186         - application/xml
11187       produces:
11188         - application/json
11189         - application/xml
11190       responses:
11191         "default":
11192           description: Response codes found in [response codes](https://wiki.onap.org/).
11193       parameters:
11194         - name: hostname
11195           in: path
11196           description: Value from executing hostname on the compute node.
11197           required: true
11198           type: string
11199           example: __HOSTNAME__
11200         - name: interface-name
11201           in: path
11202           description: Name that identifies the physical interface
11203           required: true
11204           type: string
11205           example: __INTERFACE-NAME__
11206         - name: interface-name
11207           in: path
11208           description: Name given to the interface
11209           required: true
11210           type: string
11211           example: __INTERFACE-NAME__
11212         - name: vlan-interface
11213           in: path
11214           description: String that identifies the interface
11215           required: true
11216           type: string
11217           example: __VLAN-INTERFACE__
11218         - name: l3-interface-ipv6-address
11219           in: path
11220           description: IP address
11221           required: true
11222           type: string
11223           example: __L3-INTERFACE-IPV6-ADDRESS__
11224         - name: resource-version
11225           in: query
11226           description: resource-version for concurrency
11227           required: true
11228           type: string
11229   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11230     get:
11231       tags:
11232         - CloudInfrastructure
11233       summary: returns vlan
11234       description: returns vlan
11235       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
11236       produces:
11237         - application/json
11238         - application/xml
11239       responses:
11240         "200":
11241           description: successful operation
11242           schema:
11243               $ref: "#/getDefinitions/vlan"
11244         "default":
11245           description: Response codes found in [response codes](https://wiki.onap.org/).
11246       parameters:
11247         - name: hostname
11248           in: path
11249           description: Value from executing hostname on the compute node.
11250           required: true
11251           type: string
11252           example: __HOSTNAME__
11253         - name: interface-name
11254           in: path
11255           description: Name that identifies the physical interface
11256           required: true
11257           type: string
11258           example: __INTERFACE-NAME__
11259         - name: interface-name
11260           in: path
11261           description: Name given to the interface
11262           required: true
11263           type: string
11264           example: __INTERFACE-NAME__
11265         - name: vlan-interface
11266           in: path
11267           description: String that identifies the interface
11268           required: true
11269           type: string
11270           example: __VLAN-INTERFACE__
11271         - name: inv-status
11272           in: query
11273           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11274           required: false
11275           type: string
11276         - name: pserver-id
11277           in: query
11278           description: ID of Pserver
11279           required: false
11280           type: string
11281         - name: in-maint
11282           in: query
11283           required: false
11284           type: boolean
11285         - name: pserver-name2
11286           in: query
11287           description: alternative pserver name
11288           required: false
11289           type: string
11290         - name: prov-status
11291           in: query
11292           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11293           required: false
11294           type: string
11295         - name: interface-id
11296           in: query
11297           description: ID of interface
11298           required: false
11299           type: string
11300         - name: macaddr
11301           in: query
11302           description: MAC address for the interface
11303           required: false
11304           type: string
11305         - name: network-name
11306           in: query
11307           description: Name of the network
11308           required: false
11309           type: string
11310         - name: vlan-id-inner
11311           in: query
11312           description: Inner VLAN tag
11313           required: false
11314           type: integer
11315           format: int64
11316         - name: vpn-key
11317           in: query
11318           description: This indicates the customers VPN ID associated with this vlan
11319           required: false
11320           type: string
11321     put:
11322       tags:
11323         - CloudInfrastructure
11324       summary: create or update an existing vlan
11325       description: |
11326         Create or update an existing vlan.
11327         #
11328         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11329       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
11330       consumes:
11331         - application/json
11332         - application/xml
11333       produces:
11334         - application/json
11335         - application/xml
11336       responses:
11337         "default":
11338           description: Response codes found in [response codes](https://wiki.onap.org/).
11339       parameters:
11340         - name: hostname
11341           in: path
11342           description: Value from executing hostname on the compute node.
11343           required: true
11344           type: string
11345           example: __HOSTNAME__
11346         - name: interface-name
11347           in: path
11348           description: Name that identifies the physical interface
11349           required: true
11350           type: string
11351           example: __INTERFACE-NAME__
11352         - name: interface-name
11353           in: path
11354           description: Name given to the interface
11355           required: true
11356           type: string
11357           example: __INTERFACE-NAME__
11358         - name: vlan-interface
11359           in: path
11360           description: String that identifies the interface
11361           required: true
11362           type: string
11363           example: __VLAN-INTERFACE__
11364         - name: body
11365           in: body
11366           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
11367           required: true
11368           schema:
11369             $ref: "#/definitions/vlan"
11370     patch:
11371       tags:
11372         - CloudInfrastructure
11373       summary: update an existing vlan
11374       description: |
11375         Update an existing vlan
11376         #
11377         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11378         The PUT operation will entirely replace an existing object.
11379         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11380         #
11381         Other differences between PUT and PATCH are:
11382         #
11383         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11384         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11385         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11386       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
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: vlan-interface
11416           in: path
11417           description: String that identifies the interface
11418           required: true
11419           type: string
11420           example: __VLAN-INTERFACE__
11421         - name: body
11422           in: body
11423           description: vlan object that needs to be created or updated.
11424           required: true
11425           schema:
11426             $ref: "#/patchDefinitions/vlan"
11427     delete:
11428       tags:
11429         - CloudInfrastructure
11430       summary: delete an existing vlan
11431       description: delete an existing vlan
11432       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
11433       consumes:
11434         - application/json
11435         - application/xml
11436       produces:
11437         - application/json
11438         - application/xml
11439       responses:
11440         "default":
11441           description: Response codes found in [response codes](https://wiki.onap.org/).
11442       parameters:
11443         - name: hostname
11444           in: path
11445           description: Value from executing hostname on the compute node.
11446           required: true
11447           type: string
11448           example: __HOSTNAME__
11449         - name: interface-name
11450           in: path
11451           description: Name that identifies the physical interface
11452           required: true
11453           type: string
11454           example: __INTERFACE-NAME__
11455         - name: interface-name
11456           in: path
11457           description: Name given to the interface
11458           required: true
11459           type: string
11460           example: __INTERFACE-NAME__
11461         - name: vlan-interface
11462           in: path
11463           description: String that identifies the interface
11464           required: true
11465           type: string
11466           example: __VLAN-INTERFACE__
11467         - name: resource-version
11468           in: query
11469           description: resource-version for concurrency
11470           required: true
11471           type: string
11472   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
11473     get:
11474       tags:
11475         - CloudInfrastructure
11476       summary: returns vlans
11477       description: returns vlans
11478       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
11479       produces:
11480         - application/json
11481         - application/xml
11482       responses:
11483         "200":
11484           description: successful operation
11485           schema:
11486               $ref: "#/getDefinitions/vlans"
11487         "default":
11488           description: Response codes found in [response codes](https://wiki.onap.org/).
11489       parameters:
11490         - name: hostname
11491           in: path
11492           description: Value from executing hostname on the compute node.
11493           required: true
11494           type: string
11495           example: __HOSTNAME__
11496         - name: interface-name
11497           in: path
11498           description: Name that identifies the physical interface
11499           required: true
11500           type: string
11501           example: __INTERFACE-NAME__
11502         - name: interface-name
11503           in: path
11504           description: Name given to the interface
11505           required: true
11506           type: string
11507           example: __INTERFACE-NAME__
11508         - name: inv-status
11509           in: query
11510           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11511           required: false
11512           type: string
11513         - name: pserver-id
11514           in: query
11515           description: ID of Pserver
11516           required: false
11517           type: string
11518         - name: in-maint
11519           in: query
11520           required: false
11521           type: boolean
11522         - name: pserver-name2
11523           in: query
11524           description: alternative pserver name
11525           required: false
11526           type: string
11527         - name: prov-status
11528           in: query
11529           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11530           required: false
11531           type: string
11532         - name: interface-id
11533           in: query
11534           description: ID of interface
11535           required: false
11536           type: string
11537         - name: macaddr
11538           in: query
11539           description: MAC address for the interface
11540           required: false
11541           type: string
11542         - name: network-name
11543           in: query
11544           description: Name of the network
11545           required: false
11546           type: string
11547   /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:
11548     put:
11549       tags:
11550         - CloudInfrastructure
11551       summary: see node definition for valid relationships
11552       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11553       consumes:
11554         - application/json
11555         - application/xml
11556       produces:
11557         - application/json
11558         - application/xml
11559       responses:
11560         "default":
11561           description: Response codes found in [response codes](https://wiki.onap.org/).
11562       parameters:
11563         - name: hostname
11564           in: path
11565           description: Value from executing hostname on the compute node.
11566           required: true
11567           type: string
11568           example: __HOSTNAME__
11569         - name: interface-name
11570           in: path
11571           description: Name that identifies the physical interface
11572           required: true
11573           type: string
11574           example: __INTERFACE-NAME__
11575         - name: interface-name
11576           in: path
11577           description: Name given to the interface
11578           required: true
11579           type: string
11580           example: __INTERFACE-NAME__
11581         - name: pci-id
11582           in: path
11583           description: PCI ID used to identify the sriov-vf
11584           required: true
11585           type: string
11586           example: __PCI-ID__
11587         - name: body
11588           in: body
11589           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11590           required: true
11591           schema:
11592             $ref: "#/definitions/relationship"
11593     delete:
11594       tags:
11595         - CloudInfrastructure
11596       summary: delete an existing relationship
11597       description: delete an existing relationship
11598       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11599       consumes:
11600         - application/json
11601         - application/xml
11602       produces:
11603         - application/json
11604         - application/xml
11605       responses:
11606         "default":
11607           description: Response codes found in [response codes](https://wiki.onap.org/).
11608       parameters:
11609         - name: hostname
11610           in: path
11611           description: Value from executing hostname on the compute node.
11612           required: true
11613           type: string
11614           example: __HOSTNAME__
11615         - name: interface-name
11616           in: path
11617           description: Name that identifies the physical interface
11618           required: true
11619           type: string
11620           example: __INTERFACE-NAME__
11621         - name: interface-name
11622           in: path
11623           description: Name given to the interface
11624           required: true
11625           type: string
11626           example: __INTERFACE-NAME__
11627         - name: pci-id
11628           in: path
11629           description: PCI ID used to identify the sriov-vf
11630           required: true
11631           type: string
11632           example: __PCI-ID__
11633   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
11634     get:
11635       tags:
11636         - CloudInfrastructure
11637       summary: returns sriov-vf
11638       description: returns sriov-vf
11639       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11640       produces:
11641         - application/json
11642         - application/xml
11643       responses:
11644         "200":
11645           description: successful operation
11646           schema:
11647               $ref: "#/getDefinitions/sriov-vf"
11648         "default":
11649           description: Response codes found in [response codes](https://wiki.onap.org/).
11650       parameters:
11651         - name: hostname
11652           in: path
11653           description: Value from executing hostname on the compute node.
11654           required: true
11655           type: string
11656           example: __HOSTNAME__
11657         - name: interface-name
11658           in: path
11659           description: Name that identifies the physical interface
11660           required: true
11661           type: string
11662           example: __INTERFACE-NAME__
11663         - name: interface-name
11664           in: path
11665           description: Name given to the interface
11666           required: true
11667           type: string
11668           example: __INTERFACE-NAME__
11669         - name: pci-id
11670           in: path
11671           description: PCI ID used to identify the sriov-vf
11672           required: true
11673           type: string
11674           example: __PCI-ID__
11675         - name: inv-status
11676           in: query
11677           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11678           required: false
11679           type: string
11680         - name: pserver-id
11681           in: query
11682           description: ID of Pserver
11683           required: false
11684           type: string
11685         - name: in-maint
11686           in: query
11687           required: false
11688           type: boolean
11689         - name: pserver-name2
11690           in: query
11691           description: alternative pserver name
11692           required: false
11693           type: string
11694         - name: prov-status
11695           in: query
11696           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11697           required: false
11698           type: string
11699         - name: interface-id
11700           in: query
11701           description: ID of interface
11702           required: false
11703           type: string
11704         - name: macaddr
11705           in: query
11706           description: MAC address for the interface
11707           required: false
11708           type: string
11709         - name: network-name
11710           in: query
11711           description: Name of the network
11712           required: false
11713           type: string
11714         - name: vf-vlan-filter
11715           in: query
11716           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
11717           required: false
11718           type: string
11719         - name: vf-mac-filter
11720           in: query
11721           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
11722           required: false
11723           type: string
11724         - name: vf-vlan-strip
11725           in: query
11726           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
11727           required: false
11728           type: boolean
11729         - name: neutron-network-id
11730           in: query
11731           description: Neutron network id of the interface
11732           required: false
11733           type: string
11734     put:
11735       tags:
11736         - CloudInfrastructure
11737       summary: create or update an existing sriov-vf
11738       description: |
11739         Create or update an existing sriov-vf.
11740         #
11741         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11742       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11743       consumes:
11744         - application/json
11745         - application/xml
11746       produces:
11747         - application/json
11748         - application/xml
11749       responses:
11750         "default":
11751           description: Response codes found in [response codes](https://wiki.onap.org/).
11752       parameters:
11753         - name: hostname
11754           in: path
11755           description: Value from executing hostname on the compute node.
11756           required: true
11757           type: string
11758           example: __HOSTNAME__
11759         - name: interface-name
11760           in: path
11761           description: Name that identifies the physical interface
11762           required: true
11763           type: string
11764           example: __INTERFACE-NAME__
11765         - name: interface-name
11766           in: path
11767           description: Name given to the interface
11768           required: true
11769           type: string
11770           example: __INTERFACE-NAME__
11771         - name: pci-id
11772           in: path
11773           description: PCI ID used to identify the sriov-vf
11774           required: true
11775           type: string
11776           example: __PCI-ID__
11777         - name: body
11778           in: body
11779           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11780           required: true
11781           schema:
11782             $ref: "#/definitions/sriov-vf"
11783     patch:
11784       tags:
11785         - CloudInfrastructure
11786       summary: update an existing sriov-vf
11787       description: |
11788         Update an existing sriov-vf
11789         #
11790         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11791         The PUT operation will entirely replace an existing object.
11792         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11793         #
11794         Other differences between PUT and PATCH are:
11795         #
11796         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11797         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11798         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11799       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11800       consumes:
11801         - application/json
11802         - application/xml
11803       produces:
11804         - application/json
11805         - application/xml
11806       responses:
11807         "default":
11808           description: Response codes found in [response codes](https://wiki.onap.org/).
11809       parameters:
11810         - name: hostname
11811           in: path
11812           description: Value from executing hostname on the compute node.
11813           required: true
11814           type: string
11815           example: __HOSTNAME__
11816         - name: interface-name
11817           in: path
11818           description: Name that identifies the physical interface
11819           required: true
11820           type: string
11821           example: __INTERFACE-NAME__
11822         - name: interface-name
11823           in: path
11824           description: Name given to the interface
11825           required: true
11826           type: string
11827           example: __INTERFACE-NAME__
11828         - name: pci-id
11829           in: path
11830           description: PCI ID used to identify the sriov-vf
11831           required: true
11832           type: string
11833           example: __PCI-ID__
11834         - name: body
11835           in: body
11836           description: sriov-vf object that needs to be created or updated.
11837           required: true
11838           schema:
11839             $ref: "#/patchDefinitions/sriov-vf"
11840     delete:
11841       tags:
11842         - CloudInfrastructure
11843       summary: delete an existing sriov-vf
11844       description: delete an existing sriov-vf
11845       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11846       consumes:
11847         - application/json
11848         - application/xml
11849       produces:
11850         - application/json
11851         - application/xml
11852       responses:
11853         "default":
11854           description: Response codes found in [response codes](https://wiki.onap.org/).
11855       parameters:
11856         - name: hostname
11857           in: path
11858           description: Value from executing hostname on the compute node.
11859           required: true
11860           type: string
11861           example: __HOSTNAME__
11862         - name: interface-name
11863           in: path
11864           description: Name that identifies the physical interface
11865           required: true
11866           type: string
11867           example: __INTERFACE-NAME__
11868         - name: interface-name
11869           in: path
11870           description: Name given to the interface
11871           required: true
11872           type: string
11873           example: __INTERFACE-NAME__
11874         - name: pci-id
11875           in: path
11876           description: PCI ID used to identify the sriov-vf
11877           required: true
11878           type: string
11879           example: __PCI-ID__
11880         - name: resource-version
11881           in: query
11882           description: resource-version for concurrency
11883           required: true
11884           type: string
11885   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
11886     get:
11887       tags:
11888         - CloudInfrastructure
11889       summary: returns sriov-vfs
11890       description: returns sriov-vfs
11891       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
11892       produces:
11893         - application/json
11894         - application/xml
11895       responses:
11896         "200":
11897           description: successful operation
11898           schema:
11899               $ref: "#/getDefinitions/sriov-vfs"
11900         "default":
11901           description: Response codes found in [response codes](https://wiki.onap.org/).
11902       parameters:
11903         - name: hostname
11904           in: path
11905           description: Value from executing hostname on the compute node.
11906           required: true
11907           type: string
11908           example: __HOSTNAME__
11909         - name: interface-name
11910           in: path
11911           description: Name that identifies the physical interface
11912           required: true
11913           type: string
11914           example: __INTERFACE-NAME__
11915         - name: interface-name
11916           in: path
11917           description: Name given to the interface
11918           required: true
11919           type: string
11920           example: __INTERFACE-NAME__
11921         - name: inv-status
11922           in: query
11923           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11924           required: false
11925           type: string
11926         - name: pserver-id
11927           in: query
11928           description: ID of Pserver
11929           required: false
11930           type: string
11931         - name: in-maint
11932           in: query
11933           required: false
11934           type: boolean
11935         - name: pserver-name2
11936           in: query
11937           description: alternative pserver name
11938           required: false
11939           type: string
11940         - name: prov-status
11941           in: query
11942           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11943           required: false
11944           type: string
11945         - name: interface-id
11946           in: query
11947           description: ID of interface
11948           required: false
11949           type: string
11950         - name: macaddr
11951           in: query
11952           description: MAC address for the interface
11953           required: false
11954           type: string
11955         - name: network-name
11956           in: query
11957           description: Name of the network
11958           required: false
11959           type: string
11960   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
11961     put:
11962       tags:
11963         - CloudInfrastructure
11964       summary: see node definition for valid relationships
11965       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
11966       consumes:
11967         - application/json
11968         - application/xml
11969       produces:
11970         - application/json
11971         - application/xml
11972       responses:
11973         "default":
11974           description: Response codes found in [response codes](https://wiki.onap.org/).
11975       parameters:
11976         - name: hostname
11977           in: path
11978           description: Value from executing hostname on the compute node.
11979           required: true
11980           type: string
11981           example: __HOSTNAME__
11982         - name: interface-name
11983           in: path
11984           description: Name that identifies the physical interface
11985           required: true
11986           type: string
11987           example: __INTERFACE-NAME__
11988         - name: interface-name
11989           in: path
11990           description: Name given to the interface
11991           required: true
11992           type: string
11993           example: __INTERFACE-NAME__
11994         - name: body
11995           in: body
11996           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11997           required: true
11998           schema:
11999             $ref: "#/definitions/relationship"
12000     delete:
12001       tags:
12002         - CloudInfrastructure
12003       summary: delete an existing relationship
12004       description: delete an existing relationship
12005       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
12006       consumes:
12007         - application/json
12008         - application/xml
12009       produces:
12010         - application/json
12011         - application/xml
12012       responses:
12013         "default":
12014           description: Response codes found in [response codes](https://wiki.onap.org/).
12015       parameters:
12016         - name: hostname
12017           in: path
12018           description: Value from executing hostname on the compute node.
12019           required: true
12020           type: string
12021           example: __HOSTNAME__
12022         - name: interface-name
12023           in: path
12024           description: Name that identifies the physical interface
12025           required: true
12026           type: string
12027           example: __INTERFACE-NAME__
12028         - name: interface-name
12029           in: path
12030           description: Name given to the interface
12031           required: true
12032           type: string
12033           example: __INTERFACE-NAME__
12034   /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:
12035     put:
12036       tags:
12037         - CloudInfrastructure
12038       summary: see node definition for valid relationships
12039       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12040       consumes:
12041         - application/json
12042         - application/xml
12043       produces:
12044         - application/json
12045         - application/xml
12046       responses:
12047         "default":
12048           description: Response codes found in [response codes](https://wiki.onap.org/).
12049       parameters:
12050         - name: hostname
12051           in: path
12052           description: Value from executing hostname on the compute node.
12053           required: true
12054           type: string
12055           example: __HOSTNAME__
12056         - name: interface-name
12057           in: path
12058           description: Name that identifies the physical interface
12059           required: true
12060           type: string
12061           example: __INTERFACE-NAME__
12062         - name: interface-name
12063           in: path
12064           description: Name given to the interface
12065           required: true
12066           type: string
12067           example: __INTERFACE-NAME__
12068         - name: l3-interface-ipv4-address
12069           in: path
12070           description: IP address
12071           required: true
12072           type: string
12073           example: __L3-INTERFACE-IPV4-ADDRESS__
12074         - name: body
12075           in: body
12076           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12077           required: true
12078           schema:
12079             $ref: "#/definitions/relationship"
12080     delete:
12081       tags:
12082         - CloudInfrastructure
12083       summary: delete an existing relationship
12084       description: delete an existing relationship
12085       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12086       consumes:
12087         - application/json
12088         - application/xml
12089       produces:
12090         - application/json
12091         - application/xml
12092       responses:
12093         "default":
12094           description: Response codes found in [response codes](https://wiki.onap.org/).
12095       parameters:
12096         - name: hostname
12097           in: path
12098           description: Value from executing hostname on the compute node.
12099           required: true
12100           type: string
12101           example: __HOSTNAME__
12102         - name: interface-name
12103           in: path
12104           description: Name that identifies the physical interface
12105           required: true
12106           type: string
12107           example: __INTERFACE-NAME__
12108         - name: interface-name
12109           in: path
12110           description: Name given to the interface
12111           required: true
12112           type: string
12113           example: __INTERFACE-NAME__
12114         - name: l3-interface-ipv4-address
12115           in: path
12116           description: IP address
12117           required: true
12118           type: string
12119           example: __L3-INTERFACE-IPV4-ADDRESS__
12120   /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}:
12121     get:
12122       tags:
12123         - CloudInfrastructure
12124       summary: returns l3-interface-ipv4-address-list
12125       description: returns l3-interface-ipv4-address-list
12126       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12127       produces:
12128         - application/json
12129         - application/xml
12130       responses:
12131         "200":
12132           description: successful operation
12133           schema:
12134               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12135         "default":
12136           description: Response codes found in [response codes](https://wiki.onap.org/).
12137       parameters:
12138         - name: hostname
12139           in: path
12140           description: Value from executing hostname on the compute node.
12141           required: true
12142           type: string
12143           example: __HOSTNAME__
12144         - name: interface-name
12145           in: path
12146           description: Name that identifies the physical interface
12147           required: true
12148           type: string
12149           example: __INTERFACE-NAME__
12150         - name: interface-name
12151           in: path
12152           description: Name given to the interface
12153           required: true
12154           type: string
12155           example: __INTERFACE-NAME__
12156         - name: l3-interface-ipv4-address
12157           in: path
12158           description: IP address
12159           required: true
12160           type: string
12161           example: __L3-INTERFACE-IPV4-ADDRESS__
12162         - name: inv-status
12163           in: query
12164           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12165           required: false
12166           type: string
12167         - name: pserver-id
12168           in: query
12169           description: ID of Pserver
12170           required: false
12171           type: string
12172         - name: in-maint
12173           in: query
12174           required: false
12175           type: boolean
12176         - name: pserver-name2
12177           in: query
12178           description: alternative pserver name
12179           required: false
12180           type: string
12181         - name: prov-status
12182           in: query
12183           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12184           required: false
12185           type: string
12186         - name: interface-id
12187           in: query
12188           description: ID of interface
12189           required: false
12190           type: string
12191         - name: macaddr
12192           in: query
12193           description: MAC address for the interface
12194           required: false
12195           type: string
12196         - name: network-name
12197           in: query
12198           description: Name of the network
12199           required: false
12200           type: string
12201         - name: vlan-id-inner
12202           in: query
12203           description: Inner VLAN tag
12204           required: false
12205           type: integer
12206           format: int64
12207         - name: neutron-network-id
12208           in: query
12209           description: Neutron network id of the interface that address belongs to
12210           required: false
12211           type: string
12212         - name: neutron-subnet-id
12213           in: query
12214           description: Neutron id of subnet that address belongs to
12215           required: false
12216           type: string
12217     put:
12218       tags:
12219         - CloudInfrastructure
12220       summary: create or update an existing l3-interface-ipv4-address-list
12221       description: |
12222         Create or update an existing l3-interface-ipv4-address-list.
12223         #
12224         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12225       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12226       consumes:
12227         - application/json
12228         - application/xml
12229       produces:
12230         - application/json
12231         - application/xml
12232       responses:
12233         "default":
12234           description: Response codes found in [response codes](https://wiki.onap.org/).
12235       parameters:
12236         - name: hostname
12237           in: path
12238           description: Value from executing hostname on the compute node.
12239           required: true
12240           type: string
12241           example: __HOSTNAME__
12242         - name: interface-name
12243           in: path
12244           description: Name that identifies the physical interface
12245           required: true
12246           type: string
12247           example: __INTERFACE-NAME__
12248         - name: interface-name
12249           in: path
12250           description: Name given to the interface
12251           required: true
12252           type: string
12253           example: __INTERFACE-NAME__
12254         - name: l3-interface-ipv4-address
12255           in: path
12256           description: IP address
12257           required: true
12258           type: string
12259           example: __L3-INTERFACE-IPV4-ADDRESS__
12260         - name: body
12261           in: body
12262           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12263           required: true
12264           schema:
12265             $ref: "#/definitions/l3-interface-ipv4-address-list"
12266     patch:
12267       tags:
12268         - CloudInfrastructure
12269       summary: update an existing l3-interface-ipv4-address-list
12270       description: |
12271         Update an existing l3-interface-ipv4-address-list
12272         #
12273         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12274         The PUT operation will entirely replace an existing object.
12275         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12276         #
12277         Other differences between PUT and PATCH are:
12278         #
12279         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12280         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12281         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12282       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12283       consumes:
12284         - application/json
12285         - application/xml
12286       produces:
12287         - application/json
12288         - application/xml
12289       responses:
12290         "default":
12291           description: Response codes found in [response codes](https://wiki.onap.org/).
12292       parameters:
12293         - name: hostname
12294           in: path
12295           description: Value from executing hostname on the compute node.
12296           required: true
12297           type: string
12298           example: __HOSTNAME__
12299         - name: interface-name
12300           in: path
12301           description: Name that identifies the physical interface
12302           required: true
12303           type: string
12304           example: __INTERFACE-NAME__
12305         - name: interface-name
12306           in: path
12307           description: Name given to the interface
12308           required: true
12309           type: string
12310           example: __INTERFACE-NAME__
12311         - name: l3-interface-ipv4-address
12312           in: path
12313           description: IP address
12314           required: true
12315           type: string
12316           example: __L3-INTERFACE-IPV4-ADDRESS__
12317         - name: body
12318           in: body
12319           description: l3-interface-ipv4-address-list object that needs to be created or updated.
12320           required: true
12321           schema:
12322             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12323     delete:
12324       tags:
12325         - CloudInfrastructure
12326       summary: delete an existing l3-interface-ipv4-address-list
12327       description: delete an existing l3-interface-ipv4-address-list
12328       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12329       consumes:
12330         - application/json
12331         - application/xml
12332       produces:
12333         - application/json
12334         - application/xml
12335       responses:
12336         "default":
12337           description: Response codes found in [response codes](https://wiki.onap.org/).
12338       parameters:
12339         - name: hostname
12340           in: path
12341           description: Value from executing hostname on the compute node.
12342           required: true
12343           type: string
12344           example: __HOSTNAME__
12345         - name: interface-name
12346           in: path
12347           description: Name that identifies the physical interface
12348           required: true
12349           type: string
12350           example: __INTERFACE-NAME__
12351         - name: interface-name
12352           in: path
12353           description: Name given to the interface
12354           required: true
12355           type: string
12356           example: __INTERFACE-NAME__
12357         - name: l3-interface-ipv4-address
12358           in: path
12359           description: IP address
12360           required: true
12361           type: string
12362           example: __L3-INTERFACE-IPV4-ADDRESS__
12363         - name: resource-version
12364           in: query
12365           description: resource-version for concurrency
12366           required: true
12367           type: string
12368   /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:
12369     put:
12370       tags:
12371         - CloudInfrastructure
12372       summary: see node definition for valid relationships
12373       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12374       consumes:
12375         - application/json
12376         - application/xml
12377       produces:
12378         - application/json
12379         - application/xml
12380       responses:
12381         "default":
12382           description: Response codes found in [response codes](https://wiki.onap.org/).
12383       parameters:
12384         - name: hostname
12385           in: path
12386           description: Value from executing hostname on the compute node.
12387           required: true
12388           type: string
12389           example: __HOSTNAME__
12390         - name: interface-name
12391           in: path
12392           description: Name that identifies the physical interface
12393           required: true
12394           type: string
12395           example: __INTERFACE-NAME__
12396         - name: interface-name
12397           in: path
12398           description: Name given to the interface
12399           required: true
12400           type: string
12401           example: __INTERFACE-NAME__
12402         - name: l3-interface-ipv6-address
12403           in: path
12404           description: IP address
12405           required: true
12406           type: string
12407           example: __L3-INTERFACE-IPV6-ADDRESS__
12408         - name: body
12409           in: body
12410           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12411           required: true
12412           schema:
12413             $ref: "#/definitions/relationship"
12414     delete:
12415       tags:
12416         - CloudInfrastructure
12417       summary: delete an existing relationship
12418       description: delete an existing relationship
12419       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12420       consumes:
12421         - application/json
12422         - application/xml
12423       produces:
12424         - application/json
12425         - application/xml
12426       responses:
12427         "default":
12428           description: Response codes found in [response codes](https://wiki.onap.org/).
12429       parameters:
12430         - name: hostname
12431           in: path
12432           description: Value from executing hostname on the compute node.
12433           required: true
12434           type: string
12435           example: __HOSTNAME__
12436         - name: interface-name
12437           in: path
12438           description: Name that identifies the physical interface
12439           required: true
12440           type: string
12441           example: __INTERFACE-NAME__
12442         - name: interface-name
12443           in: path
12444           description: Name given to the interface
12445           required: true
12446           type: string
12447           example: __INTERFACE-NAME__
12448         - name: l3-interface-ipv6-address
12449           in: path
12450           description: IP address
12451           required: true
12452           type: string
12453           example: __L3-INTERFACE-IPV6-ADDRESS__
12454   /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}:
12455     get:
12456       tags:
12457         - CloudInfrastructure
12458       summary: returns l3-interface-ipv6-address-list
12459       description: returns l3-interface-ipv6-address-list
12460       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12461       produces:
12462         - application/json
12463         - application/xml
12464       responses:
12465         "200":
12466           description: successful operation
12467           schema:
12468               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12469         "default":
12470           description: Response codes found in [response codes](https://wiki.onap.org/).
12471       parameters:
12472         - name: hostname
12473           in: path
12474           description: Value from executing hostname on the compute node.
12475           required: true
12476           type: string
12477           example: __HOSTNAME__
12478         - name: interface-name
12479           in: path
12480           description: Name that identifies the physical interface
12481           required: true
12482           type: string
12483           example: __INTERFACE-NAME__
12484         - name: interface-name
12485           in: path
12486           description: Name given to the interface
12487           required: true
12488           type: string
12489           example: __INTERFACE-NAME__
12490         - name: l3-interface-ipv6-address
12491           in: path
12492           description: IP address
12493           required: true
12494           type: string
12495           example: __L3-INTERFACE-IPV6-ADDRESS__
12496         - name: inv-status
12497           in: query
12498           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12499           required: false
12500           type: string
12501         - name: pserver-id
12502           in: query
12503           description: ID of Pserver
12504           required: false
12505           type: string
12506         - name: in-maint
12507           in: query
12508           required: false
12509           type: boolean
12510         - name: pserver-name2
12511           in: query
12512           description: alternative pserver name
12513           required: false
12514           type: string
12515         - name: prov-status
12516           in: query
12517           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12518           required: false
12519           type: string
12520         - name: interface-id
12521           in: query
12522           description: ID of interface
12523           required: false
12524           type: string
12525         - name: macaddr
12526           in: query
12527           description: MAC address for the interface
12528           required: false
12529           type: string
12530         - name: network-name
12531           in: query
12532           description: Name of the network
12533           required: false
12534           type: string
12535         - name: vlan-id-inner
12536           in: query
12537           description: Inner VLAN tag
12538           required: false
12539           type: integer
12540           format: int64
12541         - name: neutron-network-id
12542           in: query
12543           description: Neutron network id of the interface that address belongs to
12544           required: false
12545           type: string
12546         - name: neutron-subnet-id
12547           in: query
12548           description: Neutron id of subnet that address belongs to
12549           required: false
12550           type: string
12551     put:
12552       tags:
12553         - CloudInfrastructure
12554       summary: create or update an existing l3-interface-ipv6-address-list
12555       description: |
12556         Create or update an existing l3-interface-ipv6-address-list.
12557         #
12558         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12559       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12560       consumes:
12561         - application/json
12562         - application/xml
12563       produces:
12564         - application/json
12565         - application/xml
12566       responses:
12567         "default":
12568           description: Response codes found in [response codes](https://wiki.onap.org/).
12569       parameters:
12570         - name: hostname
12571           in: path
12572           description: Value from executing hostname on the compute node.
12573           required: true
12574           type: string
12575           example: __HOSTNAME__
12576         - name: interface-name
12577           in: path
12578           description: Name that identifies the physical interface
12579           required: true
12580           type: string
12581           example: __INTERFACE-NAME__
12582         - name: interface-name
12583           in: path
12584           description: Name given to the interface
12585           required: true
12586           type: string
12587           example: __INTERFACE-NAME__
12588         - name: l3-interface-ipv6-address
12589           in: path
12590           description: IP address
12591           required: true
12592           type: string
12593           example: __L3-INTERFACE-IPV6-ADDRESS__
12594         - name: body
12595           in: body
12596           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12597           required: true
12598           schema:
12599             $ref: "#/definitions/l3-interface-ipv6-address-list"
12600     patch:
12601       tags:
12602         - CloudInfrastructure
12603       summary: update an existing l3-interface-ipv6-address-list
12604       description: |
12605         Update an existing l3-interface-ipv6-address-list
12606         #
12607         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12608         The PUT operation will entirely replace an existing object.
12609         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12610         #
12611         Other differences between PUT and PATCH are:
12612         #
12613         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12614         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12615         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12616       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12617       consumes:
12618         - application/json
12619         - application/xml
12620       produces:
12621         - application/json
12622         - application/xml
12623       responses:
12624         "default":
12625           description: Response codes found in [response codes](https://wiki.onap.org/).
12626       parameters:
12627         - name: hostname
12628           in: path
12629           description: Value from executing hostname on the compute node.
12630           required: true
12631           type: string
12632           example: __HOSTNAME__
12633         - name: interface-name
12634           in: path
12635           description: Name that identifies the physical interface
12636           required: true
12637           type: string
12638           example: __INTERFACE-NAME__
12639         - name: interface-name
12640           in: path
12641           description: Name given to the interface
12642           required: true
12643           type: string
12644           example: __INTERFACE-NAME__
12645         - name: l3-interface-ipv6-address
12646           in: path
12647           description: IP address
12648           required: true
12649           type: string
12650           example: __L3-INTERFACE-IPV6-ADDRESS__
12651         - name: body
12652           in: body
12653           description: l3-interface-ipv6-address-list object that needs to be created or updated.
12654           required: true
12655           schema:
12656             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12657     delete:
12658       tags:
12659         - CloudInfrastructure
12660       summary: delete an existing l3-interface-ipv6-address-list
12661       description: delete an existing l3-interface-ipv6-address-list
12662       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12663       consumes:
12664         - application/json
12665         - application/xml
12666       produces:
12667         - application/json
12668         - application/xml
12669       responses:
12670         "default":
12671           description: Response codes found in [response codes](https://wiki.onap.org/).
12672       parameters:
12673         - name: hostname
12674           in: path
12675           description: Value from executing hostname on the compute node.
12676           required: true
12677           type: string
12678           example: __HOSTNAME__
12679         - name: interface-name
12680           in: path
12681           description: Name that identifies the physical interface
12682           required: true
12683           type: string
12684           example: __INTERFACE-NAME__
12685         - name: interface-name
12686           in: path
12687           description: Name given to the interface
12688           required: true
12689           type: string
12690           example: __INTERFACE-NAME__
12691         - name: l3-interface-ipv6-address
12692           in: path
12693           description: IP address
12694           required: true
12695           type: string
12696           example: __L3-INTERFACE-IPV6-ADDRESS__
12697         - name: resource-version
12698           in: query
12699           description: resource-version for concurrency
12700           required: true
12701           type: string
12702   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
12703     get:
12704       tags:
12705         - CloudInfrastructure
12706       summary: returns l-interface
12707       description: returns l-interface
12708       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12709       produces:
12710         - application/json
12711         - application/xml
12712       responses:
12713         "200":
12714           description: successful operation
12715           schema:
12716               $ref: "#/getDefinitions/l-interface"
12717         "default":
12718           description: Response codes found in [response codes](https://wiki.onap.org/).
12719       parameters:
12720         - name: hostname
12721           in: path
12722           description: Value from executing hostname on the compute node.
12723           required: true
12724           type: string
12725           example: __HOSTNAME__
12726         - name: interface-name
12727           in: path
12728           description: Name that identifies the physical interface
12729           required: true
12730           type: string
12731           example: __INTERFACE-NAME__
12732         - name: interface-name
12733           in: path
12734           description: Name given to the interface
12735           required: true
12736           type: string
12737           example: __INTERFACE-NAME__
12738         - name: inv-status
12739           in: query
12740           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12741           required: false
12742           type: string
12743         - name: pserver-id
12744           in: query
12745           description: ID of Pserver
12746           required: false
12747           type: string
12748         - name: in-maint
12749           in: query
12750           required: false
12751           type: boolean
12752         - name: pserver-name2
12753           in: query
12754           description: alternative pserver name
12755           required: false
12756           type: string
12757         - name: prov-status
12758           in: query
12759           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12760           required: false
12761           type: string
12762         - name: interface-id
12763           in: query
12764           description: ID of interface
12765           required: false
12766           type: string
12767         - name: macaddr
12768           in: query
12769           description: MAC address for the interface
12770           required: false
12771           type: string
12772         - name: network-name
12773           in: query
12774           description: Name of the network
12775           required: false
12776           type: string
12777     put:
12778       tags:
12779         - CloudInfrastructure
12780       summary: create or update an existing l-interface
12781       description: |
12782         Create or update an existing l-interface.
12783         #
12784         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12785       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12786       consumes:
12787         - application/json
12788         - application/xml
12789       produces:
12790         - application/json
12791         - application/xml
12792       responses:
12793         "default":
12794           description: Response codes found in [response codes](https://wiki.onap.org/).
12795       parameters:
12796         - name: hostname
12797           in: path
12798           description: Value from executing hostname on the compute node.
12799           required: true
12800           type: string
12801           example: __HOSTNAME__
12802         - name: interface-name
12803           in: path
12804           description: Name that identifies the physical interface
12805           required: true
12806           type: string
12807           example: __INTERFACE-NAME__
12808         - name: interface-name
12809           in: path
12810           description: Name given to the interface
12811           required: true
12812           type: string
12813           example: __INTERFACE-NAME__
12814         - name: body
12815           in: body
12816           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
12817           required: true
12818           schema:
12819             $ref: "#/definitions/l-interface"
12820     patch:
12821       tags:
12822         - CloudInfrastructure
12823       summary: update an existing l-interface
12824       description: |
12825         Update an existing l-interface
12826         #
12827         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12828         The PUT operation will entirely replace an existing object.
12829         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12830         #
12831         Other differences between PUT and PATCH are:
12832         #
12833         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12834         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12835         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12836       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12837       consumes:
12838         - application/json
12839         - application/xml
12840       produces:
12841         - application/json
12842         - application/xml
12843       responses:
12844         "default":
12845           description: Response codes found in [response codes](https://wiki.onap.org/).
12846       parameters:
12847         - name: hostname
12848           in: path
12849           description: Value from executing hostname on the compute node.
12850           required: true
12851           type: string
12852           example: __HOSTNAME__
12853         - name: interface-name
12854           in: path
12855           description: Name that identifies the physical interface
12856           required: true
12857           type: string
12858           example: __INTERFACE-NAME__
12859         - name: interface-name
12860           in: path
12861           description: Name given to the interface
12862           required: true
12863           type: string
12864           example: __INTERFACE-NAME__
12865         - name: body
12866           in: body
12867           description: l-interface object that needs to be created or updated.
12868           required: true
12869           schema:
12870             $ref: "#/patchDefinitions/l-interface"
12871     delete:
12872       tags:
12873         - CloudInfrastructure
12874       summary: delete an existing l-interface
12875       description: delete an existing l-interface
12876       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12877       consumes:
12878         - application/json
12879         - application/xml
12880       produces:
12881         - application/json
12882         - application/xml
12883       responses:
12884         "default":
12885           description: Response codes found in [response codes](https://wiki.onap.org/).
12886       parameters:
12887         - name: hostname
12888           in: path
12889           description: Value from executing hostname on the compute node.
12890           required: true
12891           type: string
12892           example: __HOSTNAME__
12893         - name: interface-name
12894           in: path
12895           description: Name that identifies the physical interface
12896           required: true
12897           type: string
12898           example: __INTERFACE-NAME__
12899         - name: interface-name
12900           in: path
12901           description: Name given to the interface
12902           required: true
12903           type: string
12904           example: __INTERFACE-NAME__
12905         - name: resource-version
12906           in: query
12907           description: resource-version for concurrency
12908           required: true
12909           type: string
12910   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
12911     get:
12912       tags:
12913         - CloudInfrastructure
12914       summary: returns l-interfaces
12915       description: returns l-interfaces
12916       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
12917       produces:
12918         - application/json
12919         - application/xml
12920       responses:
12921         "200":
12922           description: successful operation
12923           schema:
12924               $ref: "#/getDefinitions/l-interfaces"
12925         "default":
12926           description: Response codes found in [response codes](https://wiki.onap.org/).
12927       parameters:
12928         - name: hostname
12929           in: path
12930           description: Value from executing hostname on the compute node.
12931           required: true
12932           type: string
12933           example: __HOSTNAME__
12934         - name: interface-name
12935           in: path
12936           description: Name that identifies the physical interface
12937           required: true
12938           type: string
12939           example: __INTERFACE-NAME__
12940         - name: inv-status
12941           in: query
12942           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12943           required: false
12944           type: string
12945         - name: pserver-id
12946           in: query
12947           description: ID of Pserver
12948           required: false
12949           type: string
12950         - name: in-maint
12951           in: query
12952           required: false
12953           type: boolean
12954         - name: pserver-name2
12955           in: query
12956           description: alternative pserver name
12957           required: false
12958           type: string
12959         - name: prov-status
12960           in: query
12961           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12962           required: false
12963           type: string
12964   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
12965     get:
12966       tags:
12967         - CloudInfrastructure
12968       summary: returns p-interface
12969       description: returns p-interface
12970       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
12971       produces:
12972         - application/json
12973         - application/xml
12974       responses:
12975         "200":
12976           description: successful operation
12977           schema:
12978               $ref: "#/getDefinitions/p-interface"
12979         "default":
12980           description: Response codes found in [response codes](https://wiki.onap.org/).
12981       parameters:
12982         - name: hostname
12983           in: path
12984           description: Value from executing hostname on the compute node.
12985           required: true
12986           type: string
12987           example: __HOSTNAME__
12988         - name: interface-name
12989           in: path
12990           description: Name that identifies the physical interface
12991           required: true
12992           type: string
12993           example: __INTERFACE-NAME__
12994         - name: inv-status
12995           in: query
12996           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12997           required: false
12998           type: string
12999         - name: pserver-id
13000           in: query
13001           description: ID of Pserver
13002           required: false
13003           type: string
13004         - name: in-maint
13005           in: query
13006           required: false
13007           type: boolean
13008         - name: pserver-name2
13009           in: query
13010           description: alternative pserver name
13011           required: false
13012           type: string
13013         - name: prov-status
13014           in: query
13015           description: Trigger for operational monitoring of this resource by Service Assurance systems.
13016           required: false
13017           type: string
13018     put:
13019       tags:
13020         - CloudInfrastructure
13021       summary: create or update an existing p-interface
13022       description: |
13023         Create or update an existing p-interface.
13024         #
13025         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13026       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
13027       consumes:
13028         - application/json
13029         - application/xml
13030       produces:
13031         - application/json
13032         - application/xml
13033       responses:
13034         "default":
13035           description: Response codes found in [response codes](https://wiki.onap.org/).
13036       parameters:
13037         - name: hostname
13038           in: path
13039           description: Value from executing hostname on the compute node.
13040           required: true
13041           type: string
13042           example: __HOSTNAME__
13043         - name: interface-name
13044           in: path
13045           description: Name that identifies the physical interface
13046           required: true
13047           type: string
13048           example: __INTERFACE-NAME__
13049         - name: body
13050           in: body
13051           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
13052           required: true
13053           schema:
13054             $ref: "#/definitions/p-interface"
13055     patch:
13056       tags:
13057         - CloudInfrastructure
13058       summary: update an existing p-interface
13059       description: |
13060         Update an existing p-interface
13061         #
13062         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13063         The PUT operation will entirely replace an existing object.
13064         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13065         #
13066         Other differences between PUT and PATCH are:
13067         #
13068         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13069         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13070         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13071       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
13072       consumes:
13073         - application/json
13074         - application/xml
13075       produces:
13076         - application/json
13077         - application/xml
13078       responses:
13079         "default":
13080           description: Response codes found in [response codes](https://wiki.onap.org/).
13081       parameters:
13082         - name: hostname
13083           in: path
13084           description: Value from executing hostname on the compute node.
13085           required: true
13086           type: string
13087           example: __HOSTNAME__
13088         - name: interface-name
13089           in: path
13090           description: Name that identifies the physical interface
13091           required: true
13092           type: string
13093           example: __INTERFACE-NAME__
13094         - name: body
13095           in: body
13096           description: p-interface object that needs to be created or updated.
13097           required: true
13098           schema:
13099             $ref: "#/patchDefinitions/p-interface"
13100     delete:
13101       tags:
13102         - CloudInfrastructure
13103       summary: delete an existing p-interface
13104       description: delete an existing p-interface
13105       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
13106       consumes:
13107         - application/json
13108         - application/xml
13109       produces:
13110         - application/json
13111         - application/xml
13112       responses:
13113         "default":
13114           description: Response codes found in [response codes](https://wiki.onap.org/).
13115       parameters:
13116         - name: hostname
13117           in: path
13118           description: Value from executing hostname on the compute node.
13119           required: true
13120           type: string
13121           example: __HOSTNAME__
13122         - name: interface-name
13123           in: path
13124           description: Name that identifies the physical interface
13125           required: true
13126           type: string
13127           example: __INTERFACE-NAME__
13128         - name: resource-version
13129           in: query
13130           description: resource-version for concurrency
13131           required: true
13132           type: string
13133   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
13134     get:
13135       tags:
13136         - CloudInfrastructure
13137       summary: returns p-interfaces
13138       description: returns p-interfaces
13139       operationId: getCloudInfrastructurePserversPserverPInterfaces
13140       produces:
13141         - application/json
13142         - application/xml
13143       responses:
13144         "200":
13145           description: successful operation
13146           schema:
13147               $ref: "#/getDefinitions/p-interfaces"
13148         "default":
13149           description: Response codes found in [response codes](https://wiki.onap.org/).
13150       parameters:
13151         - name: hostname
13152           in: path
13153           description: Value from executing hostname on the compute node.
13154           required: true
13155           type: string
13156           example: __HOSTNAME__
13157         - name: inv-status
13158           in: query
13159           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13160           required: false
13161           type: string
13162         - name: pserver-id
13163           in: query
13164           description: ID of Pserver
13165           required: false
13166           type: string
13167         - name: in-maint
13168           in: query
13169           required: false
13170           type: boolean
13171         - name: pserver-name2
13172           in: query
13173           description: alternative pserver name
13174           required: false
13175           type: string
13176   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
13177     put:
13178       tags:
13179         - CloudInfrastructure
13180       summary: see node definition for valid relationships
13181       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
13182       consumes:
13183         - application/json
13184         - application/xml
13185       produces:
13186         - application/json
13187         - application/xml
13188       responses:
13189         "default":
13190           description: Response codes found in [response codes](https://wiki.onap.org/).
13191       parameters:
13192         - name: hostname
13193           in: path
13194           description: Value from executing hostname on the compute node.
13195           required: true
13196           type: string
13197           example: __HOSTNAME__
13198         - name: interface-name
13199           in: path
13200           description: Name that identifies the link aggregate interface
13201           required: true
13202           type: string
13203           example: __INTERFACE-NAME__
13204         - name: body
13205           in: body
13206           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13207           required: true
13208           schema:
13209             $ref: "#/definitions/relationship"
13210     delete:
13211       tags:
13212         - CloudInfrastructure
13213       summary: delete an existing relationship
13214       description: delete an existing relationship
13215       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
13216       consumes:
13217         - application/json
13218         - application/xml
13219       produces:
13220         - application/json
13221         - application/xml
13222       responses:
13223         "default":
13224           description: Response codes found in [response codes](https://wiki.onap.org/).
13225       parameters:
13226         - name: hostname
13227           in: path
13228           description: Value from executing hostname on the compute node.
13229           required: true
13230           type: string
13231           example: __HOSTNAME__
13232         - name: interface-name
13233           in: path
13234           description: Name that identifies the link aggregate interface
13235           required: true
13236           type: string
13237           example: __INTERFACE-NAME__
13238   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
13239     put:
13240       tags:
13241         - CloudInfrastructure
13242       summary: see node definition for valid relationships
13243       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
13244       consumes:
13245         - application/json
13246         - application/xml
13247       produces:
13248         - application/json
13249         - application/xml
13250       responses:
13251         "default":
13252           description: Response codes found in [response codes](https://wiki.onap.org/).
13253       parameters:
13254         - name: hostname
13255           in: path
13256           description: Value from executing hostname on the compute node.
13257           required: true
13258           type: string
13259           example: __HOSTNAME__
13260         - name: interface-name
13261           in: path
13262           description: Name that identifies the link aggregate interface
13263           required: true
13264           type: string
13265           example: __INTERFACE-NAME__
13266         - name: interface-name
13267           in: path
13268           description: Name given to the interface
13269           required: true
13270           type: string
13271           example: __INTERFACE-NAME__
13272         - name: vlan-interface
13273           in: path
13274           description: String that identifies the interface
13275           required: true
13276           type: string
13277           example: __VLAN-INTERFACE__
13278         - name: body
13279           in: body
13280           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
13281           required: true
13282           schema:
13283             $ref: "#/definitions/relationship"
13284     delete:
13285       tags:
13286         - CloudInfrastructure
13287       summary: delete an existing relationship
13288       description: delete an existing relationship
13289       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
13290       consumes:
13291         - application/json
13292         - application/xml
13293       produces:
13294         - application/json
13295         - application/xml
13296       responses:
13297         "default":
13298           description: Response codes found in [response codes](https://wiki.onap.org/).
13299       parameters:
13300         - name: hostname
13301           in: path
13302           description: Value from executing hostname on the compute node.
13303           required: true
13304           type: string
13305           example: __HOSTNAME__
13306         - name: interface-name
13307           in: path
13308           description: Name that identifies the link aggregate interface
13309           required: true
13310           type: string
13311           example: __INTERFACE-NAME__
13312         - name: interface-name
13313           in: path
13314           description: Name given to the interface
13315           required: true
13316           type: string
13317           example: __INTERFACE-NAME__
13318         - name: vlan-interface
13319           in: path
13320           description: String that identifies the interface
13321           required: true
13322           type: string
13323           example: __VLAN-INTERFACE__
13324   /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:
13325     put:
13326       tags:
13327         - CloudInfrastructure
13328       summary: see node definition for valid relationships
13329       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
13330       consumes:
13331         - application/json
13332         - application/xml
13333       produces:
13334         - application/json
13335         - application/xml
13336       responses:
13337         "default":
13338           description: Response codes found in [response codes](https://wiki.onap.org/).
13339       parameters:
13340         - name: hostname
13341           in: path
13342           description: Value from executing hostname on the compute node.
13343           required: true
13344           type: string
13345           example: __HOSTNAME__
13346         - name: interface-name
13347           in: path
13348           description: Name that identifies the link aggregate interface
13349           required: true
13350           type: string
13351           example: __INTERFACE-NAME__
13352         - name: interface-name
13353           in: path
13354           description: Name given to the interface
13355           required: true
13356           type: string
13357           example: __INTERFACE-NAME__
13358         - name: vlan-interface
13359           in: path
13360           description: String that identifies the interface
13361           required: true
13362           type: string
13363           example: __VLAN-INTERFACE__
13364         - name: l3-interface-ipv4-address
13365           in: path
13366           description: IP address
13367           required: true
13368           type: string
13369           example: __L3-INTERFACE-IPV4-ADDRESS__
13370         - name: body
13371           in: body
13372           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
13373           required: true
13374           schema:
13375             $ref: "#/definitions/relationship"
13376     delete:
13377       tags:
13378         - CloudInfrastructure
13379       summary: delete an existing relationship
13380       description: delete an existing relationship
13381       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
13382       consumes:
13383         - application/json
13384         - application/xml
13385       produces:
13386         - application/json
13387         - application/xml
13388       responses:
13389         "default":
13390           description: Response codes found in [response codes](https://wiki.onap.org/).
13391       parameters:
13392         - name: hostname
13393           in: path
13394           description: Value from executing hostname on the compute node.
13395           required: true
13396           type: string
13397           example: __HOSTNAME__
13398         - name: interface-name
13399           in: path
13400           description: Name that identifies the link aggregate interface
13401           required: true
13402           type: string
13403           example: __INTERFACE-NAME__
13404         - name: interface-name
13405           in: path
13406           description: Name given to the interface
13407           required: true
13408           type: string
13409           example: __INTERFACE-NAME__
13410         - name: vlan-interface
13411           in: path
13412           description: String that identifies the interface
13413           required: true
13414           type: string
13415           example: __VLAN-INTERFACE__
13416         - name: l3-interface-ipv4-address
13417           in: path
13418           description: IP address
13419           required: true
13420           type: string
13421           example: __L3-INTERFACE-IPV4-ADDRESS__
13422   /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}:
13423     get:
13424       tags:
13425         - CloudInfrastructure
13426       summary: returns l3-interface-ipv4-address-list
13427       description: returns l3-interface-ipv4-address-list
13428       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13429       produces:
13430         - application/json
13431         - application/xml
13432       responses:
13433         "200":
13434           description: successful operation
13435           schema:
13436               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13437         "default":
13438           description: Response codes found in [response codes](https://wiki.onap.org/).
13439       parameters:
13440         - name: hostname
13441           in: path
13442           description: Value from executing hostname on the compute node.
13443           required: true
13444           type: string
13445           example: __HOSTNAME__
13446         - name: interface-name
13447           in: path
13448           description: Name that identifies the link aggregate interface
13449           required: true
13450           type: string
13451           example: __INTERFACE-NAME__
13452         - name: interface-name
13453           in: path
13454           description: Name given to the interface
13455           required: true
13456           type: string
13457           example: __INTERFACE-NAME__
13458         - name: vlan-interface
13459           in: path
13460           description: String that identifies the interface
13461           required: true
13462           type: string
13463           example: __VLAN-INTERFACE__
13464         - name: l3-interface-ipv4-address
13465           in: path
13466           description: IP address
13467           required: true
13468           type: string
13469           example: __L3-INTERFACE-IPV4-ADDRESS__
13470         - name: inv-status
13471           in: query
13472           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13473           required: false
13474           type: string
13475         - name: pserver-id
13476           in: query
13477           description: ID of Pserver
13478           required: false
13479           type: string
13480         - name: in-maint
13481           in: query
13482           required: false
13483           type: boolean
13484         - name: pserver-name2
13485           in: query
13486           description: alternative pserver name
13487           required: false
13488           type: string
13489         - name: interface-id
13490           in: query
13491           description: ID of interface
13492           required: false
13493           type: string
13494         - name: interface-role
13495           in: query
13496           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13497           required: false
13498           type: string
13499         - name: interface-id
13500           in: query
13501           description: ID of interface
13502           required: false
13503           type: string
13504         - name: macaddr
13505           in: query
13506           description: MAC address for the interface
13507           required: false
13508           type: string
13509         - name: network-name
13510           in: query
13511           description: Name of the network
13512           required: false
13513           type: string
13514         - name: vlan-id-inner
13515           in: query
13516           description: Inner VLAN tag
13517           required: false
13518           type: integer
13519           format: int64
13520         - name: vpn-key
13521           in: query
13522           description: This indicates the customers VPN ID associated with this vlan
13523           required: false
13524           type: string
13525         - name: vlan-id-inner
13526           in: query
13527           description: Inner VLAN tag
13528           required: false
13529           type: integer
13530           format: int64
13531         - name: neutron-network-id
13532           in: query
13533           description: Neutron network id of the interface that address belongs to
13534           required: false
13535           type: string
13536         - name: neutron-subnet-id
13537           in: query
13538           description: Neutron id of subnet that address belongs to
13539           required: false
13540           type: string
13541     put:
13542       tags:
13543         - CloudInfrastructure
13544       summary: create or update an existing l3-interface-ipv4-address-list
13545       description: |
13546         Create or update an existing l3-interface-ipv4-address-list.
13547         #
13548         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13549       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13550       consumes:
13551         - application/json
13552         - application/xml
13553       produces:
13554         - application/json
13555         - application/xml
13556       responses:
13557         "default":
13558           description: Response codes found in [response codes](https://wiki.onap.org/).
13559       parameters:
13560         - name: hostname
13561           in: path
13562           description: Value from executing hostname on the compute node.
13563           required: true
13564           type: string
13565           example: __HOSTNAME__
13566         - name: interface-name
13567           in: path
13568           description: Name that identifies the link aggregate interface
13569           required: true
13570           type: string
13571           example: __INTERFACE-NAME__
13572         - name: interface-name
13573           in: path
13574           description: Name given to the interface
13575           required: true
13576           type: string
13577           example: __INTERFACE-NAME__
13578         - name: vlan-interface
13579           in: path
13580           description: String that identifies the interface
13581           required: true
13582           type: string
13583           example: __VLAN-INTERFACE__
13584         - name: l3-interface-ipv4-address
13585           in: path
13586           description: IP address
13587           required: true
13588           type: string
13589           example: __L3-INTERFACE-IPV4-ADDRESS__
13590         - name: body
13591           in: body
13592           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
13593           required: true
13594           schema:
13595             $ref: "#/definitions/l3-interface-ipv4-address-list"
13596     patch:
13597       tags:
13598         - CloudInfrastructure
13599       summary: update an existing l3-interface-ipv4-address-list
13600       description: |
13601         Update an existing l3-interface-ipv4-address-list
13602         #
13603         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13604         The PUT operation will entirely replace an existing object.
13605         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13606         #
13607         Other differences between PUT and PATCH are:
13608         #
13609         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13610         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13611         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13612       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13613       consumes:
13614         - application/json
13615         - application/xml
13616       produces:
13617         - application/json
13618         - application/xml
13619       responses:
13620         "default":
13621           description: Response codes found in [response codes](https://wiki.onap.org/).
13622       parameters:
13623         - name: hostname
13624           in: path
13625           description: Value from executing hostname on the compute node.
13626           required: true
13627           type: string
13628           example: __HOSTNAME__
13629         - name: interface-name
13630           in: path
13631           description: Name that identifies the link aggregate interface
13632           required: true
13633           type: string
13634           example: __INTERFACE-NAME__
13635         - name: interface-name
13636           in: path
13637           description: Name given to the interface
13638           required: true
13639           type: string
13640           example: __INTERFACE-NAME__
13641         - name: vlan-interface
13642           in: path
13643           description: String that identifies the interface
13644           required: true
13645           type: string
13646           example: __VLAN-INTERFACE__
13647         - name: l3-interface-ipv4-address
13648           in: path
13649           description: IP address
13650           required: true
13651           type: string
13652           example: __L3-INTERFACE-IPV4-ADDRESS__
13653         - name: body
13654           in: body
13655           description: l3-interface-ipv4-address-list object that needs to be created or updated.
13656           required: true
13657           schema:
13658             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13659     delete:
13660       tags:
13661         - CloudInfrastructure
13662       summary: delete an existing l3-interface-ipv4-address-list
13663       description: delete an existing l3-interface-ipv4-address-list
13664       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13665       consumes:
13666         - application/json
13667         - application/xml
13668       produces:
13669         - application/json
13670         - application/xml
13671       responses:
13672         "default":
13673           description: Response codes found in [response codes](https://wiki.onap.org/).
13674       parameters:
13675         - name: hostname
13676           in: path
13677           description: Value from executing hostname on the compute node.
13678           required: true
13679           type: string
13680           example: __HOSTNAME__
13681         - name: interface-name
13682           in: path
13683           description: Name that identifies the link aggregate interface
13684           required: true
13685           type: string
13686           example: __INTERFACE-NAME__
13687         - name: interface-name
13688           in: path
13689           description: Name given to the interface
13690           required: true
13691           type: string
13692           example: __INTERFACE-NAME__
13693         - name: vlan-interface
13694           in: path
13695           description: String that identifies the interface
13696           required: true
13697           type: string
13698           example: __VLAN-INTERFACE__
13699         - name: l3-interface-ipv4-address
13700           in: path
13701           description: IP address
13702           required: true
13703           type: string
13704           example: __L3-INTERFACE-IPV4-ADDRESS__
13705         - name: resource-version
13706           in: query
13707           description: resource-version for concurrency
13708           required: true
13709           type: string
13710   /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:
13711     put:
13712       tags:
13713         - CloudInfrastructure
13714       summary: see node definition for valid relationships
13715       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
13716       consumes:
13717         - application/json
13718         - application/xml
13719       produces:
13720         - application/json
13721         - application/xml
13722       responses:
13723         "default":
13724           description: Response codes found in [response codes](https://wiki.onap.org/).
13725       parameters:
13726         - name: hostname
13727           in: path
13728           description: Value from executing hostname on the compute node.
13729           required: true
13730           type: string
13731           example: __HOSTNAME__
13732         - name: interface-name
13733           in: path
13734           description: Name that identifies the link aggregate interface
13735           required: true
13736           type: string
13737           example: __INTERFACE-NAME__
13738         - name: interface-name
13739           in: path
13740           description: Name given to the interface
13741           required: true
13742           type: string
13743           example: __INTERFACE-NAME__
13744         - name: vlan-interface
13745           in: path
13746           description: String that identifies the interface
13747           required: true
13748           type: string
13749           example: __VLAN-INTERFACE__
13750         - name: l3-interface-ipv6-address
13751           in: path
13752           description: IP address
13753           required: true
13754           type: string
13755           example: __L3-INTERFACE-IPV6-ADDRESS__
13756         - name: body
13757           in: body
13758           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
13759           required: true
13760           schema:
13761             $ref: "#/definitions/relationship"
13762     delete:
13763       tags:
13764         - CloudInfrastructure
13765       summary: delete an existing relationship
13766       description: delete an existing relationship
13767       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
13768       consumes:
13769         - application/json
13770         - application/xml
13771       produces:
13772         - application/json
13773         - application/xml
13774       responses:
13775         "default":
13776           description: Response codes found in [response codes](https://wiki.onap.org/).
13777       parameters:
13778         - name: hostname
13779           in: path
13780           description: Value from executing hostname on the compute node.
13781           required: true
13782           type: string
13783           example: __HOSTNAME__
13784         - name: interface-name
13785           in: path
13786           description: Name that identifies the link aggregate interface
13787           required: true
13788           type: string
13789           example: __INTERFACE-NAME__
13790         - name: interface-name
13791           in: path
13792           description: Name given to the interface
13793           required: true
13794           type: string
13795           example: __INTERFACE-NAME__
13796         - name: vlan-interface
13797           in: path
13798           description: String that identifies the interface
13799           required: true
13800           type: string
13801           example: __VLAN-INTERFACE__
13802         - name: l3-interface-ipv6-address
13803           in: path
13804           description: IP address
13805           required: true
13806           type: string
13807           example: __L3-INTERFACE-IPV6-ADDRESS__
13808   /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}:
13809     get:
13810       tags:
13811         - CloudInfrastructure
13812       summary: returns l3-interface-ipv6-address-list
13813       description: returns l3-interface-ipv6-address-list
13814       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13815       produces:
13816         - application/json
13817         - application/xml
13818       responses:
13819         "200":
13820           description: successful operation
13821           schema:
13822               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13823         "default":
13824           description: Response codes found in [response codes](https://wiki.onap.org/).
13825       parameters:
13826         - name: hostname
13827           in: path
13828           description: Value from executing hostname on the compute node.
13829           required: true
13830           type: string
13831           example: __HOSTNAME__
13832         - name: interface-name
13833           in: path
13834           description: Name that identifies the link aggregate interface
13835           required: true
13836           type: string
13837           example: __INTERFACE-NAME__
13838         - name: interface-name
13839           in: path
13840           description: Name given to the interface
13841           required: true
13842           type: string
13843           example: __INTERFACE-NAME__
13844         - name: vlan-interface
13845           in: path
13846           description: String that identifies the interface
13847           required: true
13848           type: string
13849           example: __VLAN-INTERFACE__
13850         - name: l3-interface-ipv6-address
13851           in: path
13852           description: IP address
13853           required: true
13854           type: string
13855           example: __L3-INTERFACE-IPV6-ADDRESS__
13856         - name: inv-status
13857           in: query
13858           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13859           required: false
13860           type: string
13861         - name: pserver-id
13862           in: query
13863           description: ID of Pserver
13864           required: false
13865           type: string
13866         - name: in-maint
13867           in: query
13868           required: false
13869           type: boolean
13870         - name: pserver-name2
13871           in: query
13872           description: alternative pserver name
13873           required: false
13874           type: string
13875         - name: interface-id
13876           in: query
13877           description: ID of interface
13878           required: false
13879           type: string
13880         - name: interface-role
13881           in: query
13882           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13883           required: false
13884           type: string
13885         - name: interface-id
13886           in: query
13887           description: ID of interface
13888           required: false
13889           type: string
13890         - name: macaddr
13891           in: query
13892           description: MAC address for the interface
13893           required: false
13894           type: string
13895         - name: network-name
13896           in: query
13897           description: Name of the network
13898           required: false
13899           type: string
13900         - name: vlan-id-inner
13901           in: query
13902           description: Inner VLAN tag
13903           required: false
13904           type: integer
13905           format: int64
13906         - name: vpn-key
13907           in: query
13908           description: This indicates the customers VPN ID associated with this vlan
13909           required: false
13910           type: string
13911         - name: vlan-id-inner
13912           in: query
13913           description: Inner VLAN tag
13914           required: false
13915           type: integer
13916           format: int64
13917         - name: neutron-network-id
13918           in: query
13919           description: Neutron network id of the interface that address belongs to
13920           required: false
13921           type: string
13922         - name: neutron-subnet-id
13923           in: query
13924           description: Neutron id of subnet that address belongs to
13925           required: false
13926           type: string
13927     put:
13928       tags:
13929         - CloudInfrastructure
13930       summary: create or update an existing l3-interface-ipv6-address-list
13931       description: |
13932         Create or update an existing l3-interface-ipv6-address-list.
13933         #
13934         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13935       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13936       consumes:
13937         - application/json
13938         - application/xml
13939       produces:
13940         - application/json
13941         - application/xml
13942       responses:
13943         "default":
13944           description: Response codes found in [response codes](https://wiki.onap.org/).
13945       parameters:
13946         - name: hostname
13947           in: path
13948           description: Value from executing hostname on the compute node.
13949           required: true
13950           type: string
13951           example: __HOSTNAME__
13952         - name: interface-name
13953           in: path
13954           description: Name that identifies the link aggregate interface
13955           required: true
13956           type: string
13957           example: __INTERFACE-NAME__
13958         - name: interface-name
13959           in: path
13960           description: Name given to the interface
13961           required: true
13962           type: string
13963           example: __INTERFACE-NAME__
13964         - name: vlan-interface
13965           in: path
13966           description: String that identifies the interface
13967           required: true
13968           type: string
13969           example: __VLAN-INTERFACE__
13970         - name: l3-interface-ipv6-address
13971           in: path
13972           description: IP address
13973           required: true
13974           type: string
13975           example: __L3-INTERFACE-IPV6-ADDRESS__
13976         - name: body
13977           in: body
13978           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
13979           required: true
13980           schema:
13981             $ref: "#/definitions/l3-interface-ipv6-address-list"
13982     patch:
13983       tags:
13984         - CloudInfrastructure
13985       summary: update an existing l3-interface-ipv6-address-list
13986       description: |
13987         Update an existing l3-interface-ipv6-address-list
13988         #
13989         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13990         The PUT operation will entirely replace an existing object.
13991         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13992         #
13993         Other differences between PUT and PATCH are:
13994         #
13995         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13996         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13997         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13998       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13999       consumes:
14000         - application/json
14001         - application/xml
14002       produces:
14003         - application/json
14004         - application/xml
14005       responses:
14006         "default":
14007           description: Response codes found in [response codes](https://wiki.onap.org/).
14008       parameters:
14009         - name: hostname
14010           in: path
14011           description: Value from executing hostname on the compute node.
14012           required: true
14013           type: string
14014           example: __HOSTNAME__
14015         - name: interface-name
14016           in: path
14017           description: Name that identifies the link aggregate interface
14018           required: true
14019           type: string
14020           example: __INTERFACE-NAME__
14021         - name: interface-name
14022           in: path
14023           description: Name given to the interface
14024           required: true
14025           type: string
14026           example: __INTERFACE-NAME__
14027         - name: vlan-interface
14028           in: path
14029           description: String that identifies the interface
14030           required: true
14031           type: string
14032           example: __VLAN-INTERFACE__
14033         - name: l3-interface-ipv6-address
14034           in: path
14035           description: IP address
14036           required: true
14037           type: string
14038           example: __L3-INTERFACE-IPV6-ADDRESS__
14039         - name: body
14040           in: body
14041           description: l3-interface-ipv6-address-list object that needs to be created or updated.
14042           required: true
14043           schema:
14044             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
14045     delete:
14046       tags:
14047         - CloudInfrastructure
14048       summary: delete an existing l3-interface-ipv6-address-list
14049       description: delete an existing l3-interface-ipv6-address-list
14050       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
14051       consumes:
14052         - application/json
14053         - application/xml
14054       produces:
14055         - application/json
14056         - application/xml
14057       responses:
14058         "default":
14059           description: Response codes found in [response codes](https://wiki.onap.org/).
14060       parameters:
14061         - name: hostname
14062           in: path
14063           description: Value from executing hostname on the compute node.
14064           required: true
14065           type: string
14066           example: __HOSTNAME__
14067         - name: interface-name
14068           in: path
14069           description: Name that identifies the link aggregate interface
14070           required: true
14071           type: string
14072           example: __INTERFACE-NAME__
14073         - name: interface-name
14074           in: path
14075           description: Name given to the interface
14076           required: true
14077           type: string
14078           example: __INTERFACE-NAME__
14079         - name: vlan-interface
14080           in: path
14081           description: String that identifies the interface
14082           required: true
14083           type: string
14084           example: __VLAN-INTERFACE__
14085         - name: l3-interface-ipv6-address
14086           in: path
14087           description: IP address
14088           required: true
14089           type: string
14090           example: __L3-INTERFACE-IPV6-ADDRESS__
14091         - name: resource-version
14092           in: query
14093           description: resource-version for concurrency
14094           required: true
14095           type: string
14096   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
14097     get:
14098       tags:
14099         - CloudInfrastructure
14100       summary: returns vlan
14101       description: returns vlan
14102       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
14103       produces:
14104         - application/json
14105         - application/xml
14106       responses:
14107         "200":
14108           description: successful operation
14109           schema:
14110               $ref: "#/getDefinitions/vlan"
14111         "default":
14112           description: Response codes found in [response codes](https://wiki.onap.org/).
14113       parameters:
14114         - name: hostname
14115           in: path
14116           description: Value from executing hostname on the compute node.
14117           required: true
14118           type: string
14119           example: __HOSTNAME__
14120         - name: interface-name
14121           in: path
14122           description: Name that identifies the link aggregate interface
14123           required: true
14124           type: string
14125           example: __INTERFACE-NAME__
14126         - name: interface-name
14127           in: path
14128           description: Name given to the interface
14129           required: true
14130           type: string
14131           example: __INTERFACE-NAME__
14132         - name: vlan-interface
14133           in: path
14134           description: String that identifies the interface
14135           required: true
14136           type: string
14137           example: __VLAN-INTERFACE__
14138         - name: inv-status
14139           in: query
14140           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14141           required: false
14142           type: string
14143         - name: pserver-id
14144           in: query
14145           description: ID of Pserver
14146           required: false
14147           type: string
14148         - name: in-maint
14149           in: query
14150           required: false
14151           type: boolean
14152         - name: pserver-name2
14153           in: query
14154           description: alternative pserver name
14155           required: false
14156           type: string
14157         - name: interface-id
14158           in: query
14159           description: ID of interface
14160           required: false
14161           type: string
14162         - name: interface-role
14163           in: query
14164           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14165           required: false
14166           type: string
14167         - name: interface-id
14168           in: query
14169           description: ID of interface
14170           required: false
14171           type: string
14172         - name: macaddr
14173           in: query
14174           description: MAC address for the interface
14175           required: false
14176           type: string
14177         - name: network-name
14178           in: query
14179           description: Name of the network
14180           required: false
14181           type: string
14182         - name: vlan-id-inner
14183           in: query
14184           description: Inner VLAN tag
14185           required: false
14186           type: integer
14187           format: int64
14188         - name: vpn-key
14189           in: query
14190           description: This indicates the customers VPN ID associated with this vlan
14191           required: false
14192           type: string
14193     put:
14194       tags:
14195         - CloudInfrastructure
14196       summary: create or update an existing vlan
14197       description: |
14198         Create or update an existing vlan.
14199         #
14200         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14201       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
14202       consumes:
14203         - application/json
14204         - application/xml
14205       produces:
14206         - application/json
14207         - application/xml
14208       responses:
14209         "default":
14210           description: Response codes found in [response codes](https://wiki.onap.org/).
14211       parameters:
14212         - name: hostname
14213           in: path
14214           description: Value from executing hostname on the compute node.
14215           required: true
14216           type: string
14217           example: __HOSTNAME__
14218         - name: interface-name
14219           in: path
14220           description: Name that identifies the link aggregate interface
14221           required: true
14222           type: string
14223           example: __INTERFACE-NAME__
14224         - name: interface-name
14225           in: path
14226           description: Name given to the interface
14227           required: true
14228           type: string
14229           example: __INTERFACE-NAME__
14230         - name: vlan-interface
14231           in: path
14232           description: String that identifies the interface
14233           required: true
14234           type: string
14235           example: __VLAN-INTERFACE__
14236         - name: body
14237           in: body
14238           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
14239           required: true
14240           schema:
14241             $ref: "#/definitions/vlan"
14242     patch:
14243       tags:
14244         - CloudInfrastructure
14245       summary: update an existing vlan
14246       description: |
14247         Update an existing vlan
14248         #
14249         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14250         The PUT operation will entirely replace an existing object.
14251         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14252         #
14253         Other differences between PUT and PATCH are:
14254         #
14255         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14256         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14257         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14258       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
14259       consumes:
14260         - application/json
14261         - application/xml
14262       produces:
14263         - application/json
14264         - application/xml
14265       responses:
14266         "default":
14267           description: Response codes found in [response codes](https://wiki.onap.org/).
14268       parameters:
14269         - name: hostname
14270           in: path
14271           description: Value from executing hostname on the compute node.
14272           required: true
14273           type: string
14274           example: __HOSTNAME__
14275         - name: interface-name
14276           in: path
14277           description: Name that identifies the link aggregate interface
14278           required: true
14279           type: string
14280           example: __INTERFACE-NAME__
14281         - name: interface-name
14282           in: path
14283           description: Name given to the interface
14284           required: true
14285           type: string
14286           example: __INTERFACE-NAME__
14287         - name: vlan-interface
14288           in: path
14289           description: String that identifies the interface
14290           required: true
14291           type: string
14292           example: __VLAN-INTERFACE__
14293         - name: body
14294           in: body
14295           description: vlan object that needs to be created or updated.
14296           required: true
14297           schema:
14298             $ref: "#/patchDefinitions/vlan"
14299     delete:
14300       tags:
14301         - CloudInfrastructure
14302       summary: delete an existing vlan
14303       description: delete an existing vlan
14304       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
14305       consumes:
14306         - application/json
14307         - application/xml
14308       produces:
14309         - application/json
14310         - application/xml
14311       responses:
14312         "default":
14313           description: Response codes found in [response codes](https://wiki.onap.org/).
14314       parameters:
14315         - name: hostname
14316           in: path
14317           description: Value from executing hostname on the compute node.
14318           required: true
14319           type: string
14320           example: __HOSTNAME__
14321         - name: interface-name
14322           in: path
14323           description: Name that identifies the link aggregate interface
14324           required: true
14325           type: string
14326           example: __INTERFACE-NAME__
14327         - name: interface-name
14328           in: path
14329           description: Name given to the interface
14330           required: true
14331           type: string
14332           example: __INTERFACE-NAME__
14333         - name: vlan-interface
14334           in: path
14335           description: String that identifies the interface
14336           required: true
14337           type: string
14338           example: __VLAN-INTERFACE__
14339         - name: resource-version
14340           in: query
14341           description: resource-version for concurrency
14342           required: true
14343           type: string
14344   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
14345     get:
14346       tags:
14347         - CloudInfrastructure
14348       summary: returns vlans
14349       description: returns vlans
14350       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
14351       produces:
14352         - application/json
14353         - application/xml
14354       responses:
14355         "200":
14356           description: successful operation
14357           schema:
14358               $ref: "#/getDefinitions/vlans"
14359         "default":
14360           description: Response codes found in [response codes](https://wiki.onap.org/).
14361       parameters:
14362         - name: hostname
14363           in: path
14364           description: Value from executing hostname on the compute node.
14365           required: true
14366           type: string
14367           example: __HOSTNAME__
14368         - name: interface-name
14369           in: path
14370           description: Name that identifies the link aggregate interface
14371           required: true
14372           type: string
14373           example: __INTERFACE-NAME__
14374         - name: interface-name
14375           in: path
14376           description: Name given to the interface
14377           required: true
14378           type: string
14379           example: __INTERFACE-NAME__
14380         - name: inv-status
14381           in: query
14382           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14383           required: false
14384           type: string
14385         - name: pserver-id
14386           in: query
14387           description: ID of Pserver
14388           required: false
14389           type: string
14390         - name: in-maint
14391           in: query
14392           required: false
14393           type: boolean
14394         - name: pserver-name2
14395           in: query
14396           description: alternative pserver name
14397           required: false
14398           type: string
14399         - name: interface-id
14400           in: query
14401           description: ID of interface
14402           required: false
14403           type: string
14404         - name: interface-role
14405           in: query
14406           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14407           required: false
14408           type: string
14409         - name: interface-id
14410           in: query
14411           description: ID of interface
14412           required: false
14413           type: string
14414         - name: macaddr
14415           in: query
14416           description: MAC address for the interface
14417           required: false
14418           type: string
14419         - name: network-name
14420           in: query
14421           description: Name of the network
14422           required: false
14423           type: string
14424   /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:
14425     put:
14426       tags:
14427         - CloudInfrastructure
14428       summary: see node definition for valid relationships
14429       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
14430       consumes:
14431         - application/json
14432         - application/xml
14433       produces:
14434         - application/json
14435         - application/xml
14436       responses:
14437         "default":
14438           description: Response codes found in [response codes](https://wiki.onap.org/).
14439       parameters:
14440         - name: hostname
14441           in: path
14442           description: Value from executing hostname on the compute node.
14443           required: true
14444           type: string
14445           example: __HOSTNAME__
14446         - name: interface-name
14447           in: path
14448           description: Name that identifies the link aggregate interface
14449           required: true
14450           type: string
14451           example: __INTERFACE-NAME__
14452         - name: interface-name
14453           in: path
14454           description: Name given to the interface
14455           required: true
14456           type: string
14457           example: __INTERFACE-NAME__
14458         - name: pci-id
14459           in: path
14460           description: PCI ID used to identify the sriov-vf
14461           required: true
14462           type: string
14463           example: __PCI-ID__
14464         - name: body
14465           in: body
14466           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
14467           required: true
14468           schema:
14469             $ref: "#/definitions/relationship"
14470     delete:
14471       tags:
14472         - CloudInfrastructure
14473       summary: delete an existing relationship
14474       description: delete an existing relationship
14475       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
14476       consumes:
14477         - application/json
14478         - application/xml
14479       produces:
14480         - application/json
14481         - application/xml
14482       responses:
14483         "default":
14484           description: Response codes found in [response codes](https://wiki.onap.org/).
14485       parameters:
14486         - name: hostname
14487           in: path
14488           description: Value from executing hostname on the compute node.
14489           required: true
14490           type: string
14491           example: __HOSTNAME__
14492         - name: interface-name
14493           in: path
14494           description: Name that identifies the link aggregate interface
14495           required: true
14496           type: string
14497           example: __INTERFACE-NAME__
14498         - name: interface-name
14499           in: path
14500           description: Name given to the interface
14501           required: true
14502           type: string
14503           example: __INTERFACE-NAME__
14504         - name: pci-id
14505           in: path
14506           description: PCI ID used to identify the sriov-vf
14507           required: true
14508           type: string
14509           example: __PCI-ID__
14510   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
14511     get:
14512       tags:
14513         - CloudInfrastructure
14514       summary: returns sriov-vf
14515       description: returns sriov-vf
14516       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14517       produces:
14518         - application/json
14519         - application/xml
14520       responses:
14521         "200":
14522           description: successful operation
14523           schema:
14524               $ref: "#/getDefinitions/sriov-vf"
14525         "default":
14526           description: Response codes found in [response codes](https://wiki.onap.org/).
14527       parameters:
14528         - name: hostname
14529           in: path
14530           description: Value from executing hostname on the compute node.
14531           required: true
14532           type: string
14533           example: __HOSTNAME__
14534         - name: interface-name
14535           in: path
14536           description: Name that identifies the link aggregate interface
14537           required: true
14538           type: string
14539           example: __INTERFACE-NAME__
14540         - name: interface-name
14541           in: path
14542           description: Name given to the interface
14543           required: true
14544           type: string
14545           example: __INTERFACE-NAME__
14546         - name: pci-id
14547           in: path
14548           description: PCI ID used to identify the sriov-vf
14549           required: true
14550           type: string
14551           example: __PCI-ID__
14552         - name: inv-status
14553           in: query
14554           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14555           required: false
14556           type: string
14557         - name: pserver-id
14558           in: query
14559           description: ID of Pserver
14560           required: false
14561           type: string
14562         - name: in-maint
14563           in: query
14564           required: false
14565           type: boolean
14566         - name: pserver-name2
14567           in: query
14568           description: alternative pserver name
14569           required: false
14570           type: string
14571         - name: interface-id
14572           in: query
14573           description: ID of interface
14574           required: false
14575           type: string
14576         - name: interface-role
14577           in: query
14578           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14579           required: false
14580           type: string
14581         - name: interface-id
14582           in: query
14583           description: ID of interface
14584           required: false
14585           type: string
14586         - name: macaddr
14587           in: query
14588           description: MAC address for the interface
14589           required: false
14590           type: string
14591         - name: network-name
14592           in: query
14593           description: Name of the network
14594           required: false
14595           type: string
14596         - name: vf-vlan-filter
14597           in: query
14598           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
14599           required: false
14600           type: string
14601         - name: vf-mac-filter
14602           in: query
14603           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
14604           required: false
14605           type: string
14606         - name: vf-vlan-strip
14607           in: query
14608           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
14609           required: false
14610           type: boolean
14611         - name: neutron-network-id
14612           in: query
14613           description: Neutron network id of the interface
14614           required: false
14615           type: string
14616     put:
14617       tags:
14618         - CloudInfrastructure
14619       summary: create or update an existing sriov-vf
14620       description: |
14621         Create or update an existing sriov-vf.
14622         #
14623         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14624       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14625       consumes:
14626         - application/json
14627         - application/xml
14628       produces:
14629         - application/json
14630         - application/xml
14631       responses:
14632         "default":
14633           description: Response codes found in [response codes](https://wiki.onap.org/).
14634       parameters:
14635         - name: hostname
14636           in: path
14637           description: Value from executing hostname on the compute node.
14638           required: true
14639           type: string
14640           example: __HOSTNAME__
14641         - name: interface-name
14642           in: path
14643           description: Name that identifies the link aggregate interface
14644           required: true
14645           type: string
14646           example: __INTERFACE-NAME__
14647         - name: interface-name
14648           in: path
14649           description: Name given to the interface
14650           required: true
14651           type: string
14652           example: __INTERFACE-NAME__
14653         - name: pci-id
14654           in: path
14655           description: PCI ID used to identify the sriov-vf
14656           required: true
14657           type: string
14658           example: __PCI-ID__
14659         - name: body
14660           in: body
14661           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
14662           required: true
14663           schema:
14664             $ref: "#/definitions/sriov-vf"
14665     patch:
14666       tags:
14667         - CloudInfrastructure
14668       summary: update an existing sriov-vf
14669       description: |
14670         Update an existing sriov-vf
14671         #
14672         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14673         The PUT operation will entirely replace an existing object.
14674         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14675         #
14676         Other differences between PUT and PATCH are:
14677         #
14678         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14679         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14680         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14681       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14682       consumes:
14683         - application/json
14684         - application/xml
14685       produces:
14686         - application/json
14687         - application/xml
14688       responses:
14689         "default":
14690           description: Response codes found in [response codes](https://wiki.onap.org/).
14691       parameters:
14692         - name: hostname
14693           in: path
14694           description: Value from executing hostname on the compute node.
14695           required: true
14696           type: string
14697           example: __HOSTNAME__
14698         - name: interface-name
14699           in: path
14700           description: Name that identifies the link aggregate interface
14701           required: true
14702           type: string
14703           example: __INTERFACE-NAME__
14704         - name: interface-name
14705           in: path
14706           description: Name given to the interface
14707           required: true
14708           type: string
14709           example: __INTERFACE-NAME__
14710         - name: pci-id
14711           in: path
14712           description: PCI ID used to identify the sriov-vf
14713           required: true
14714           type: string
14715           example: __PCI-ID__
14716         - name: body
14717           in: body
14718           description: sriov-vf object that needs to be created or updated.
14719           required: true
14720           schema:
14721             $ref: "#/patchDefinitions/sriov-vf"
14722     delete:
14723       tags:
14724         - CloudInfrastructure
14725       summary: delete an existing sriov-vf
14726       description: delete an existing sriov-vf
14727       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14728       consumes:
14729         - application/json
14730         - application/xml
14731       produces:
14732         - application/json
14733         - application/xml
14734       responses:
14735         "default":
14736           description: Response codes found in [response codes](https://wiki.onap.org/).
14737       parameters:
14738         - name: hostname
14739           in: path
14740           description: Value from executing hostname on the compute node.
14741           required: true
14742           type: string
14743           example: __HOSTNAME__
14744         - name: interface-name
14745           in: path
14746           description: Name that identifies the link aggregate interface
14747           required: true
14748           type: string
14749           example: __INTERFACE-NAME__
14750         - name: interface-name
14751           in: path
14752           description: Name given to the interface
14753           required: true
14754           type: string
14755           example: __INTERFACE-NAME__
14756         - name: pci-id
14757           in: path
14758           description: PCI ID used to identify the sriov-vf
14759           required: true
14760           type: string
14761           example: __PCI-ID__
14762         - name: resource-version
14763           in: query
14764           description: resource-version for concurrency
14765           required: true
14766           type: string
14767   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
14768     get:
14769       tags:
14770         - CloudInfrastructure
14771       summary: returns sriov-vfs
14772       description: returns sriov-vfs
14773       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
14774       produces:
14775         - application/json
14776         - application/xml
14777       responses:
14778         "200":
14779           description: successful operation
14780           schema:
14781               $ref: "#/getDefinitions/sriov-vfs"
14782         "default":
14783           description: Response codes found in [response codes](https://wiki.onap.org/).
14784       parameters:
14785         - name: hostname
14786           in: path
14787           description: Value from executing hostname on the compute node.
14788           required: true
14789           type: string
14790           example: __HOSTNAME__
14791         - name: interface-name
14792           in: path
14793           description: Name that identifies the link aggregate interface
14794           required: true
14795           type: string
14796           example: __INTERFACE-NAME__
14797         - name: interface-name
14798           in: path
14799           description: Name given to the interface
14800           required: true
14801           type: string
14802           example: __INTERFACE-NAME__
14803         - name: inv-status
14804           in: query
14805           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14806           required: false
14807           type: string
14808         - name: pserver-id
14809           in: query
14810           description: ID of Pserver
14811           required: false
14812           type: string
14813         - name: in-maint
14814           in: query
14815           required: false
14816           type: boolean
14817         - name: pserver-name2
14818           in: query
14819           description: alternative pserver name
14820           required: false
14821           type: string
14822         - name: interface-id
14823           in: query
14824           description: ID of interface
14825           required: false
14826           type: string
14827         - name: interface-role
14828           in: query
14829           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14830           required: false
14831           type: string
14832         - name: interface-id
14833           in: query
14834           description: ID of interface
14835           required: false
14836           type: string
14837         - name: macaddr
14838           in: query
14839           description: MAC address for the interface
14840           required: false
14841           type: string
14842         - name: network-name
14843           in: query
14844           description: Name of the network
14845           required: false
14846           type: string
14847   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
14848     put:
14849       tags:
14850         - CloudInfrastructure
14851       summary: see node definition for valid relationships
14852       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
14853       consumes:
14854         - application/json
14855         - application/xml
14856       produces:
14857         - application/json
14858         - application/xml
14859       responses:
14860         "default":
14861           description: Response codes found in [response codes](https://wiki.onap.org/).
14862       parameters:
14863         - name: hostname
14864           in: path
14865           description: Value from executing hostname on the compute node.
14866           required: true
14867           type: string
14868           example: __HOSTNAME__
14869         - name: interface-name
14870           in: path
14871           description: Name that identifies the link aggregate interface
14872           required: true
14873           type: string
14874           example: __INTERFACE-NAME__
14875         - name: interface-name
14876           in: path
14877           description: Name given to the interface
14878           required: true
14879           type: string
14880           example: __INTERFACE-NAME__
14881         - name: body
14882           in: body
14883           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
14884           required: true
14885           schema:
14886             $ref: "#/definitions/relationship"
14887     delete:
14888       tags:
14889         - CloudInfrastructure
14890       summary: delete an existing relationship
14891       description: delete an existing relationship
14892       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
14893       consumes:
14894         - application/json
14895         - application/xml
14896       produces:
14897         - application/json
14898         - application/xml
14899       responses:
14900         "default":
14901           description: Response codes found in [response codes](https://wiki.onap.org/).
14902       parameters:
14903         - name: hostname
14904           in: path
14905           description: Value from executing hostname on the compute node.
14906           required: true
14907           type: string
14908           example: __HOSTNAME__
14909         - name: interface-name
14910           in: path
14911           description: Name that identifies the link aggregate interface
14912           required: true
14913           type: string
14914           example: __INTERFACE-NAME__
14915         - name: interface-name
14916           in: path
14917           description: Name given to the interface
14918           required: true
14919           type: string
14920           example: __INTERFACE-NAME__
14921   /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:
14922     put:
14923       tags:
14924         - CloudInfrastructure
14925       summary: see node definition for valid relationships
14926       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
14927       consumes:
14928         - application/json
14929         - application/xml
14930       produces:
14931         - application/json
14932         - application/xml
14933       responses:
14934         "default":
14935           description: Response codes found in [response codes](https://wiki.onap.org/).
14936       parameters:
14937         - name: hostname
14938           in: path
14939           description: Value from executing hostname on the compute node.
14940           required: true
14941           type: string
14942           example: __HOSTNAME__
14943         - name: interface-name
14944           in: path
14945           description: Name that identifies the link aggregate interface
14946           required: true
14947           type: string
14948           example: __INTERFACE-NAME__
14949         - name: interface-name
14950           in: path
14951           description: Name given to the interface
14952           required: true
14953           type: string
14954           example: __INTERFACE-NAME__
14955         - name: l3-interface-ipv4-address
14956           in: path
14957           description: IP address
14958           required: true
14959           type: string
14960           example: __L3-INTERFACE-IPV4-ADDRESS__
14961         - name: body
14962           in: body
14963           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
14964           required: true
14965           schema:
14966             $ref: "#/definitions/relationship"
14967     delete:
14968       tags:
14969         - CloudInfrastructure
14970       summary: delete an existing relationship
14971       description: delete an existing relationship
14972       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
14973       consumes:
14974         - application/json
14975         - application/xml
14976       produces:
14977         - application/json
14978         - application/xml
14979       responses:
14980         "default":
14981           description: Response codes found in [response codes](https://wiki.onap.org/).
14982       parameters:
14983         - name: hostname
14984           in: path
14985           description: Value from executing hostname on the compute node.
14986           required: true
14987           type: string
14988           example: __HOSTNAME__
14989         - name: interface-name
14990           in: path
14991           description: Name that identifies the link aggregate interface
14992           required: true
14993           type: string
14994           example: __INTERFACE-NAME__
14995         - name: interface-name
14996           in: path
14997           description: Name given to the interface
14998           required: true
14999           type: string
15000           example: __INTERFACE-NAME__
15001         - name: l3-interface-ipv4-address
15002           in: path
15003           description: IP address
15004           required: true
15005           type: string
15006           example: __L3-INTERFACE-IPV4-ADDRESS__
15007   /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}:
15008     get:
15009       tags:
15010         - CloudInfrastructure
15011       summary: returns l3-interface-ipv4-address-list
15012       description: returns l3-interface-ipv4-address-list
15013       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
15014       produces:
15015         - application/json
15016         - application/xml
15017       responses:
15018         "200":
15019           description: successful operation
15020           schema:
15021               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
15022         "default":
15023           description: Response codes found in [response codes](https://wiki.onap.org/).
15024       parameters:
15025         - name: hostname
15026           in: path
15027           description: Value from executing hostname on the compute node.
15028           required: true
15029           type: string
15030           example: __HOSTNAME__
15031         - name: interface-name
15032           in: path
15033           description: Name that identifies the link aggregate interface
15034           required: true
15035           type: string
15036           example: __INTERFACE-NAME__
15037         - name: interface-name
15038           in: path
15039           description: Name given to the interface
15040           required: true
15041           type: string
15042           example: __INTERFACE-NAME__
15043         - name: l3-interface-ipv4-address
15044           in: path
15045           description: IP address
15046           required: true
15047           type: string
15048           example: __L3-INTERFACE-IPV4-ADDRESS__
15049         - name: inv-status
15050           in: query
15051           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15052           required: false
15053           type: string
15054         - name: pserver-id
15055           in: query
15056           description: ID of Pserver
15057           required: false
15058           type: string
15059         - name: in-maint
15060           in: query
15061           required: false
15062           type: boolean
15063         - name: pserver-name2
15064           in: query
15065           description: alternative pserver name
15066           required: false
15067           type: string
15068         - name: interface-id
15069           in: query
15070           description: ID of interface
15071           required: false
15072           type: string
15073         - name: interface-role
15074           in: query
15075           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15076           required: false
15077           type: string
15078         - name: interface-id
15079           in: query
15080           description: ID of interface
15081           required: false
15082           type: string
15083         - name: macaddr
15084           in: query
15085           description: MAC address for the interface
15086           required: false
15087           type: string
15088         - name: network-name
15089           in: query
15090           description: Name of the network
15091           required: false
15092           type: string
15093         - name: vlan-id-inner
15094           in: query
15095           description: Inner VLAN tag
15096           required: false
15097           type: integer
15098           format: int64
15099         - name: neutron-network-id
15100           in: query
15101           description: Neutron network id of the interface that address belongs to
15102           required: false
15103           type: string
15104         - name: neutron-subnet-id
15105           in: query
15106           description: Neutron id of subnet that address belongs to
15107           required: false
15108           type: string
15109     put:
15110       tags:
15111         - CloudInfrastructure
15112       summary: create or update an existing l3-interface-ipv4-address-list
15113       description: |
15114         Create or update an existing l3-interface-ipv4-address-list.
15115         #
15116         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15117       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
15118       consumes:
15119         - application/json
15120         - application/xml
15121       produces:
15122         - application/json
15123         - application/xml
15124       responses:
15125         "default":
15126           description: Response codes found in [response codes](https://wiki.onap.org/).
15127       parameters:
15128         - name: hostname
15129           in: path
15130           description: Value from executing hostname on the compute node.
15131           required: true
15132           type: string
15133           example: __HOSTNAME__
15134         - name: interface-name
15135           in: path
15136           description: Name that identifies the link aggregate interface
15137           required: true
15138           type: string
15139           example: __INTERFACE-NAME__
15140         - name: interface-name
15141           in: path
15142           description: Name given to the interface
15143           required: true
15144           type: string
15145           example: __INTERFACE-NAME__
15146         - name: l3-interface-ipv4-address
15147           in: path
15148           description: IP address
15149           required: true
15150           type: string
15151           example: __L3-INTERFACE-IPV4-ADDRESS__
15152         - name: body
15153           in: body
15154           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
15155           required: true
15156           schema:
15157             $ref: "#/definitions/l3-interface-ipv4-address-list"
15158     patch:
15159       tags:
15160         - CloudInfrastructure
15161       summary: update an existing l3-interface-ipv4-address-list
15162       description: |
15163         Update an existing l3-interface-ipv4-address-list
15164         #
15165         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15166         The PUT operation will entirely replace an existing object.
15167         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15168         #
15169         Other differences between PUT and PATCH are:
15170         #
15171         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15172         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15173         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15174       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
15175       consumes:
15176         - application/json
15177         - application/xml
15178       produces:
15179         - application/json
15180         - application/xml
15181       responses:
15182         "default":
15183           description: Response codes found in [response codes](https://wiki.onap.org/).
15184       parameters:
15185         - name: hostname
15186           in: path
15187           description: Value from executing hostname on the compute node.
15188           required: true
15189           type: string
15190           example: __HOSTNAME__
15191         - name: interface-name
15192           in: path
15193           description: Name that identifies the link aggregate interface
15194           required: true
15195           type: string
15196           example: __INTERFACE-NAME__
15197         - name: interface-name
15198           in: path
15199           description: Name given to the interface
15200           required: true
15201           type: string
15202           example: __INTERFACE-NAME__
15203         - name: l3-interface-ipv4-address
15204           in: path
15205           description: IP address
15206           required: true
15207           type: string
15208           example: __L3-INTERFACE-IPV4-ADDRESS__
15209         - name: body
15210           in: body
15211           description: l3-interface-ipv4-address-list object that needs to be created or updated.
15212           required: true
15213           schema:
15214             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
15215     delete:
15216       tags:
15217         - CloudInfrastructure
15218       summary: delete an existing l3-interface-ipv4-address-list
15219       description: delete an existing l3-interface-ipv4-address-list
15220       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
15221       consumes:
15222         - application/json
15223         - application/xml
15224       produces:
15225         - application/json
15226         - application/xml
15227       responses:
15228         "default":
15229           description: Response codes found in [response codes](https://wiki.onap.org/).
15230       parameters:
15231         - name: hostname
15232           in: path
15233           description: Value from executing hostname on the compute node.
15234           required: true
15235           type: string
15236           example: __HOSTNAME__
15237         - name: interface-name
15238           in: path
15239           description: Name that identifies the link aggregate interface
15240           required: true
15241           type: string
15242           example: __INTERFACE-NAME__
15243         - name: interface-name
15244           in: path
15245           description: Name given to the interface
15246           required: true
15247           type: string
15248           example: __INTERFACE-NAME__
15249         - name: l3-interface-ipv4-address
15250           in: path
15251           description: IP address
15252           required: true
15253           type: string
15254           example: __L3-INTERFACE-IPV4-ADDRESS__
15255         - name: resource-version
15256           in: query
15257           description: resource-version for concurrency
15258           required: true
15259           type: string
15260   /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:
15261     put:
15262       tags:
15263         - CloudInfrastructure
15264       summary: see node definition for valid relationships
15265       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
15266       consumes:
15267         - application/json
15268         - application/xml
15269       produces:
15270         - application/json
15271         - application/xml
15272       responses:
15273         "default":
15274           description: Response codes found in [response codes](https://wiki.onap.org/).
15275       parameters:
15276         - name: hostname
15277           in: path
15278           description: Value from executing hostname on the compute node.
15279           required: true
15280           type: string
15281           example: __HOSTNAME__
15282         - name: interface-name
15283           in: path
15284           description: Name that identifies the link aggregate interface
15285           required: true
15286           type: string
15287           example: __INTERFACE-NAME__
15288         - name: interface-name
15289           in: path
15290           description: Name given to the interface
15291           required: true
15292           type: string
15293           example: __INTERFACE-NAME__
15294         - name: l3-interface-ipv6-address
15295           in: path
15296           description: IP address
15297           required: true
15298           type: string
15299           example: __L3-INTERFACE-IPV6-ADDRESS__
15300         - name: body
15301           in: body
15302           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
15303           required: true
15304           schema:
15305             $ref: "#/definitions/relationship"
15306     delete:
15307       tags:
15308         - CloudInfrastructure
15309       summary: delete an existing relationship
15310       description: delete an existing relationship
15311       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
15312       consumes:
15313         - application/json
15314         - application/xml
15315       produces:
15316         - application/json
15317         - application/xml
15318       responses:
15319         "default":
15320           description: Response codes found in [response codes](https://wiki.onap.org/).
15321       parameters:
15322         - name: hostname
15323           in: path
15324           description: Value from executing hostname on the compute node.
15325           required: true
15326           type: string
15327           example: __HOSTNAME__
15328         - name: interface-name
15329           in: path
15330           description: Name that identifies the link aggregate interface
15331           required: true
15332           type: string
15333           example: __INTERFACE-NAME__
15334         - name: interface-name
15335           in: path
15336           description: Name given to the interface
15337           required: true
15338           type: string
15339           example: __INTERFACE-NAME__
15340         - name: l3-interface-ipv6-address
15341           in: path
15342           description: IP address
15343           required: true
15344           type: string
15345           example: __L3-INTERFACE-IPV6-ADDRESS__
15346   /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}:
15347     get:
15348       tags:
15349         - CloudInfrastructure
15350       summary: returns l3-interface-ipv6-address-list
15351       description: returns l3-interface-ipv6-address-list
15352       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15353       produces:
15354         - application/json
15355         - application/xml
15356       responses:
15357         "200":
15358           description: successful operation
15359           schema:
15360               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
15361         "default":
15362           description: Response codes found in [response codes](https://wiki.onap.org/).
15363       parameters:
15364         - name: hostname
15365           in: path
15366           description: Value from executing hostname on the compute node.
15367           required: true
15368           type: string
15369           example: __HOSTNAME__
15370         - name: interface-name
15371           in: path
15372           description: Name that identifies the link aggregate interface
15373           required: true
15374           type: string
15375           example: __INTERFACE-NAME__
15376         - name: interface-name
15377           in: path
15378           description: Name given to the interface
15379           required: true
15380           type: string
15381           example: __INTERFACE-NAME__
15382         - name: l3-interface-ipv6-address
15383           in: path
15384           description: IP address
15385           required: true
15386           type: string
15387           example: __L3-INTERFACE-IPV6-ADDRESS__
15388         - name: inv-status
15389           in: query
15390           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15391           required: false
15392           type: string
15393         - name: pserver-id
15394           in: query
15395           description: ID of Pserver
15396           required: false
15397           type: string
15398         - name: in-maint
15399           in: query
15400           required: false
15401           type: boolean
15402         - name: pserver-name2
15403           in: query
15404           description: alternative pserver name
15405           required: false
15406           type: string
15407         - name: interface-id
15408           in: query
15409           description: ID of interface
15410           required: false
15411           type: string
15412         - name: interface-role
15413           in: query
15414           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15415           required: false
15416           type: string
15417         - name: interface-id
15418           in: query
15419           description: ID of interface
15420           required: false
15421           type: string
15422         - name: macaddr
15423           in: query
15424           description: MAC address for the interface
15425           required: false
15426           type: string
15427         - name: network-name
15428           in: query
15429           description: Name of the network
15430           required: false
15431           type: string
15432         - name: vlan-id-inner
15433           in: query
15434           description: Inner VLAN tag
15435           required: false
15436           type: integer
15437           format: int64
15438         - name: neutron-network-id
15439           in: query
15440           description: Neutron network id of the interface that address belongs to
15441           required: false
15442           type: string
15443         - name: neutron-subnet-id
15444           in: query
15445           description: Neutron id of subnet that address belongs to
15446           required: false
15447           type: string
15448     put:
15449       tags:
15450         - CloudInfrastructure
15451       summary: create or update an existing l3-interface-ipv6-address-list
15452       description: |
15453         Create or update an existing l3-interface-ipv6-address-list.
15454         #
15455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15456       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15457       consumes:
15458         - application/json
15459         - application/xml
15460       produces:
15461         - application/json
15462         - application/xml
15463       responses:
15464         "default":
15465           description: Response codes found in [response codes](https://wiki.onap.org/).
15466       parameters:
15467         - name: hostname
15468           in: path
15469           description: Value from executing hostname on the compute node.
15470           required: true
15471           type: string
15472           example: __HOSTNAME__
15473         - name: interface-name
15474           in: path
15475           description: Name that identifies the link aggregate interface
15476           required: true
15477           type: string
15478           example: __INTERFACE-NAME__
15479         - name: interface-name
15480           in: path
15481           description: Name given to the interface
15482           required: true
15483           type: string
15484           example: __INTERFACE-NAME__
15485         - name: l3-interface-ipv6-address
15486           in: path
15487           description: IP address
15488           required: true
15489           type: string
15490           example: __L3-INTERFACE-IPV6-ADDRESS__
15491         - name: body
15492           in: body
15493           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
15494           required: true
15495           schema:
15496             $ref: "#/definitions/l3-interface-ipv6-address-list"
15497     patch:
15498       tags:
15499         - CloudInfrastructure
15500       summary: update an existing l3-interface-ipv6-address-list
15501       description: |
15502         Update an existing l3-interface-ipv6-address-list
15503         #
15504         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15505         The PUT operation will entirely replace an existing object.
15506         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15507         #
15508         Other differences between PUT and PATCH are:
15509         #
15510         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15511         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15512         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15513       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15514       consumes:
15515         - application/json
15516         - application/xml
15517       produces:
15518         - application/json
15519         - application/xml
15520       responses:
15521         "default":
15522           description: Response codes found in [response codes](https://wiki.onap.org/).
15523       parameters:
15524         - name: hostname
15525           in: path
15526           description: Value from executing hostname on the compute node.
15527           required: true
15528           type: string
15529           example: __HOSTNAME__
15530         - name: interface-name
15531           in: path
15532           description: Name that identifies the link aggregate interface
15533           required: true
15534           type: string
15535           example: __INTERFACE-NAME__
15536         - name: interface-name
15537           in: path
15538           description: Name given to the interface
15539           required: true
15540           type: string
15541           example: __INTERFACE-NAME__
15542         - name: l3-interface-ipv6-address
15543           in: path
15544           description: IP address
15545           required: true
15546           type: string
15547           example: __L3-INTERFACE-IPV6-ADDRESS__
15548         - name: body
15549           in: body
15550           description: l3-interface-ipv6-address-list object that needs to be created or updated.
15551           required: true
15552           schema:
15553             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
15554     delete:
15555       tags:
15556         - CloudInfrastructure
15557       summary: delete an existing l3-interface-ipv6-address-list
15558       description: delete an existing l3-interface-ipv6-address-list
15559       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15560       consumes:
15561         - application/json
15562         - application/xml
15563       produces:
15564         - application/json
15565         - application/xml
15566       responses:
15567         "default":
15568           description: Response codes found in [response codes](https://wiki.onap.org/).
15569       parameters:
15570         - name: hostname
15571           in: path
15572           description: Value from executing hostname on the compute node.
15573           required: true
15574           type: string
15575           example: __HOSTNAME__
15576         - name: interface-name
15577           in: path
15578           description: Name that identifies the link aggregate interface
15579           required: true
15580           type: string
15581           example: __INTERFACE-NAME__
15582         - name: interface-name
15583           in: path
15584           description: Name given to the interface
15585           required: true
15586           type: string
15587           example: __INTERFACE-NAME__
15588         - name: l3-interface-ipv6-address
15589           in: path
15590           description: IP address
15591           required: true
15592           type: string
15593           example: __L3-INTERFACE-IPV6-ADDRESS__
15594         - name: resource-version
15595           in: query
15596           description: resource-version for concurrency
15597           required: true
15598           type: string
15599   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
15600     get:
15601       tags:
15602         - CloudInfrastructure
15603       summary: returns l-interface
15604       description: returns l-interface
15605       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15606       produces:
15607         - application/json
15608         - application/xml
15609       responses:
15610         "200":
15611           description: successful operation
15612           schema:
15613               $ref: "#/getDefinitions/l-interface"
15614         "default":
15615           description: Response codes found in [response codes](https://wiki.onap.org/).
15616       parameters:
15617         - name: hostname
15618           in: path
15619           description: Value from executing hostname on the compute node.
15620           required: true
15621           type: string
15622           example: __HOSTNAME__
15623         - name: interface-name
15624           in: path
15625           description: Name that identifies the link aggregate interface
15626           required: true
15627           type: string
15628           example: __INTERFACE-NAME__
15629         - name: interface-name
15630           in: path
15631           description: Name given to the interface
15632           required: true
15633           type: string
15634           example: __INTERFACE-NAME__
15635         - name: inv-status
15636           in: query
15637           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15638           required: false
15639           type: string
15640         - name: pserver-id
15641           in: query
15642           description: ID of Pserver
15643           required: false
15644           type: string
15645         - name: in-maint
15646           in: query
15647           required: false
15648           type: boolean
15649         - name: pserver-name2
15650           in: query
15651           description: alternative pserver name
15652           required: false
15653           type: string
15654         - name: interface-id
15655           in: query
15656           description: ID of interface
15657           required: false
15658           type: string
15659         - name: interface-role
15660           in: query
15661           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15662           required: false
15663           type: string
15664         - name: interface-id
15665           in: query
15666           description: ID of interface
15667           required: false
15668           type: string
15669         - name: macaddr
15670           in: query
15671           description: MAC address for the interface
15672           required: false
15673           type: string
15674         - name: network-name
15675           in: query
15676           description: Name of the network
15677           required: false
15678           type: string
15679     put:
15680       tags:
15681         - CloudInfrastructure
15682       summary: create or update an existing l-interface
15683       description: |
15684         Create or update an existing l-interface.
15685         #
15686         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15687       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15688       consumes:
15689         - application/json
15690         - application/xml
15691       produces:
15692         - application/json
15693         - application/xml
15694       responses:
15695         "default":
15696           description: Response codes found in [response codes](https://wiki.onap.org/).
15697       parameters:
15698         - name: hostname
15699           in: path
15700           description: Value from executing hostname on the compute node.
15701           required: true
15702           type: string
15703           example: __HOSTNAME__
15704         - name: interface-name
15705           in: path
15706           description: Name that identifies the link aggregate interface
15707           required: true
15708           type: string
15709           example: __INTERFACE-NAME__
15710         - name: interface-name
15711           in: path
15712           description: Name given to the interface
15713           required: true
15714           type: string
15715           example: __INTERFACE-NAME__
15716         - name: body
15717           in: body
15718           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
15719           required: true
15720           schema:
15721             $ref: "#/definitions/l-interface"
15722     patch:
15723       tags:
15724         - CloudInfrastructure
15725       summary: update an existing l-interface
15726       description: |
15727         Update an existing l-interface
15728         #
15729         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15730         The PUT operation will entirely replace an existing object.
15731         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15732         #
15733         Other differences between PUT and PATCH are:
15734         #
15735         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15736         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15737         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15738       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15739       consumes:
15740         - application/json
15741         - application/xml
15742       produces:
15743         - application/json
15744         - application/xml
15745       responses:
15746         "default":
15747           description: Response codes found in [response codes](https://wiki.onap.org/).
15748       parameters:
15749         - name: hostname
15750           in: path
15751           description: Value from executing hostname on the compute node.
15752           required: true
15753           type: string
15754           example: __HOSTNAME__
15755         - name: interface-name
15756           in: path
15757           description: Name that identifies the link aggregate interface
15758           required: true
15759           type: string
15760           example: __INTERFACE-NAME__
15761         - name: interface-name
15762           in: path
15763           description: Name given to the interface
15764           required: true
15765           type: string
15766           example: __INTERFACE-NAME__
15767         - name: body
15768           in: body
15769           description: l-interface object that needs to be created or updated.
15770           required: true
15771           schema:
15772             $ref: "#/patchDefinitions/l-interface"
15773     delete:
15774       tags:
15775         - CloudInfrastructure
15776       summary: delete an existing l-interface
15777       description: delete an existing l-interface
15778       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15779       consumes:
15780         - application/json
15781         - application/xml
15782       produces:
15783         - application/json
15784         - application/xml
15785       responses:
15786         "default":
15787           description: Response codes found in [response codes](https://wiki.onap.org/).
15788       parameters:
15789         - name: hostname
15790           in: path
15791           description: Value from executing hostname on the compute node.
15792           required: true
15793           type: string
15794           example: __HOSTNAME__
15795         - name: interface-name
15796           in: path
15797           description: Name that identifies the link aggregate interface
15798           required: true
15799           type: string
15800           example: __INTERFACE-NAME__
15801         - name: interface-name
15802           in: path
15803           description: Name given to the interface
15804           required: true
15805           type: string
15806           example: __INTERFACE-NAME__
15807         - name: resource-version
15808           in: query
15809           description: resource-version for concurrency
15810           required: true
15811           type: string
15812   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
15813     get:
15814       tags:
15815         - CloudInfrastructure
15816       summary: returns l-interfaces
15817       description: returns l-interfaces
15818       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
15819       produces:
15820         - application/json
15821         - application/xml
15822       responses:
15823         "200":
15824           description: successful operation
15825           schema:
15826               $ref: "#/getDefinitions/l-interfaces"
15827         "default":
15828           description: Response codes found in [response codes](https://wiki.onap.org/).
15829       parameters:
15830         - name: hostname
15831           in: path
15832           description: Value from executing hostname on the compute node.
15833           required: true
15834           type: string
15835           example: __HOSTNAME__
15836         - name: interface-name
15837           in: path
15838           description: Name that identifies the link aggregate interface
15839           required: true
15840           type: string
15841           example: __INTERFACE-NAME__
15842         - name: inv-status
15843           in: query
15844           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15845           required: false
15846           type: string
15847         - name: pserver-id
15848           in: query
15849           description: ID of Pserver
15850           required: false
15851           type: string
15852         - name: in-maint
15853           in: query
15854           required: false
15855           type: boolean
15856         - name: pserver-name2
15857           in: query
15858           description: alternative pserver name
15859           required: false
15860           type: string
15861         - name: interface-id
15862           in: query
15863           description: ID of interface
15864           required: false
15865           type: string
15866         - name: interface-role
15867           in: query
15868           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15869           required: false
15870           type: string
15871   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
15872     get:
15873       tags:
15874         - CloudInfrastructure
15875       summary: returns lag-interface
15876       description: returns lag-interface
15877       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
15878       produces:
15879         - application/json
15880         - application/xml
15881       responses:
15882         "200":
15883           description: successful operation
15884           schema:
15885               $ref: "#/getDefinitions/lag-interface"
15886         "default":
15887           description: Response codes found in [response codes](https://wiki.onap.org/).
15888       parameters:
15889         - name: hostname
15890           in: path
15891           description: Value from executing hostname on the compute node.
15892           required: true
15893           type: string
15894           example: __HOSTNAME__
15895         - name: interface-name
15896           in: path
15897           description: Name that identifies the link aggregate interface
15898           required: true
15899           type: string
15900           example: __INTERFACE-NAME__
15901         - name: inv-status
15902           in: query
15903           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15904           required: false
15905           type: string
15906         - name: pserver-id
15907           in: query
15908           description: ID of Pserver
15909           required: false
15910           type: string
15911         - name: in-maint
15912           in: query
15913           required: false
15914           type: boolean
15915         - name: pserver-name2
15916           in: query
15917           description: alternative pserver name
15918           required: false
15919           type: string
15920         - name: interface-id
15921           in: query
15922           description: ID of interface
15923           required: false
15924           type: string
15925         - name: interface-role
15926           in: query
15927           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15928           required: false
15929           type: string
15930     put:
15931       tags:
15932         - CloudInfrastructure
15933       summary: create or update an existing lag-interface
15934       description: |
15935         Create or update an existing lag-interface.
15936         #
15937         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15938       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
15939       consumes:
15940         - application/json
15941         - application/xml
15942       produces:
15943         - application/json
15944         - application/xml
15945       responses:
15946         "default":
15947           description: Response codes found in [response codes](https://wiki.onap.org/).
15948       parameters:
15949         - name: hostname
15950           in: path
15951           description: Value from executing hostname on the compute node.
15952           required: true
15953           type: string
15954           example: __HOSTNAME__
15955         - name: interface-name
15956           in: path
15957           description: Name that identifies the link aggregate interface
15958           required: true
15959           type: string
15960           example: __INTERFACE-NAME__
15961         - name: body
15962           in: body
15963           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
15964           required: true
15965           schema:
15966             $ref: "#/definitions/lag-interface"
15967     patch:
15968       tags:
15969         - CloudInfrastructure
15970       summary: update an existing lag-interface
15971       description: |
15972         Update an existing lag-interface
15973         #
15974         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15975         The PUT operation will entirely replace an existing object.
15976         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15977         #
15978         Other differences between PUT and PATCH are:
15979         #
15980         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15981         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15982         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15983       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
15984       consumes:
15985         - application/json
15986         - application/xml
15987       produces:
15988         - application/json
15989         - application/xml
15990       responses:
15991         "default":
15992           description: Response codes found in [response codes](https://wiki.onap.org/).
15993       parameters:
15994         - name: hostname
15995           in: path
15996           description: Value from executing hostname on the compute node.
15997           required: true
15998           type: string
15999           example: __HOSTNAME__
16000         - name: interface-name
16001           in: path
16002           description: Name that identifies the link aggregate interface
16003           required: true
16004           type: string
16005           example: __INTERFACE-NAME__
16006         - name: body
16007           in: body
16008           description: lag-interface object that needs to be created or updated.
16009           required: true
16010           schema:
16011             $ref: "#/patchDefinitions/lag-interface"
16012     delete:
16013       tags:
16014         - CloudInfrastructure
16015       summary: delete an existing lag-interface
16016       description: delete an existing lag-interface
16017       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
16018       consumes:
16019         - application/json
16020         - application/xml
16021       produces:
16022         - application/json
16023         - application/xml
16024       responses:
16025         "default":
16026           description: Response codes found in [response codes](https://wiki.onap.org/).
16027       parameters:
16028         - name: hostname
16029           in: path
16030           description: Value from executing hostname on the compute node.
16031           required: true
16032           type: string
16033           example: __HOSTNAME__
16034         - name: interface-name
16035           in: path
16036           description: Name that identifies the link aggregate interface
16037           required: true
16038           type: string
16039           example: __INTERFACE-NAME__
16040         - name: resource-version
16041           in: query
16042           description: resource-version for concurrency
16043           required: true
16044           type: string
16045   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
16046     get:
16047       tags:
16048         - CloudInfrastructure
16049       summary: returns lag-interfaces
16050       description: returns lag-interfaces
16051       operationId: getCloudInfrastructurePserversPserverLagInterfaces
16052       produces:
16053         - application/json
16054         - application/xml
16055       responses:
16056         "200":
16057           description: successful operation
16058           schema:
16059               $ref: "#/getDefinitions/lag-interfaces"
16060         "default":
16061           description: Response codes found in [response codes](https://wiki.onap.org/).
16062       parameters:
16063         - name: hostname
16064           in: path
16065           description: Value from executing hostname on the compute node.
16066           required: true
16067           type: string
16068           example: __HOSTNAME__
16069         - name: inv-status
16070           in: query
16071           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
16072           required: false
16073           type: string
16074         - name: pserver-id
16075           in: query
16076           description: ID of Pserver
16077           required: false
16078           type: string
16079         - name: in-maint
16080           in: query
16081           required: false
16082           type: boolean
16083         - name: pserver-name2
16084           in: query
16085           description: alternative pserver name
16086           required: false
16087           type: string
16088   /cloud-infrastructure/pservers/pserver/{hostname}:
16089     get:
16090       tags:
16091         - CloudInfrastructure
16092       summary: returns pserver
16093       description: returns pserver
16094       operationId: getCloudInfrastructurePserversPserver
16095       produces:
16096         - application/json
16097         - application/xml
16098       responses:
16099         "200":
16100           description: successful operation
16101           schema:
16102               $ref: "#/getDefinitions/pserver"
16103         "default":
16104           description: Response codes found in [response codes](https://wiki.onap.org/).
16105       parameters:
16106         - name: hostname
16107           in: path
16108           description: Value from executing hostname on the compute node.
16109           required: true
16110           type: string
16111           example: __HOSTNAME__
16112         - name: inv-status
16113           in: query
16114           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
16115           required: false
16116           type: string
16117         - name: pserver-id
16118           in: query
16119           description: ID of Pserver
16120           required: false
16121           type: string
16122         - name: in-maint
16123           in: query
16124           required: false
16125           type: boolean
16126         - name: pserver-name2
16127           in: query
16128           description: alternative pserver name
16129           required: false
16130           type: string
16131     put:
16132       tags:
16133         - CloudInfrastructure
16134       summary: create or update an existing pserver
16135       description: |
16136         Create or update an existing pserver.
16137         #
16138         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16139       operationId: createOrUpdateCloudInfrastructurePserversPserver
16140       consumes:
16141         - application/json
16142         - application/xml
16143       produces:
16144         - application/json
16145         - application/xml
16146       responses:
16147         "default":
16148           description: Response codes found in [response codes](https://wiki.onap.org/).
16149       parameters:
16150         - name: hostname
16151           in: path
16152           description: Value from executing hostname on the compute node.
16153           required: true
16154           type: string
16155           example: __HOSTNAME__
16156         - name: body
16157           in: body
16158           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
16159           required: true
16160           schema:
16161             $ref: "#/definitions/pserver"
16162     patch:
16163       tags:
16164         - CloudInfrastructure
16165       summary: update an existing pserver
16166       description: |
16167         Update an existing pserver
16168         #
16169         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16170         The PUT operation will entirely replace an existing object.
16171         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16172         #
16173         Other differences between PUT and PATCH are:
16174         #
16175         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16176         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16177         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16178       operationId: UpdateCloudInfrastructurePserversPserver
16179       consumes:
16180         - application/json
16181         - application/xml
16182       produces:
16183         - application/json
16184         - application/xml
16185       responses:
16186         "default":
16187           description: Response codes found in [response codes](https://wiki.onap.org/).
16188       parameters:
16189         - name: hostname
16190           in: path
16191           description: Value from executing hostname on the compute node.
16192           required: true
16193           type: string
16194           example: __HOSTNAME__
16195         - name: body
16196           in: body
16197           description: pserver object that needs to be created or updated.
16198           required: true
16199           schema:
16200             $ref: "#/patchDefinitions/pserver"
16201     delete:
16202       tags:
16203         - CloudInfrastructure
16204       summary: delete an existing pserver
16205       description: delete an existing pserver
16206       operationId: deleteCloudInfrastructurePserversPserver
16207       consumes:
16208         - application/json
16209         - application/xml
16210       produces:
16211         - application/json
16212         - application/xml
16213       responses:
16214         "default":
16215           description: Response codes found in [response codes](https://wiki.onap.org/).
16216       parameters:
16217         - name: hostname
16218           in: path
16219           description: Value from executing hostname on the compute node.
16220           required: true
16221           type: string
16222           example: __HOSTNAME__
16223         - name: resource-version
16224           in: query
16225           description: resource-version for concurrency
16226           required: true
16227           type: string
16228   /cloud-infrastructure/pservers:
16229     get:
16230       tags:
16231         - CloudInfrastructure
16232       summary: returns pservers
16233       description: returns pservers
16234       operationId: getCloudInfrastructurePservers
16235       produces:
16236         - application/json
16237         - application/xml
16238       responses:
16239         "200":
16240           description: successful operation
16241           schema:
16242               $ref: "#/getDefinitions/pservers"
16243         "default":
16244           description: Response codes found in [response codes](https://wiki.onap.org/).
16245   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
16246     put:
16247       tags:
16248         - CloudInfrastructure
16249       summary: see node definition for valid relationships
16250       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
16251       consumes:
16252         - application/json
16253         - application/xml
16254       produces:
16255         - application/json
16256         - application/xml
16257       responses:
16258         "default":
16259           description: Response codes found in [response codes](https://wiki.onap.org/).
16260       parameters:
16261         - name: vdc-id
16262           in: path
16263           description: Unique ID of the vdc
16264           required: true
16265           type: string
16266           example: __VDC-ID__
16267         - name: body
16268           in: body
16269           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
16270           required: true
16271           schema:
16272             $ref: "#/definitions/relationship"
16273     delete:
16274       tags:
16275         - CloudInfrastructure
16276       summary: delete an existing relationship
16277       description: delete an existing relationship
16278       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
16279       consumes:
16280         - application/json
16281         - application/xml
16282       produces:
16283         - application/json
16284         - application/xml
16285       responses:
16286         "default":
16287           description: Response codes found in [response codes](https://wiki.onap.org/).
16288       parameters:
16289         - name: vdc-id
16290           in: path
16291           description: Unique ID of the vdc
16292           required: true
16293           type: string
16294           example: __VDC-ID__
16295   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
16296     get:
16297       tags:
16298         - CloudInfrastructure
16299       summary: returns virtual-data-center
16300       description: returns virtual-data-center
16301       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
16302       produces:
16303         - application/json
16304         - application/xml
16305       responses:
16306         "200":
16307           description: successful operation
16308           schema:
16309               $ref: "#/getDefinitions/virtual-data-center"
16310         "default":
16311           description: Response codes found in [response codes](https://wiki.onap.org/).
16312       parameters:
16313         - name: vdc-id
16314           in: path
16315           description: Unique ID of the vdc
16316           required: true
16317           type: string
16318           example: __VDC-ID__
16319         - name: vdc-name
16320           in: query
16321           description: Name of the virtual data center
16322           required: false
16323           type: string
16324     put:
16325       tags:
16326         - CloudInfrastructure
16327       summary: create or update an existing virtual-data-center
16328       description: |
16329         Create or update an existing virtual-data-center.
16330         #
16331         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16332       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
16333       consumes:
16334         - application/json
16335         - application/xml
16336       produces:
16337         - application/json
16338         - application/xml
16339       responses:
16340         "default":
16341           description: Response codes found in [response codes](https://wiki.onap.org/).
16342       parameters:
16343         - name: vdc-id
16344           in: path
16345           description: Unique ID of the vdc
16346           required: true
16347           type: string
16348           example: __VDC-ID__
16349         - name: body
16350           in: body
16351           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
16352           required: true
16353           schema:
16354             $ref: "#/definitions/virtual-data-center"
16355     patch:
16356       tags:
16357         - CloudInfrastructure
16358       summary: update an existing virtual-data-center
16359       description: |
16360         Update an existing virtual-data-center
16361         #
16362         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16363         The PUT operation will entirely replace an existing object.
16364         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16365         #
16366         Other differences between PUT and PATCH are:
16367         #
16368         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16369         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16370         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16371       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
16372       consumes:
16373         - application/json
16374         - application/xml
16375       produces:
16376         - application/json
16377         - application/xml
16378       responses:
16379         "default":
16380           description: Response codes found in [response codes](https://wiki.onap.org/).
16381       parameters:
16382         - name: vdc-id
16383           in: path
16384           description: Unique ID of the vdc
16385           required: true
16386           type: string
16387           example: __VDC-ID__
16388         - name: body
16389           in: body
16390           description: virtual-data-center object that needs to be created or updated.
16391           required: true
16392           schema:
16393             $ref: "#/patchDefinitions/virtual-data-center"
16394     delete:
16395       tags:
16396         - CloudInfrastructure
16397       summary: delete an existing virtual-data-center
16398       description: delete an existing virtual-data-center
16399       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
16400       consumes:
16401         - application/json
16402         - application/xml
16403       produces:
16404         - application/json
16405         - application/xml
16406       responses:
16407         "default":
16408           description: Response codes found in [response codes](https://wiki.onap.org/).
16409       parameters:
16410         - name: vdc-id
16411           in: path
16412           description: Unique ID of the vdc
16413           required: true
16414           type: string
16415           example: __VDC-ID__
16416         - name: resource-version
16417           in: query
16418           description: resource-version for concurrency
16419           required: true
16420           type: string
16421   /cloud-infrastructure/virtual-data-centers:
16422     get:
16423       tags:
16424         - CloudInfrastructure
16425       summary: returns virtual-data-centers
16426       description: returns virtual-data-centers
16427       operationId: getCloudInfrastructureVirtualDataCenters
16428       produces:
16429         - application/json
16430         - application/xml
16431       responses:
16432         "200":
16433           description: successful operation
16434           schema:
16435               $ref: "#/getDefinitions/virtual-data-centers"
16436         "default":
16437           description: Response codes found in [response codes](https://wiki.onap.org/).
16438   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
16439     put:
16440       tags:
16441         - CloudInfrastructure
16442       summary: see node definition for valid relationships
16443       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
16444       consumes:
16445         - application/json
16446         - application/xml
16447       produces:
16448         - application/json
16449         - application/xml
16450       responses:
16451         "default":
16452           description: Response codes found in [response codes](https://wiki.onap.org/).
16453       parameters:
16454         - name: operational-environment-id
16455           in: path
16456           description: UUID of an operational environment
16457           required: true
16458           type: string
16459           example: __OPERATIONAL-ENVIRONMENT-ID__
16460         - name: body
16461           in: body
16462           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
16463           required: true
16464           schema:
16465             $ref: "#/definitions/relationship"
16466     delete:
16467       tags:
16468         - CloudInfrastructure
16469       summary: delete an existing relationship
16470       description: delete an existing relationship
16471       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
16472       consumes:
16473         - application/json
16474         - application/xml
16475       produces:
16476         - application/json
16477         - application/xml
16478       responses:
16479         "default":
16480           description: Response codes found in [response codes](https://wiki.onap.org/).
16481       parameters:
16482         - name: operational-environment-id
16483           in: path
16484           description: UUID of an operational environment
16485           required: true
16486           type: string
16487           example: __OPERATIONAL-ENVIRONMENT-ID__
16488   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
16489     get:
16490       tags:
16491         - CloudInfrastructure
16492       summary: returns operational-environment
16493       description: returns operational-environment
16494       operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16495       produces:
16496         - application/json
16497         - application/xml
16498       responses:
16499         "200":
16500           description: successful operation
16501           schema:
16502               $ref: "#/getDefinitions/operational-environment"
16503         "default":
16504           description: Response codes found in [response codes](https://wiki.onap.org/).
16505       parameters:
16506         - name: operational-environment-id
16507           in: path
16508           description: UUID of an operational environment
16509           required: true
16510           type: string
16511           example: __OPERATIONAL-ENVIRONMENT-ID__
16512     put:
16513       tags:
16514         - CloudInfrastructure
16515       summary: create or update an existing operational-environment
16516       description: |
16517         Create or update an existing operational-environment.
16518         #
16519         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16520       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16521       consumes:
16522         - application/json
16523         - application/xml
16524       produces:
16525         - application/json
16526         - application/xml
16527       responses:
16528         "default":
16529           description: Response codes found in [response codes](https://wiki.onap.org/).
16530       parameters:
16531         - name: operational-environment-id
16532           in: path
16533           description: UUID of an operational environment
16534           required: true
16535           type: string
16536           example: __OPERATIONAL-ENVIRONMENT-ID__
16537         - name: body
16538           in: body
16539           description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
16540           required: true
16541           schema:
16542             $ref: "#/definitions/operational-environment"
16543     patch:
16544       tags:
16545         - CloudInfrastructure
16546       summary: update an existing operational-environment
16547       description: |
16548         Update an existing operational-environment
16549         #
16550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16551         The PUT operation will entirely replace an existing object.
16552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16553         #
16554         Other differences between PUT and PATCH are:
16555         #
16556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16559       operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16560       consumes:
16561         - application/json
16562         - application/xml
16563       produces:
16564         - application/json
16565         - application/xml
16566       responses:
16567         "default":
16568           description: Response codes found in [response codes](https://wiki.onap.org/).
16569       parameters:
16570         - name: operational-environment-id
16571           in: path
16572           description: UUID of an operational environment
16573           required: true
16574           type: string
16575           example: __OPERATIONAL-ENVIRONMENT-ID__
16576         - name: body
16577           in: body
16578           description: operational-environment object that needs to be created or updated.
16579           required: true
16580           schema:
16581             $ref: "#/patchDefinitions/operational-environment"
16582     delete:
16583       tags:
16584         - CloudInfrastructure
16585       summary: delete an existing operational-environment
16586       description: delete an existing operational-environment
16587       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16588       consumes:
16589         - application/json
16590         - application/xml
16591       produces:
16592         - application/json
16593         - application/xml
16594       responses:
16595         "default":
16596           description: Response codes found in [response codes](https://wiki.onap.org/).
16597       parameters:
16598         - name: operational-environment-id
16599           in: path
16600           description: UUID of an operational environment
16601           required: true
16602           type: string
16603           example: __OPERATIONAL-ENVIRONMENT-ID__
16604         - name: resource-version
16605           in: query
16606           description: resource-version for concurrency
16607           required: true
16608           type: string
16609   /cloud-infrastructure/operational-environments:
16610     get:
16611       tags:
16612         - CloudInfrastructure
16613       summary: returns operational-environments
16614       description: returns operational-environments
16615       operationId: getCloudInfrastructureOperationalEnvironments
16616       produces:
16617         - application/json
16618         - application/xml
16619       responses:
16620         "200":
16621           description: successful operation
16622           schema:
16623               $ref: "#/getDefinitions/operational-environments"
16624         "default":
16625           description: Response codes found in [response codes](https://wiki.onap.org/).
16626   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
16627     put:
16628       tags:
16629         - Business
16630       summary: see node definition for valid relationships
16631       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
16632       consumes:
16633         - application/json
16634         - application/xml
16635       produces:
16636         - application/json
16637         - application/xml
16638       responses:
16639         "default":
16640           description: Response codes found in [response codes](https://wiki.onap.org/).
16641       parameters:
16642         - name: resource-instance-id
16643           in: path
16644           description: Unique id of resource instance.
16645           required: true
16646           type: string
16647           example: __RESOURCE-INSTANCE-ID__
16648         - name: body
16649           in: body
16650           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
16651           required: true
16652           schema:
16653             $ref: "#/definitions/relationship"
16654     delete:
16655       tags:
16656         - Business
16657       summary: delete an existing relationship
16658       description: delete an existing relationship
16659       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
16660       consumes:
16661         - application/json
16662         - application/xml
16663       produces:
16664         - application/json
16665         - application/xml
16666       responses:
16667         "default":
16668           description: Response codes found in [response codes](https://wiki.onap.org/).
16669       parameters:
16670         - name: resource-instance-id
16671           in: path
16672           description: Unique id of resource instance.
16673           required: true
16674           type: string
16675           example: __RESOURCE-INSTANCE-ID__
16676   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
16677     get:
16678       tags:
16679         - Business
16680       summary: returns metadatum
16681       description: returns metadatum
16682       operationId: getBusinessConnectorsConnectorMetadataMetadatum
16683       produces:
16684         - application/json
16685         - application/xml
16686       responses:
16687         "200":
16688           description: successful operation
16689           schema:
16690               $ref: "#/getDefinitions/metadatum"
16691         "default":
16692           description: Response codes found in [response codes](https://wiki.onap.org/).
16693       parameters:
16694         - name: resource-instance-id
16695           in: path
16696           description: Unique id of resource instance.
16697           required: true
16698           type: string
16699           example: __RESOURCE-INSTANCE-ID__
16700         - name: metaname
16701           in: path
16702           required: true
16703           type: string
16704           example: __METANAME__
16705         - name: model-invariant-id
16706           in: query
16707           description: the ASDC model id for this resource or service model.
16708           required: false
16709           type: string
16710         - name: model-version-id
16711           in: query
16712           description: the ASDC model version for this resource or service model.
16713           required: false
16714           type: string
16715         - name: widget-model-id
16716           in: query
16717           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16718           required: false
16719           type: string
16720         - name: widget-model-version
16721           in: query
16722           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16723           required: false
16724           type: string
16725     put:
16726       tags:
16727         - Business
16728       summary: create or update an existing metadatum
16729       description: |
16730         Create or update an existing metadatum.
16731         #
16732         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16733       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
16734       consumes:
16735         - application/json
16736         - application/xml
16737       produces:
16738         - application/json
16739         - application/xml
16740       responses:
16741         "default":
16742           description: Response codes found in [response codes](https://wiki.onap.org/).
16743       parameters:
16744         - name: resource-instance-id
16745           in: path
16746           description: Unique id of resource instance.
16747           required: true
16748           type: string
16749           example: __RESOURCE-INSTANCE-ID__
16750         - name: metaname
16751           in: path
16752           required: true
16753           type: string
16754           example: __METANAME__
16755         - name: body
16756           in: body
16757           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)
16758           required: true
16759           schema:
16760             $ref: "#/definitions/metadatum"
16761     patch:
16762       tags:
16763         - Business
16764       summary: update an existing metadatum
16765       description: |
16766         Update an existing metadatum
16767         #
16768         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16769         The PUT operation will entirely replace an existing object.
16770         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16771         #
16772         Other differences between PUT and PATCH are:
16773         #
16774         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16775         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16776         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16777       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
16778       consumes:
16779         - application/json
16780         - application/xml
16781       produces:
16782         - application/json
16783         - application/xml
16784       responses:
16785         "default":
16786           description: Response codes found in [response codes](https://wiki.onap.org/).
16787       parameters:
16788         - name: resource-instance-id
16789           in: path
16790           description: Unique id of resource instance.
16791           required: true
16792           type: string
16793           example: __RESOURCE-INSTANCE-ID__
16794         - name: metaname
16795           in: path
16796           required: true
16797           type: string
16798           example: __METANAME__
16799         - name: body
16800           in: body
16801           description: metadatum object that needs to be created or updated.
16802           required: true
16803           schema:
16804             $ref: "#/patchDefinitions/metadatum"
16805     delete:
16806       tags:
16807         - Business
16808       summary: delete an existing metadatum
16809       description: delete an existing metadatum
16810       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
16811       consumes:
16812         - application/json
16813         - application/xml
16814       produces:
16815         - application/json
16816         - application/xml
16817       responses:
16818         "default":
16819           description: Response codes found in [response codes](https://wiki.onap.org/).
16820       parameters:
16821         - name: resource-instance-id
16822           in: path
16823           description: Unique id of resource instance.
16824           required: true
16825           type: string
16826           example: __RESOURCE-INSTANCE-ID__
16827         - name: metaname
16828           in: path
16829           required: true
16830           type: string
16831           example: __METANAME__
16832         - name: resource-version
16833           in: query
16834           description: resource-version for concurrency
16835           required: true
16836           type: string
16837   /business/connectors/connector/{resource-instance-id}/metadata:
16838     get:
16839       tags:
16840         - Business
16841       summary: returns metadata
16842       description: returns metadata
16843       operationId: getBusinessConnectorsConnectorMetadata
16844       produces:
16845         - application/json
16846         - application/xml
16847       responses:
16848         "200":
16849           description: successful operation
16850           schema:
16851               $ref: "#/getDefinitions/metadata"
16852         "default":
16853           description: Response codes found in [response codes](https://wiki.onap.org/).
16854       parameters:
16855         - name: resource-instance-id
16856           in: path
16857           description: Unique id of resource instance.
16858           required: true
16859           type: string
16860           example: __RESOURCE-INSTANCE-ID__
16861         - name: model-invariant-id
16862           in: query
16863           description: the ASDC model id for this resource or service model.
16864           required: false
16865           type: string
16866         - name: model-version-id
16867           in: query
16868           description: the ASDC model version for this resource or service model.
16869           required: false
16870           type: string
16871         - name: widget-model-id
16872           in: query
16873           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16874           required: false
16875           type: string
16876         - name: widget-model-version
16877           in: query
16878           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16879           required: false
16880           type: string
16881   /business/connectors/connector/{resource-instance-id}:
16882     get:
16883       tags:
16884         - Business
16885       summary: returns connector
16886       description: returns connector
16887       operationId: getBusinessConnectorsConnector
16888       produces:
16889         - application/json
16890         - application/xml
16891       responses:
16892         "200":
16893           description: successful operation
16894           schema:
16895               $ref: "#/getDefinitions/connector"
16896         "default":
16897           description: Response codes found in [response codes](https://wiki.onap.org/).
16898       parameters:
16899         - name: resource-instance-id
16900           in: path
16901           description: Unique id of resource instance.
16902           required: true
16903           type: string
16904           example: __RESOURCE-INSTANCE-ID__
16905         - name: model-invariant-id
16906           in: query
16907           description: the ASDC model id for this resource or service model.
16908           required: false
16909           type: string
16910         - name: model-version-id
16911           in: query
16912           description: the ASDC model version for this resource or service model.
16913           required: false
16914           type: string
16915         - name: widget-model-id
16916           in: query
16917           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16918           required: false
16919           type: string
16920         - name: widget-model-version
16921           in: query
16922           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16923           required: false
16924           type: string
16925     put:
16926       tags:
16927         - Business
16928       summary: create or update an existing connector
16929       description: |
16930         Create or update an existing connector.
16931         #
16932         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16933       operationId: createOrUpdateBusinessConnectorsConnector
16934       consumes:
16935         - application/json
16936         - application/xml
16937       produces:
16938         - application/json
16939         - application/xml
16940       responses:
16941         "default":
16942           description: Response codes found in [response codes](https://wiki.onap.org/).
16943       parameters:
16944         - name: resource-instance-id
16945           in: path
16946           description: Unique id of resource instance.
16947           required: true
16948           type: string
16949           example: __RESOURCE-INSTANCE-ID__
16950         - name: body
16951           in: body
16952           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
16953           required: true
16954           schema:
16955             $ref: "#/definitions/connector"
16956     patch:
16957       tags:
16958         - Business
16959       summary: update an existing connector
16960       description: |
16961         Update an existing connector
16962         #
16963         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16964         The PUT operation will entirely replace an existing object.
16965         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16966         #
16967         Other differences between PUT and PATCH are:
16968         #
16969         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16970         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16971         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16972       operationId: UpdateBusinessConnectorsConnector
16973       consumes:
16974         - application/json
16975         - application/xml
16976       produces:
16977         - application/json
16978         - application/xml
16979       responses:
16980         "default":
16981           description: Response codes found in [response codes](https://wiki.onap.org/).
16982       parameters:
16983         - name: resource-instance-id
16984           in: path
16985           description: Unique id of resource instance.
16986           required: true
16987           type: string
16988           example: __RESOURCE-INSTANCE-ID__
16989         - name: body
16990           in: body
16991           description: connector object that needs to be created or updated.
16992           required: true
16993           schema:
16994             $ref: "#/patchDefinitions/connector"
16995     delete:
16996       tags:
16997         - Business
16998       summary: delete an existing connector
16999       description: delete an existing connector
17000       operationId: deleteBusinessConnectorsConnector
17001       consumes:
17002         - application/json
17003         - application/xml
17004       produces:
17005         - application/json
17006         - application/xml
17007       responses:
17008         "default":
17009           description: Response codes found in [response codes](https://wiki.onap.org/).
17010       parameters:
17011         - name: resource-instance-id
17012           in: path
17013           description: Unique id of resource instance.
17014           required: true
17015           type: string
17016           example: __RESOURCE-INSTANCE-ID__
17017         - name: resource-version
17018           in: query
17019           description: resource-version for concurrency
17020           required: true
17021           type: string
17022   /business/connectors:
17023     get:
17024       tags:
17025         - Business
17026       summary: returns connectors
17027       description: returns connectors
17028       operationId: getBusinessConnectors
17029       produces:
17030         - application/json
17031         - application/xml
17032       responses:
17033         "200":
17034           description: successful operation
17035           schema:
17036               $ref: "#/getDefinitions/connectors"
17037         "default":
17038           description: Response codes found in [response codes](https://wiki.onap.org/).
17039   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
17040     put:
17041       tags:
17042         - Business
17043       summary: see node definition for valid relationships
17044       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
17045       consumes:
17046         - application/json
17047         - application/xml
17048       produces:
17049         - application/json
17050         - application/xml
17051       responses:
17052         "default":
17053           description: Response codes found in [response codes](https://wiki.onap.org/).
17054       parameters:
17055         - name: global-customer-id
17056           in: path
17057           description: Global customer id used across ECOMP to uniquely identify customer.
17058           required: true
17059           type: string
17060           example: __GLOBAL-CUSTOMER-ID__
17061         - name: service-type
17062           in: path
17063           description: Value defined by orchestration to identify this service across ECOMP.
17064           required: true
17065           type: string
17066           example: __SERVICE-TYPE__
17067         - name: service-instance-id
17068           in: path
17069           description: Uniquely identifies this instance of a service
17070           required: true
17071           type: string
17072           example: __SERVICE-INSTANCE-ID__
17073         - name: body
17074           in: body
17075           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
17076           required: true
17077           schema:
17078             $ref: "#/definitions/relationship"
17079     delete:
17080       tags:
17081         - Business
17082       summary: delete an existing relationship
17083       description: delete an existing relationship
17084       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
17085       consumes:
17086         - application/json
17087         - application/xml
17088       produces:
17089         - application/json
17090         - application/xml
17091       responses:
17092         "default":
17093           description: Response codes found in [response codes](https://wiki.onap.org/).
17094       parameters:
17095         - name: global-customer-id
17096           in: path
17097           description: Global customer id used across ECOMP to uniquely identify customer.
17098           required: true
17099           type: string
17100           example: __GLOBAL-CUSTOMER-ID__
17101         - name: service-type
17102           in: path
17103           description: Value defined by orchestration to identify this service across ECOMP.
17104           required: true
17105           type: string
17106           example: __SERVICE-TYPE__
17107         - name: service-instance-id
17108           in: path
17109           description: Uniquely identifies this instance of a service
17110           required: true
17111           type: string
17112           example: __SERVICE-INSTANCE-ID__
17113   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
17114     get:
17115       tags:
17116         - Business
17117       summary: returns metadatum
17118       description: returns metadatum
17119       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
17120       produces:
17121         - application/json
17122         - application/xml
17123       responses:
17124         "200":
17125           description: successful operation
17126           schema:
17127               $ref: "#/getDefinitions/metadatum"
17128         "default":
17129           description: Response codes found in [response codes](https://wiki.onap.org/).
17130       parameters:
17131         - name: global-customer-id
17132           in: path
17133           description: Global customer id used across ECOMP to uniquely identify customer.
17134           required: true
17135           type: string
17136           example: __GLOBAL-CUSTOMER-ID__
17137         - name: service-type
17138           in: path
17139           description: Value defined by orchestration to identify this service across ECOMP.
17140           required: true
17141           type: string
17142           example: __SERVICE-TYPE__
17143         - name: service-instance-id
17144           in: path
17145           description: Uniquely identifies this instance of a service
17146           required: true
17147           type: string
17148           example: __SERVICE-INSTANCE-ID__
17149         - name: metaname
17150           in: path
17151           required: true
17152           type: string
17153           example: __METANAME__
17154         - name: subscriber-name
17155           in: query
17156           description: Subscriber name, an alternate way to retrieve a customer.
17157           required: false
17158           type: string
17159         - name: subscriber-type
17160           in: query
17161           description: Subscriber type, a way to provide VID with only the INFRA customers.
17162           required: false
17163           type: string
17164         - name: service-instance-name
17165           in: query
17166           description: This field will store a name assigned to the service-instance.
17167           required: false
17168           type: string
17169         - name: environment-context
17170           in: query
17171           description: This field will store the environment context assigned to the service-instance.
17172           required: false
17173           type: string
17174         - name: workload-context
17175           in: query
17176           description: This field will store the workload context assigned to the service-instance.
17177           required: false
17178           type: string
17179         - name: model-invariant-id
17180           in: query
17181           description: the ASDC model id for this resource or service model.
17182           required: false
17183           type: string
17184         - name: model-version-id
17185           in: query
17186           description: the ASDC model version for this resource or service model.
17187           required: false
17188           type: string
17189         - name: widget-model-id
17190           in: query
17191           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17192           required: false
17193           type: string
17194         - name: widget-model-version
17195           in: query
17196           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17197           required: false
17198           type: string
17199         - name: service-instance-location-id
17200           in: query
17201           description: An identifier that customers assign to the location where this service is being used.
17202           required: false
17203           type: string
17204         - name: orchestration-status
17205           in: query
17206           description: Orchestration status of this service.
17207           required: false
17208           type: string
17209     put:
17210       tags:
17211         - Business
17212       summary: create or update an existing metadatum
17213       description: |
17214         Create or update an existing metadatum.
17215         #
17216         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17217       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
17218       consumes:
17219         - application/json
17220         - application/xml
17221       produces:
17222         - application/json
17223         - application/xml
17224       responses:
17225         "default":
17226           description: Response codes found in [response codes](https://wiki.onap.org/).
17227       parameters:
17228         - name: global-customer-id
17229           in: path
17230           description: Global customer id used across ECOMP to uniquely identify customer.
17231           required: true
17232           type: string
17233           example: __GLOBAL-CUSTOMER-ID__
17234         - name: service-type
17235           in: path
17236           description: Value defined by orchestration to identify this service across ECOMP.
17237           required: true
17238           type: string
17239           example: __SERVICE-TYPE__
17240         - name: service-instance-id
17241           in: path
17242           description: Uniquely identifies this instance of a service
17243           required: true
17244           type: string
17245           example: __SERVICE-INSTANCE-ID__
17246         - name: metaname
17247           in: path
17248           required: true
17249           type: string
17250           example: __METANAME__
17251         - name: body
17252           in: body
17253           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
17254           required: true
17255           schema:
17256             $ref: "#/definitions/metadatum"
17257     patch:
17258       tags:
17259         - Business
17260       summary: update an existing metadatum
17261       description: |
17262         Update an existing metadatum
17263         #
17264         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17265         The PUT operation will entirely replace an existing object.
17266         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17267         #
17268         Other differences between PUT and PATCH are:
17269         #
17270         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17271         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17272         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17273       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
17274       consumes:
17275         - application/json
17276         - application/xml
17277       produces:
17278         - application/json
17279         - application/xml
17280       responses:
17281         "default":
17282           description: Response codes found in [response codes](https://wiki.onap.org/).
17283       parameters:
17284         - name: global-customer-id
17285           in: path
17286           description: Global customer id used across ECOMP to uniquely identify customer.
17287           required: true
17288           type: string
17289           example: __GLOBAL-CUSTOMER-ID__
17290         - name: service-type
17291           in: path
17292           description: Value defined by orchestration to identify this service across ECOMP.
17293           required: true
17294           type: string
17295           example: __SERVICE-TYPE__
17296         - name: service-instance-id
17297           in: path
17298           description: Uniquely identifies this instance of a service
17299           required: true
17300           type: string
17301           example: __SERVICE-INSTANCE-ID__
17302         - name: metaname
17303           in: path
17304           required: true
17305           type: string
17306           example: __METANAME__
17307         - name: body
17308           in: body
17309           description: metadatum object that needs to be created or updated.
17310           required: true
17311           schema:
17312             $ref: "#/patchDefinitions/metadatum"
17313     delete:
17314       tags:
17315         - Business
17316       summary: delete an existing metadatum
17317       description: delete an existing metadatum
17318       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
17319       consumes:
17320         - application/json
17321         - application/xml
17322       produces:
17323         - application/json
17324         - application/xml
17325       responses:
17326         "default":
17327           description: Response codes found in [response codes](https://wiki.onap.org/).
17328       parameters:
17329         - name: global-customer-id
17330           in: path
17331           description: Global customer id used across ECOMP to uniquely identify customer.
17332           required: true
17333           type: string
17334           example: __GLOBAL-CUSTOMER-ID__
17335         - name: service-type
17336           in: path
17337           description: Value defined by orchestration to identify this service across ECOMP.
17338           required: true
17339           type: string
17340           example: __SERVICE-TYPE__
17341         - name: service-instance-id
17342           in: path
17343           description: Uniquely identifies this instance of a service
17344           required: true
17345           type: string
17346           example: __SERVICE-INSTANCE-ID__
17347         - name: metaname
17348           in: path
17349           required: true
17350           type: string
17351           example: __METANAME__
17352         - name: resource-version
17353           in: query
17354           description: resource-version for concurrency
17355           required: true
17356           type: string
17357   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
17358     get:
17359       tags:
17360         - Business
17361       summary: returns metadata
17362       description: returns metadata
17363       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
17364       produces:
17365         - application/json
17366         - application/xml
17367       responses:
17368         "200":
17369           description: successful operation
17370           schema:
17371               $ref: "#/getDefinitions/metadata"
17372         "default":
17373           description: Response codes found in [response codes](https://wiki.onap.org/).
17374       parameters:
17375         - name: global-customer-id
17376           in: path
17377           description: Global customer id used across ECOMP to uniquely identify customer.
17378           required: true
17379           type: string
17380           example: __GLOBAL-CUSTOMER-ID__
17381         - name: service-type
17382           in: path
17383           description: Value defined by orchestration to identify this service across ECOMP.
17384           required: true
17385           type: string
17386           example: __SERVICE-TYPE__
17387         - name: service-instance-id
17388           in: path
17389           description: Uniquely identifies this instance of a service
17390           required: true
17391           type: string
17392           example: __SERVICE-INSTANCE-ID__
17393         - name: subscriber-name
17394           in: query
17395           description: Subscriber name, an alternate way to retrieve a customer.
17396           required: false
17397           type: string
17398         - name: subscriber-type
17399           in: query
17400           description: Subscriber type, a way to provide VID with only the INFRA customers.
17401           required: false
17402           type: string
17403         - name: service-instance-name
17404           in: query
17405           description: This field will store a name assigned to the service-instance.
17406           required: false
17407           type: string
17408         - name: environment-context
17409           in: query
17410           description: This field will store the environment context assigned to the service-instance.
17411           required: false
17412           type: string
17413         - name: workload-context
17414           in: query
17415           description: This field will store the workload context assigned to the service-instance.
17416           required: false
17417           type: string
17418         - name: model-invariant-id
17419           in: query
17420           description: the ASDC model id for this resource or service model.
17421           required: false
17422           type: string
17423         - name: model-version-id
17424           in: query
17425           description: the ASDC model version for this resource or service model.
17426           required: false
17427           type: string
17428         - name: widget-model-id
17429           in: query
17430           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17431           required: false
17432           type: string
17433         - name: widget-model-version
17434           in: query
17435           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17436           required: false
17437           type: string
17438         - name: service-instance-location-id
17439           in: query
17440           description: An identifier that customers assign to the location where this service is being used.
17441           required: false
17442           type: string
17443         - name: orchestration-status
17444           in: query
17445           description: Orchestration status of this service.
17446           required: false
17447           type: string
17448   /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:
17449     put:
17450       tags:
17451         - Business
17452       summary: see node definition for valid relationships
17453       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
17454       consumes:
17455         - application/json
17456         - application/xml
17457       produces:
17458         - application/json
17459         - application/xml
17460       responses:
17461         "default":
17462           description: Response codes found in [response codes](https://wiki.onap.org/).
17463       parameters:
17464         - name: global-customer-id
17465           in: path
17466           description: Global customer id used across ECOMP to uniquely identify customer.
17467           required: true
17468           type: string
17469           example: __GLOBAL-CUSTOMER-ID__
17470         - name: service-type
17471           in: path
17472           description: Value defined by orchestration to identify this service across ECOMP.
17473           required: true
17474           type: string
17475           example: __SERVICE-TYPE__
17476         - name: service-instance-id
17477           in: path
17478           description: Uniquely identifies this instance of a service
17479           required: true
17480           type: string
17481           example: __SERVICE-INSTANCE-ID__
17482         - name: id
17483           in: path
17484           description: Allotted Resource id UUID assigned to this instance.
17485           required: true
17486           type: string
17487           example: __ID__
17488         - name: id
17489           in: path
17490           description: Allotted Resource id UUID assigned to this instance.
17491           required: true
17492           type: string
17493           example: __ID__
17494         - name: body
17495           in: body
17496           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
17497           required: true
17498           schema:
17499             $ref: "#/definitions/relationship"
17500     delete:
17501       tags:
17502         - Business
17503       summary: delete an existing relationship
17504       description: delete an existing relationship
17505       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
17506       consumes:
17507         - application/json
17508         - application/xml
17509       produces:
17510         - application/json
17511         - application/xml
17512       responses:
17513         "default":
17514           description: Response codes found in [response codes](https://wiki.onap.org/).
17515       parameters:
17516         - name: global-customer-id
17517           in: path
17518           description: Global customer id used across ECOMP to uniquely identify customer.
17519           required: true
17520           type: string
17521           example: __GLOBAL-CUSTOMER-ID__
17522         - name: service-type
17523           in: path
17524           description: Value defined by orchestration to identify this service across ECOMP.
17525           required: true
17526           type: string
17527           example: __SERVICE-TYPE__
17528         - name: service-instance-id
17529           in: path
17530           description: Uniquely identifies this instance of a service
17531           required: true
17532           type: string
17533           example: __SERVICE-INSTANCE-ID__
17534         - name: id
17535           in: path
17536           description: Allotted Resource id UUID assigned to this instance.
17537           required: true
17538           type: string
17539           example: __ID__
17540         - name: id
17541           in: path
17542           description: Allotted Resource id UUID assigned to this instance.
17543           required: true
17544           type: string
17545           example: __ID__
17546   /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}:
17547     get:
17548       tags:
17549         - Business
17550       summary: returns tunnel-xconnect
17551       description: returns tunnel-xconnect
17552       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17553       produces:
17554         - application/json
17555         - application/xml
17556       responses:
17557         "200":
17558           description: successful operation
17559           schema:
17560               $ref: "#/getDefinitions/tunnel-xconnect"
17561         "default":
17562           description: Response codes found in [response codes](https://wiki.onap.org/).
17563       parameters:
17564         - name: global-customer-id
17565           in: path
17566           description: Global customer id used across ECOMP to uniquely identify customer.
17567           required: true
17568           type: string
17569           example: __GLOBAL-CUSTOMER-ID__
17570         - name: service-type
17571           in: path
17572           description: Value defined by orchestration to identify this service across ECOMP.
17573           required: true
17574           type: string
17575           example: __SERVICE-TYPE__
17576         - name: service-instance-id
17577           in: path
17578           description: Uniquely identifies this instance of a service
17579           required: true
17580           type: string
17581           example: __SERVICE-INSTANCE-ID__
17582         - name: id
17583           in: path
17584           description: Allotted Resource id UUID assigned to this instance.
17585           required: true
17586           type: string
17587           example: __ID__
17588         - name: id
17589           in: path
17590           description: Allotted Resource id UUID assigned to this instance.
17591           required: true
17592           type: string
17593           example: __ID__
17594         - name: subscriber-name
17595           in: query
17596           description: Subscriber name, an alternate way to retrieve a customer.
17597           required: false
17598           type: string
17599         - name: subscriber-type
17600           in: query
17601           description: Subscriber type, a way to provide VID with only the INFRA customers.
17602           required: false
17603           type: string
17604         - name: service-instance-name
17605           in: query
17606           description: This field will store a name assigned to the service-instance.
17607           required: false
17608           type: string
17609         - name: environment-context
17610           in: query
17611           description: This field will store the environment context assigned to the service-instance.
17612           required: false
17613           type: string
17614         - name: workload-context
17615           in: query
17616           description: This field will store the workload context assigned to the service-instance.
17617           required: false
17618           type: string
17619         - name: model-invariant-id
17620           in: query
17621           description: the ASDC model id for this resource or service model.
17622           required: false
17623           type: string
17624         - name: model-version-id
17625           in: query
17626           description: the ASDC model version for this resource or service model.
17627           required: false
17628           type: string
17629         - name: widget-model-id
17630           in: query
17631           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17632           required: false
17633           type: string
17634         - name: widget-model-version
17635           in: query
17636           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17637           required: false
17638           type: string
17639         - name: service-instance-location-id
17640           in: query
17641           description: An identifier that customers assign to the location where this service is being used.
17642           required: false
17643           type: string
17644         - name: orchestration-status
17645           in: query
17646           description: Orchestration status of this service.
17647           required: false
17648           type: string
17649         - name: model-invariant-id
17650           in: query
17651           description: the ASDC model id for this resource or service model.
17652           required: false
17653           type: string
17654         - name: model-version-id
17655           in: query
17656           description: the ASDC model version for this resource or service model.
17657           required: false
17658           type: string
17659         - name: type
17660           in: query
17661           description: Generic description of the type of allotted resource.
17662           required: false
17663           type: string
17664         - name: role
17665           in: query
17666           description: role in the network that this resource will be providing.
17667           required: false
17668           type: string
17669     put:
17670       tags:
17671         - Business
17672       summary: create or update an existing tunnel-xconnect
17673       description: |
17674         Create or update an existing tunnel-xconnect.
17675         #
17676         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17677       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17678       consumes:
17679         - application/json
17680         - application/xml
17681       produces:
17682         - application/json
17683         - application/xml
17684       responses:
17685         "default":
17686           description: Response codes found in [response codes](https://wiki.onap.org/).
17687       parameters:
17688         - name: global-customer-id
17689           in: path
17690           description: Global customer id used across ECOMP to uniquely identify customer.
17691           required: true
17692           type: string
17693           example: __GLOBAL-CUSTOMER-ID__
17694         - name: service-type
17695           in: path
17696           description: Value defined by orchestration to identify this service across ECOMP.
17697           required: true
17698           type: string
17699           example: __SERVICE-TYPE__
17700         - name: service-instance-id
17701           in: path
17702           description: Uniquely identifies this instance of a service
17703           required: true
17704           type: string
17705           example: __SERVICE-INSTANCE-ID__
17706         - name: id
17707           in: path
17708           description: Allotted Resource id UUID assigned to this instance.
17709           required: true
17710           type: string
17711           example: __ID__
17712         - name: id
17713           in: path
17714           description: Allotted Resource id UUID assigned to this instance.
17715           required: true
17716           type: string
17717           example: __ID__
17718         - name: body
17719           in: body
17720           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
17721           required: true
17722           schema:
17723             $ref: "#/definitions/tunnel-xconnect"
17724     patch:
17725       tags:
17726         - Business
17727       summary: update an existing tunnel-xconnect
17728       description: |
17729         Update an existing tunnel-xconnect
17730         #
17731         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17732         The PUT operation will entirely replace an existing object.
17733         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17734         #
17735         Other differences between PUT and PATCH are:
17736         #
17737         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17738         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17739         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17740       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17741       consumes:
17742         - application/json
17743         - application/xml
17744       produces:
17745         - application/json
17746         - application/xml
17747       responses:
17748         "default":
17749           description: Response codes found in [response codes](https://wiki.onap.org/).
17750       parameters:
17751         - name: global-customer-id
17752           in: path
17753           description: Global customer id used across ECOMP to uniquely identify customer.
17754           required: true
17755           type: string
17756           example: __GLOBAL-CUSTOMER-ID__
17757         - name: service-type
17758           in: path
17759           description: Value defined by orchestration to identify this service across ECOMP.
17760           required: true
17761           type: string
17762           example: __SERVICE-TYPE__
17763         - name: service-instance-id
17764           in: path
17765           description: Uniquely identifies this instance of a service
17766           required: true
17767           type: string
17768           example: __SERVICE-INSTANCE-ID__
17769         - name: id
17770           in: path
17771           description: Allotted Resource id UUID assigned to this instance.
17772           required: true
17773           type: string
17774           example: __ID__
17775         - name: id
17776           in: path
17777           description: Allotted Resource id UUID assigned to this instance.
17778           required: true
17779           type: string
17780           example: __ID__
17781         - name: body
17782           in: body
17783           description: tunnel-xconnect object that needs to be created or updated.
17784           required: true
17785           schema:
17786             $ref: "#/patchDefinitions/tunnel-xconnect"
17787     delete:
17788       tags:
17789         - Business
17790       summary: delete an existing tunnel-xconnect
17791       description: delete an existing tunnel-xconnect
17792       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17793       consumes:
17794         - application/json
17795         - application/xml
17796       produces:
17797         - application/json
17798         - application/xml
17799       responses:
17800         "default":
17801           description: Response codes found in [response codes](https://wiki.onap.org/).
17802       parameters:
17803         - name: global-customer-id
17804           in: path
17805           description: Global customer id used across ECOMP to uniquely identify customer.
17806           required: true
17807           type: string
17808           example: __GLOBAL-CUSTOMER-ID__
17809         - name: service-type
17810           in: path
17811           description: Value defined by orchestration to identify this service across ECOMP.
17812           required: true
17813           type: string
17814           example: __SERVICE-TYPE__
17815         - name: service-instance-id
17816           in: path
17817           description: Uniquely identifies this instance of a service
17818           required: true
17819           type: string
17820           example: __SERVICE-INSTANCE-ID__
17821         - name: id
17822           in: path
17823           description: Allotted Resource id UUID assigned to this instance.
17824           required: true
17825           type: string
17826           example: __ID__
17827         - name: id
17828           in: path
17829           description: Allotted Resource id UUID assigned to this instance.
17830           required: true
17831           type: string
17832           example: __ID__
17833         - name: resource-version
17834           in: query
17835           description: resource-version for concurrency
17836           required: true
17837           type: string
17838   /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:
17839     get:
17840       tags:
17841         - Business
17842       summary: returns tunnel-xconnects
17843       description: returns tunnel-xconnects
17844       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
17845       produces:
17846         - application/json
17847         - application/xml
17848       responses:
17849         "200":
17850           description: successful operation
17851           schema:
17852               $ref: "#/getDefinitions/tunnel-xconnects"
17853         "default":
17854           description: Response codes found in [response codes](https://wiki.onap.org/).
17855       parameters:
17856         - name: global-customer-id
17857           in: path
17858           description: Global customer id used across ECOMP to uniquely identify customer.
17859           required: true
17860           type: string
17861           example: __GLOBAL-CUSTOMER-ID__
17862         - name: service-type
17863           in: path
17864           description: Value defined by orchestration to identify this service across ECOMP.
17865           required: true
17866           type: string
17867           example: __SERVICE-TYPE__
17868         - name: service-instance-id
17869           in: path
17870           description: Uniquely identifies this instance of a service
17871           required: true
17872           type: string
17873           example: __SERVICE-INSTANCE-ID__
17874         - name: id
17875           in: path
17876           description: Allotted Resource id UUID assigned to this instance.
17877           required: true
17878           type: string
17879           example: __ID__
17880         - name: subscriber-name
17881           in: query
17882           description: Subscriber name, an alternate way to retrieve a customer.
17883           required: false
17884           type: string
17885         - name: subscriber-type
17886           in: query
17887           description: Subscriber type, a way to provide VID with only the INFRA customers.
17888           required: false
17889           type: string
17890         - name: service-instance-name
17891           in: query
17892           description: This field will store a name assigned to the service-instance.
17893           required: false
17894           type: string
17895         - name: environment-context
17896           in: query
17897           description: This field will store the environment context assigned to the service-instance.
17898           required: false
17899           type: string
17900         - name: workload-context
17901           in: query
17902           description: This field will store the workload context assigned to the service-instance.
17903           required: false
17904           type: string
17905         - name: model-invariant-id
17906           in: query
17907           description: the ASDC model id for this resource or service model.
17908           required: false
17909           type: string
17910         - name: model-version-id
17911           in: query
17912           description: the ASDC model version for this resource or service model.
17913           required: false
17914           type: string
17915         - name: widget-model-id
17916           in: query
17917           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17918           required: false
17919           type: string
17920         - name: widget-model-version
17921           in: query
17922           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17923           required: false
17924           type: string
17925         - name: service-instance-location-id
17926           in: query
17927           description: An identifier that customers assign to the location where this service is being used.
17928           required: false
17929           type: string
17930         - name: orchestration-status
17931           in: query
17932           description: Orchestration status of this service.
17933           required: false
17934           type: string
17935         - name: model-invariant-id
17936           in: query
17937           description: the ASDC model id for this resource or service model.
17938           required: false
17939           type: string
17940         - name: model-version-id
17941           in: query
17942           description: the ASDC model version for this resource or service model.
17943           required: false
17944           type: string
17945         - name: type
17946           in: query
17947           description: Generic description of the type of allotted resource.
17948           required: false
17949           type: string
17950         - name: role
17951           in: query
17952           description: role in the network that this resource will be providing.
17953           required: false
17954           type: string
17955   /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:
17956     put:
17957       tags:
17958         - Business
17959       summary: see node definition for valid relationships
17960       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
17961       consumes:
17962         - application/json
17963         - application/xml
17964       produces:
17965         - application/json
17966         - application/xml
17967       responses:
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: id
17990           in: path
17991           description: Allotted Resource id UUID assigned to this instance.
17992           required: true
17993           type: string
17994           example: __ID__
17995         - name: body
17996           in: body
17997           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
17998           required: true
17999           schema:
18000             $ref: "#/definitions/relationship"
18001     delete:
18002       tags:
18003         - Business
18004       summary: delete an existing relationship
18005       description: delete an existing relationship
18006       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
18007       consumes:
18008         - application/json
18009         - application/xml
18010       produces:
18011         - application/json
18012         - application/xml
18013       responses:
18014         "default":
18015           description: Response codes found in [response codes](https://wiki.onap.org/).
18016       parameters:
18017         - name: global-customer-id
18018           in: path
18019           description: Global customer id used across ECOMP to uniquely identify customer.
18020           required: true
18021           type: string
18022           example: __GLOBAL-CUSTOMER-ID__
18023         - name: service-type
18024           in: path
18025           description: Value defined by orchestration to identify this service across ECOMP.
18026           required: true
18027           type: string
18028           example: __SERVICE-TYPE__
18029         - name: service-instance-id
18030           in: path
18031           description: Uniquely identifies this instance of a service
18032           required: true
18033           type: string
18034           example: __SERVICE-INSTANCE-ID__
18035         - name: id
18036           in: path
18037           description: Allotted Resource id UUID assigned to this instance.
18038           required: true
18039           type: string
18040           example: __ID__
18041   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
18042     get:
18043       tags:
18044         - Business
18045       summary: returns allotted-resource
18046       description: returns allotted-resource
18047       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
18048       produces:
18049         - application/json
18050         - application/xml
18051       responses:
18052         "200":
18053           description: successful operation
18054           schema:
18055               $ref: "#/getDefinitions/allotted-resource"
18056         "default":
18057           description: Response codes found in [response codes](https://wiki.onap.org/).
18058       parameters:
18059         - name: global-customer-id
18060           in: path
18061           description: Global customer id used across ECOMP to uniquely identify customer.
18062           required: true
18063           type: string
18064           example: __GLOBAL-CUSTOMER-ID__
18065         - name: service-type
18066           in: path
18067           description: Value defined by orchestration to identify this service across ECOMP.
18068           required: true
18069           type: string
18070           example: __SERVICE-TYPE__
18071         - name: service-instance-id
18072           in: path
18073           description: Uniquely identifies this instance of a service
18074           required: true
18075           type: string
18076           example: __SERVICE-INSTANCE-ID__
18077         - name: id
18078           in: path
18079           description: Allotted Resource id UUID assigned to this instance.
18080           required: true
18081           type: string
18082           example: __ID__
18083         - name: subscriber-name
18084           in: query
18085           description: Subscriber name, an alternate way to retrieve a customer.
18086           required: false
18087           type: string
18088         - name: subscriber-type
18089           in: query
18090           description: Subscriber type, a way to provide VID with only the INFRA customers.
18091           required: false
18092           type: string
18093         - name: service-instance-name
18094           in: query
18095           description: This field will store a name assigned to the service-instance.
18096           required: false
18097           type: string
18098         - name: environment-context
18099           in: query
18100           description: This field will store the environment context assigned to the service-instance.
18101           required: false
18102           type: string
18103         - name: workload-context
18104           in: query
18105           description: This field will store the workload context assigned to the service-instance.
18106           required: false
18107           type: string
18108         - name: model-invariant-id
18109           in: query
18110           description: the ASDC model id for this resource or service model.
18111           required: false
18112           type: string
18113         - name: model-version-id
18114           in: query
18115           description: the ASDC model version for this resource or service model.
18116           required: false
18117           type: string
18118         - name: widget-model-id
18119           in: query
18120           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18121           required: false
18122           type: string
18123         - name: widget-model-version
18124           in: query
18125           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18126           required: false
18127           type: string
18128         - name: service-instance-location-id
18129           in: query
18130           description: An identifier that customers assign to the location where this service is being used.
18131           required: false
18132           type: string
18133         - name: orchestration-status
18134           in: query
18135           description: Orchestration status of this service.
18136           required: false
18137           type: string
18138         - name: model-invariant-id
18139           in: query
18140           description: the ASDC model id for this resource or service model.
18141           required: false
18142           type: string
18143         - name: model-version-id
18144           in: query
18145           description: the ASDC model version for this resource or service model.
18146           required: false
18147           type: string
18148         - name: type
18149           in: query
18150           description: Generic description of the type of allotted resource.
18151           required: false
18152           type: string
18153         - name: role
18154           in: query
18155           description: role in the network that this resource will be providing.
18156           required: false
18157           type: string
18158     put:
18159       tags:
18160         - Business
18161       summary: create or update an existing allotted-resource
18162       description: |
18163         Create or update an existing allotted-resource.
18164         #
18165         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18166       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
18167       consumes:
18168         - application/json
18169         - application/xml
18170       produces:
18171         - application/json
18172         - application/xml
18173       responses:
18174         "default":
18175           description: Response codes found in [response codes](https://wiki.onap.org/).
18176       parameters:
18177         - name: global-customer-id
18178           in: path
18179           description: Global customer id used across ECOMP to uniquely identify customer.
18180           required: true
18181           type: string
18182           example: __GLOBAL-CUSTOMER-ID__
18183         - name: service-type
18184           in: path
18185           description: Value defined by orchestration to identify this service across ECOMP.
18186           required: true
18187           type: string
18188           example: __SERVICE-TYPE__
18189         - name: service-instance-id
18190           in: path
18191           description: Uniquely identifies this instance of a service
18192           required: true
18193           type: string
18194           example: __SERVICE-INSTANCE-ID__
18195         - name: id
18196           in: path
18197           description: Allotted Resource id UUID assigned to this instance.
18198           required: true
18199           type: string
18200           example: __ID__
18201         - name: body
18202           in: body
18203           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
18204           required: true
18205           schema:
18206             $ref: "#/definitions/allotted-resource"
18207     patch:
18208       tags:
18209         - Business
18210       summary: update an existing allotted-resource
18211       description: |
18212         Update an existing allotted-resource
18213         #
18214         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18215         The PUT operation will entirely replace an existing object.
18216         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18217         #
18218         Other differences between PUT and PATCH are:
18219         #
18220         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18221         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18222         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18223       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
18224       consumes:
18225         - application/json
18226         - application/xml
18227       produces:
18228         - application/json
18229         - application/xml
18230       responses:
18231         "default":
18232           description: Response codes found in [response codes](https://wiki.onap.org/).
18233       parameters:
18234         - name: global-customer-id
18235           in: path
18236           description: Global customer id used across ECOMP to uniquely identify customer.
18237           required: true
18238           type: string
18239           example: __GLOBAL-CUSTOMER-ID__
18240         - name: service-type
18241           in: path
18242           description: Value defined by orchestration to identify this service across ECOMP.
18243           required: true
18244           type: string
18245           example: __SERVICE-TYPE__
18246         - name: service-instance-id
18247           in: path
18248           description: Uniquely identifies this instance of a service
18249           required: true
18250           type: string
18251           example: __SERVICE-INSTANCE-ID__
18252         - name: id
18253           in: path
18254           description: Allotted Resource id UUID assigned to this instance.
18255           required: true
18256           type: string
18257           example: __ID__
18258         - name: body
18259           in: body
18260           description: allotted-resource object that needs to be created or updated.
18261           required: true
18262           schema:
18263             $ref: "#/patchDefinitions/allotted-resource"
18264     delete:
18265       tags:
18266         - Business
18267       summary: delete an existing allotted-resource
18268       description: delete an existing allotted-resource
18269       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
18270       consumes:
18271         - application/json
18272         - application/xml
18273       produces:
18274         - application/json
18275         - application/xml
18276       responses:
18277         "default":
18278           description: Response codes found in [response codes](https://wiki.onap.org/).
18279       parameters:
18280         - name: global-customer-id
18281           in: path
18282           description: Global customer id used across ECOMP to uniquely identify customer.
18283           required: true
18284           type: string
18285           example: __GLOBAL-CUSTOMER-ID__
18286         - name: service-type
18287           in: path
18288           description: Value defined by orchestration to identify this service across ECOMP.
18289           required: true
18290           type: string
18291           example: __SERVICE-TYPE__
18292         - name: service-instance-id
18293           in: path
18294           description: Uniquely identifies this instance of a service
18295           required: true
18296           type: string
18297           example: __SERVICE-INSTANCE-ID__
18298         - name: id
18299           in: path
18300           description: Allotted Resource id UUID assigned to this instance.
18301           required: true
18302           type: string
18303           example: __ID__
18304         - name: resource-version
18305           in: query
18306           description: resource-version for concurrency
18307           required: true
18308           type: string
18309   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
18310     get:
18311       tags:
18312         - Business
18313       summary: returns allotted-resources
18314       description: returns allotted-resources
18315       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
18316       produces:
18317         - application/json
18318         - application/xml
18319       responses:
18320         "200":
18321           description: successful operation
18322           schema:
18323               $ref: "#/getDefinitions/allotted-resources"
18324         "default":
18325           description: Response codes found in [response codes](https://wiki.onap.org/).
18326       parameters:
18327         - name: global-customer-id
18328           in: path
18329           description: Global customer id used across ECOMP to uniquely identify customer.
18330           required: true
18331           type: string
18332           example: __GLOBAL-CUSTOMER-ID__
18333         - name: service-type
18334           in: path
18335           description: Value defined by orchestration to identify this service across ECOMP.
18336           required: true
18337           type: string
18338           example: __SERVICE-TYPE__
18339         - name: service-instance-id
18340           in: path
18341           description: Uniquely identifies this instance of a service
18342           required: true
18343           type: string
18344           example: __SERVICE-INSTANCE-ID__
18345         - name: subscriber-name
18346           in: query
18347           description: Subscriber name, an alternate way to retrieve a customer.
18348           required: false
18349           type: string
18350         - name: subscriber-type
18351           in: query
18352           description: Subscriber type, a way to provide VID with only the INFRA customers.
18353           required: false
18354           type: string
18355         - name: service-instance-name
18356           in: query
18357           description: This field will store a name assigned to the service-instance.
18358           required: false
18359           type: string
18360         - name: environment-context
18361           in: query
18362           description: This field will store the environment context assigned to the service-instance.
18363           required: false
18364           type: string
18365         - name: workload-context
18366           in: query
18367           description: This field will store the workload context assigned to the service-instance.
18368           required: false
18369           type: string
18370         - name: model-invariant-id
18371           in: query
18372           description: the ASDC model id for this resource or service model.
18373           required: false
18374           type: string
18375         - name: model-version-id
18376           in: query
18377           description: the ASDC model version for this resource or service model.
18378           required: false
18379           type: string
18380         - name: widget-model-id
18381           in: query
18382           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18383           required: false
18384           type: string
18385         - name: widget-model-version
18386           in: query
18387           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18388           required: false
18389           type: string
18390         - name: service-instance-location-id
18391           in: query
18392           description: An identifier that customers assign to the location where this service is being used.
18393           required: false
18394           type: string
18395         - name: orchestration-status
18396           in: query
18397           description: Orchestration status of this service.
18398           required: false
18399           type: string
18400   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
18401     get:
18402       tags:
18403         - Business
18404       summary: returns service-instance
18405       description: returns service-instance
18406       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18407       produces:
18408         - application/json
18409         - application/xml
18410       responses:
18411         "200":
18412           description: successful operation
18413           schema:
18414               $ref: "#/getDefinitions/service-instance"
18415         "default":
18416           description: Response codes found in [response codes](https://wiki.onap.org/).
18417       parameters:
18418         - name: global-customer-id
18419           in: path
18420           description: Global customer id used across ECOMP to uniquely identify customer.
18421           required: true
18422           type: string
18423           example: __GLOBAL-CUSTOMER-ID__
18424         - name: service-type
18425           in: path
18426           description: Value defined by orchestration to identify this service across ECOMP.
18427           required: true
18428           type: string
18429           example: __SERVICE-TYPE__
18430         - name: service-instance-id
18431           in: path
18432           description: Uniquely identifies this instance of a service
18433           required: true
18434           type: string
18435           example: __SERVICE-INSTANCE-ID__
18436         - name: subscriber-name
18437           in: query
18438           description: Subscriber name, an alternate way to retrieve a customer.
18439           required: false
18440           type: string
18441         - name: subscriber-type
18442           in: query
18443           description: Subscriber type, a way to provide VID with only the INFRA customers.
18444           required: false
18445           type: string
18446         - name: service-instance-name
18447           in: query
18448           description: This field will store a name assigned to the service-instance.
18449           required: false
18450           type: string
18451         - name: environment-context
18452           in: query
18453           description: This field will store the environment context assigned to the service-instance.
18454           required: false
18455           type: string
18456         - name: workload-context
18457           in: query
18458           description: This field will store the workload context assigned to the service-instance.
18459           required: false
18460           type: string
18461         - name: model-invariant-id
18462           in: query
18463           description: the ASDC model id for this resource or service model.
18464           required: false
18465           type: string
18466         - name: model-version-id
18467           in: query
18468           description: the ASDC model version for this resource or service model.
18469           required: false
18470           type: string
18471         - name: widget-model-id
18472           in: query
18473           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18474           required: false
18475           type: string
18476         - name: widget-model-version
18477           in: query
18478           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18479           required: false
18480           type: string
18481         - name: service-instance-location-id
18482           in: query
18483           description: An identifier that customers assign to the location where this service is being used.
18484           required: false
18485           type: string
18486         - name: orchestration-status
18487           in: query
18488           description: Orchestration status of this service.
18489           required: false
18490           type: string
18491     put:
18492       tags:
18493         - Business
18494       summary: create or update an existing service-instance
18495       description: |
18496         Create or update an existing service-instance.
18497         #
18498         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18499       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18500       consumes:
18501         - application/json
18502         - application/xml
18503       produces:
18504         - application/json
18505         - application/xml
18506       responses:
18507         "default":
18508           description: Response codes found in [response codes](https://wiki.onap.org/).
18509       parameters:
18510         - name: global-customer-id
18511           in: path
18512           description: Global customer id used across ECOMP to uniquely identify customer.
18513           required: true
18514           type: string
18515           example: __GLOBAL-CUSTOMER-ID__
18516         - name: service-type
18517           in: path
18518           description: Value defined by orchestration to identify this service across ECOMP.
18519           required: true
18520           type: string
18521           example: __SERVICE-TYPE__
18522         - name: service-instance-id
18523           in: path
18524           description: Uniquely identifies this instance of a service
18525           required: true
18526           type: string
18527           example: __SERVICE-INSTANCE-ID__
18528         - name: body
18529           in: body
18530           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
18531           required: true
18532           schema:
18533             $ref: "#/definitions/service-instance"
18534     patch:
18535       tags:
18536         - Business
18537       summary: update an existing service-instance
18538       description: |
18539         Update an existing service-instance
18540         #
18541         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18542         The PUT operation will entirely replace an existing object.
18543         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18544         #
18545         Other differences between PUT and PATCH are:
18546         #
18547         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18548         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18549         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18550       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18551       consumes:
18552         - application/json
18553         - application/xml
18554       produces:
18555         - application/json
18556         - application/xml
18557       responses:
18558         "default":
18559           description: Response codes found in [response codes](https://wiki.onap.org/).
18560       parameters:
18561         - name: global-customer-id
18562           in: path
18563           description: Global customer id used across ECOMP to uniquely identify customer.
18564           required: true
18565           type: string
18566           example: __GLOBAL-CUSTOMER-ID__
18567         - name: service-type
18568           in: path
18569           description: Value defined by orchestration to identify this service across ECOMP.
18570           required: true
18571           type: string
18572           example: __SERVICE-TYPE__
18573         - name: service-instance-id
18574           in: path
18575           description: Uniquely identifies this instance of a service
18576           required: true
18577           type: string
18578           example: __SERVICE-INSTANCE-ID__
18579         - name: body
18580           in: body
18581           description: service-instance object that needs to be created or updated.
18582           required: true
18583           schema:
18584             $ref: "#/patchDefinitions/service-instance"
18585     delete:
18586       tags:
18587         - Business
18588       summary: delete an existing service-instance
18589       description: delete an existing service-instance
18590       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18591       consumes:
18592         - application/json
18593         - application/xml
18594       produces:
18595         - application/json
18596         - application/xml
18597       responses:
18598         "default":
18599           description: Response codes found in [response codes](https://wiki.onap.org/).
18600       parameters:
18601         - name: global-customer-id
18602           in: path
18603           description: Global customer id used across ECOMP to uniquely identify customer.
18604           required: true
18605           type: string
18606           example: __GLOBAL-CUSTOMER-ID__
18607         - name: service-type
18608           in: path
18609           description: Value defined by orchestration to identify this service across ECOMP.
18610           required: true
18611           type: string
18612           example: __SERVICE-TYPE__
18613         - name: service-instance-id
18614           in: path
18615           description: Uniquely identifies this instance of a service
18616           required: true
18617           type: string
18618           example: __SERVICE-INSTANCE-ID__
18619         - name: resource-version
18620           in: query
18621           description: resource-version for concurrency
18622           required: true
18623           type: string
18624   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
18625     get:
18626       tags:
18627         - Business
18628       summary: returns service-instances
18629       description: returns service-instances
18630       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
18631       produces:
18632         - application/json
18633         - application/xml
18634       responses:
18635         "200":
18636           description: successful operation
18637           schema:
18638               $ref: "#/getDefinitions/service-instances"
18639         "default":
18640           description: Response codes found in [response codes](https://wiki.onap.org/).
18641       parameters:
18642         - name: global-customer-id
18643           in: path
18644           description: Global customer id used across ECOMP to uniquely identify customer.
18645           required: true
18646           type: string
18647           example: __GLOBAL-CUSTOMER-ID__
18648         - name: service-type
18649           in: path
18650           description: Value defined by orchestration to identify this service across ECOMP.
18651           required: true
18652           type: string
18653           example: __SERVICE-TYPE__
18654         - name: subscriber-name
18655           in: query
18656           description: Subscriber name, an alternate way to retrieve a customer.
18657           required: false
18658           type: string
18659         - name: subscriber-type
18660           in: query
18661           description: Subscriber type, a way to provide VID with only the INFRA customers.
18662           required: false
18663           type: string
18664   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
18665     put:
18666       tags:
18667         - Business
18668       summary: see node definition for valid relationships
18669       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
18670       consumes:
18671         - application/json
18672         - application/xml
18673       produces:
18674         - application/json
18675         - application/xml
18676       responses:
18677         "default":
18678           description: Response codes found in [response codes](https://wiki.onap.org/).
18679       parameters:
18680         - name: global-customer-id
18681           in: path
18682           description: Global customer id used across ECOMP to uniquely identify customer.
18683           required: true
18684           type: string
18685           example: __GLOBAL-CUSTOMER-ID__
18686         - name: service-type
18687           in: path
18688           description: Value defined by orchestration to identify this service across ECOMP.
18689           required: true
18690           type: string
18691           example: __SERVICE-TYPE__
18692         - name: body
18693           in: body
18694           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
18695           required: true
18696           schema:
18697             $ref: "#/definitions/relationship"
18698     delete:
18699       tags:
18700         - Business
18701       summary: delete an existing relationship
18702       description: delete an existing relationship
18703       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
18704       consumes:
18705         - application/json
18706         - application/xml
18707       produces:
18708         - application/json
18709         - application/xml
18710       responses:
18711         "default":
18712           description: Response codes found in [response codes](https://wiki.onap.org/).
18713       parameters:
18714         - name: global-customer-id
18715           in: path
18716           description: Global customer id used across ECOMP to uniquely identify customer.
18717           required: true
18718           type: string
18719           example: __GLOBAL-CUSTOMER-ID__
18720         - name: service-type
18721           in: path
18722           description: Value defined by orchestration to identify this service across ECOMP.
18723           required: true
18724           type: string
18725           example: __SERVICE-TYPE__
18726   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
18727     get:
18728       tags:
18729         - Business
18730       summary: returns service-subscription
18731       description: returns service-subscription
18732       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18733       produces:
18734         - application/json
18735         - application/xml
18736       responses:
18737         "200":
18738           description: successful operation
18739           schema:
18740               $ref: "#/getDefinitions/service-subscription"
18741         "default":
18742           description: Response codes found in [response codes](https://wiki.onap.org/).
18743       parameters:
18744         - name: global-customer-id
18745           in: path
18746           description: Global customer id used across ECOMP to uniquely identify customer.
18747           required: true
18748           type: string
18749           example: __GLOBAL-CUSTOMER-ID__
18750         - name: service-type
18751           in: path
18752           description: Value defined by orchestration to identify this service across ECOMP.
18753           required: true
18754           type: string
18755           example: __SERVICE-TYPE__
18756         - name: subscriber-name
18757           in: query
18758           description: Subscriber name, an alternate way to retrieve a customer.
18759           required: false
18760           type: string
18761         - name: subscriber-type
18762           in: query
18763           description: Subscriber type, a way to provide VID with only the INFRA customers.
18764           required: false
18765           type: string
18766     put:
18767       tags:
18768         - Business
18769       summary: create or update an existing service-subscription
18770       description: |
18771         Create or update an existing service-subscription.
18772         #
18773         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18774       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18775       consumes:
18776         - application/json
18777         - application/xml
18778       produces:
18779         - application/json
18780         - application/xml
18781       responses:
18782         "default":
18783           description: Response codes found in [response codes](https://wiki.onap.org/).
18784       parameters:
18785         - name: global-customer-id
18786           in: path
18787           description: Global customer id used across ECOMP to uniquely identify customer.
18788           required: true
18789           type: string
18790           example: __GLOBAL-CUSTOMER-ID__
18791         - name: service-type
18792           in: path
18793           description: Value defined by orchestration to identify this service across ECOMP.
18794           required: true
18795           type: string
18796           example: __SERVICE-TYPE__
18797         - name: body
18798           in: body
18799           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
18800           required: true
18801           schema:
18802             $ref: "#/definitions/service-subscription"
18803     patch:
18804       tags:
18805         - Business
18806       summary: update an existing service-subscription
18807       description: |
18808         Update an existing service-subscription
18809         #
18810         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18811         The PUT operation will entirely replace an existing object.
18812         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18813         #
18814         Other differences between PUT and PATCH are:
18815         #
18816         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18817         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18818         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18819       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18820       consumes:
18821         - application/json
18822         - application/xml
18823       produces:
18824         - application/json
18825         - application/xml
18826       responses:
18827         "default":
18828           description: Response codes found in [response codes](https://wiki.onap.org/).
18829       parameters:
18830         - name: global-customer-id
18831           in: path
18832           description: Global customer id used across ECOMP to uniquely identify customer.
18833           required: true
18834           type: string
18835           example: __GLOBAL-CUSTOMER-ID__
18836         - name: service-type
18837           in: path
18838           description: Value defined by orchestration to identify this service across ECOMP.
18839           required: true
18840           type: string
18841           example: __SERVICE-TYPE__
18842         - name: body
18843           in: body
18844           description: service-subscription object that needs to be created or updated.
18845           required: true
18846           schema:
18847             $ref: "#/patchDefinitions/service-subscription"
18848     delete:
18849       tags:
18850         - Business
18851       summary: delete an existing service-subscription
18852       description: delete an existing service-subscription
18853       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18854       consumes:
18855         - application/json
18856         - application/xml
18857       produces:
18858         - application/json
18859         - application/xml
18860       responses:
18861         "default":
18862           description: Response codes found in [response codes](https://wiki.onap.org/).
18863       parameters:
18864         - name: global-customer-id
18865           in: path
18866           description: Global customer id used across ECOMP to uniquely identify customer.
18867           required: true
18868           type: string
18869           example: __GLOBAL-CUSTOMER-ID__
18870         - name: service-type
18871           in: path
18872           description: Value defined by orchestration to identify this service across ECOMP.
18873           required: true
18874           type: string
18875           example: __SERVICE-TYPE__
18876         - name: resource-version
18877           in: query
18878           description: resource-version for concurrency
18879           required: true
18880           type: string
18881   /business/customers/customer/{global-customer-id}/service-subscriptions:
18882     get:
18883       tags:
18884         - Business
18885       summary: returns service-subscriptions
18886       description: returns service-subscriptions
18887       operationId: getBusinessCustomersCustomerServiceSubscriptions
18888       produces:
18889         - application/json
18890         - application/xml
18891       responses:
18892         "200":
18893           description: successful operation
18894           schema:
18895               $ref: "#/getDefinitions/service-subscriptions"
18896         "default":
18897           description: Response codes found in [response codes](https://wiki.onap.org/).
18898       parameters:
18899         - name: global-customer-id
18900           in: path
18901           description: Global customer id used across ECOMP to uniquely identify customer.
18902           required: true
18903           type: string
18904           example: __GLOBAL-CUSTOMER-ID__
18905         - name: subscriber-name
18906           in: query
18907           description: Subscriber name, an alternate way to retrieve a customer.
18908           required: false
18909           type: string
18910         - name: subscriber-type
18911           in: query
18912           description: Subscriber type, a way to provide VID with only the INFRA customers.
18913           required: false
18914           type: string
18915   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
18916     put:
18917       tags:
18918         - Business
18919       summary: see node definition for valid relationships
18920       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
18921       consumes:
18922         - application/json
18923         - application/xml
18924       produces:
18925         - application/json
18926         - application/xml
18927       responses:
18928         "default":
18929           description: Response codes found in [response codes](https://wiki.onap.org/).
18930       parameters:
18931         - name: global-customer-id
18932           in: path
18933           description: Global customer id used across ECOMP to uniquely identify customer.
18934           required: true
18935           type: string
18936           example: __GLOBAL-CUSTOMER-ID__
18937         - name: body
18938           in: body
18939           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
18940           required: true
18941           schema:
18942             $ref: "#/definitions/relationship"
18943     delete:
18944       tags:
18945         - Business
18946       summary: delete an existing relationship
18947       description: delete an existing relationship
18948       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
18949       consumes:
18950         - application/json
18951         - application/xml
18952       produces:
18953         - application/json
18954         - application/xml
18955       responses:
18956         "default":
18957           description: Response codes found in [response codes](https://wiki.onap.org/).
18958       parameters:
18959         - name: global-customer-id
18960           in: path
18961           description: Global customer id used across ECOMP to uniquely identify customer.
18962           required: true
18963           type: string
18964           example: __GLOBAL-CUSTOMER-ID__
18965   /business/customers/customer/{global-customer-id}:
18966     get:
18967       tags:
18968         - Business
18969       summary: returns customer
18970       description: returns customer
18971       operationId: getBusinessCustomersCustomer
18972       produces:
18973         - application/json
18974         - application/xml
18975       responses:
18976         "200":
18977           description: successful operation
18978           schema:
18979               $ref: "#/getDefinitions/customer"
18980         "default":
18981           description: Response codes found in [response codes](https://wiki.onap.org/).
18982       parameters:
18983         - name: global-customer-id
18984           in: path
18985           description: Global customer id used across ECOMP to uniquely identify customer.
18986           required: true
18987           type: string
18988           example: __GLOBAL-CUSTOMER-ID__
18989         - name: subscriber-name
18990           in: query
18991           description: Subscriber name, an alternate way to retrieve a customer.
18992           required: false
18993           type: string
18994         - name: subscriber-type
18995           in: query
18996           description: Subscriber type, a way to provide VID with only the INFRA customers.
18997           required: false
18998           type: string
18999     put:
19000       tags:
19001         - Business
19002       summary: create or update an existing customer
19003       description: |
19004         Create or update an existing customer.
19005         #
19006         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19007       operationId: createOrUpdateBusinessCustomersCustomer
19008       consumes:
19009         - application/json
19010         - application/xml
19011       produces:
19012         - application/json
19013         - application/xml
19014       responses:
19015         "default":
19016           description: Response codes found in [response codes](https://wiki.onap.org/).
19017       parameters:
19018         - name: global-customer-id
19019           in: path
19020           description: Global customer id used across ECOMP to uniquely identify customer.
19021           required: true
19022           type: string
19023           example: __GLOBAL-CUSTOMER-ID__
19024         - name: body
19025           in: body
19026           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
19027           required: true
19028           schema:
19029             $ref: "#/definitions/customer"
19030     patch:
19031       tags:
19032         - Business
19033       summary: update an existing customer
19034       description: |
19035         Update an existing customer
19036         #
19037         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19038         The PUT operation will entirely replace an existing object.
19039         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19040         #
19041         Other differences between PUT and PATCH are:
19042         #
19043         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19044         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19045         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19046       operationId: UpdateBusinessCustomersCustomer
19047       consumes:
19048         - application/json
19049         - application/xml
19050       produces:
19051         - application/json
19052         - application/xml
19053       responses:
19054         "default":
19055           description: Response codes found in [response codes](https://wiki.onap.org/).
19056       parameters:
19057         - name: global-customer-id
19058           in: path
19059           description: Global customer id used across ECOMP to uniquely identify customer.
19060           required: true
19061           type: string
19062           example: __GLOBAL-CUSTOMER-ID__
19063         - name: body
19064           in: body
19065           description: customer object that needs to be created or updated.
19066           required: true
19067           schema:
19068             $ref: "#/patchDefinitions/customer"
19069     delete:
19070       tags:
19071         - Business
19072       summary: delete an existing customer
19073       description: delete an existing customer
19074       operationId: deleteBusinessCustomersCustomer
19075       consumes:
19076         - application/json
19077         - application/xml
19078       produces:
19079         - application/json
19080         - application/xml
19081       responses:
19082         "default":
19083           description: Response codes found in [response codes](https://wiki.onap.org/).
19084       parameters:
19085         - name: global-customer-id
19086           in: path
19087           description: Global customer id used across ECOMP to uniquely identify customer.
19088           required: true
19089           type: string
19090           example: __GLOBAL-CUSTOMER-ID__
19091         - name: resource-version
19092           in: query
19093           description: resource-version for concurrency
19094           required: true
19095           type: string
19096   /business/customers:
19097     get:
19098       tags:
19099         - Business
19100       summary: returns customers
19101       description: returns customers
19102       operationId: getBusinessCustomers
19103       produces:
19104         - application/json
19105         - application/xml
19106       responses:
19107         "200":
19108           description: successful operation
19109           schema:
19110               $ref: "#/getDefinitions/customers"
19111         "default":
19112           description: Response codes found in [response codes](https://wiki.onap.org/).
19113   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
19114     put:
19115       tags:
19116         - Business
19117       summary: see node definition for valid relationships
19118       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
19119       consumes:
19120         - application/json
19121         - application/xml
19122       produces:
19123         - application/json
19124         - application/xml
19125       responses:
19126         "default":
19127           description: Response codes found in [response codes](https://wiki.onap.org/).
19128       parameters:
19129         - name: line-of-business-name
19130           in: path
19131           description: Name of the line-of-business (product)
19132           required: true
19133           type: string
19134           example: __LINE-OF-BUSINESS-NAME__
19135         - name: body
19136           in: body
19137           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
19138           required: true
19139           schema:
19140             $ref: "#/definitions/relationship"
19141     delete:
19142       tags:
19143         - Business
19144       summary: delete an existing relationship
19145       description: delete an existing relationship
19146       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
19147       consumes:
19148         - application/json
19149         - application/xml
19150       produces:
19151         - application/json
19152         - application/xml
19153       responses:
19154         "default":
19155           description: Response codes found in [response codes](https://wiki.onap.org/).
19156       parameters:
19157         - name: line-of-business-name
19158           in: path
19159           description: Name of the line-of-business (product)
19160           required: true
19161           type: string
19162           example: __LINE-OF-BUSINESS-NAME__
19163   /business/lines-of-business/line-of-business/{line-of-business-name}:
19164     get:
19165       tags:
19166         - Business
19167       summary: returns line-of-business
19168       description: returns line-of-business
19169       operationId: getBusinessLinesOfBusinessLineOfBusiness
19170       produces:
19171         - application/json
19172         - application/xml
19173       responses:
19174         "200":
19175           description: successful operation
19176           schema:
19177               $ref: "#/getDefinitions/line-of-business"
19178         "default":
19179           description: Response codes found in [response codes](https://wiki.onap.org/).
19180       parameters:
19181         - name: line-of-business-name
19182           in: path
19183           description: Name of the line-of-business (product)
19184           required: true
19185           type: string
19186           example: __LINE-OF-BUSINESS-NAME__
19187     put:
19188       tags:
19189         - Business
19190       summary: create or update an existing line-of-business
19191       description: |
19192         Create or update an existing line-of-business.
19193         #
19194         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19195       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
19196       consumes:
19197         - application/json
19198         - application/xml
19199       produces:
19200         - application/json
19201         - application/xml
19202       responses:
19203         "default":
19204           description: Response codes found in [response codes](https://wiki.onap.org/).
19205       parameters:
19206         - name: line-of-business-name
19207           in: path
19208           description: Name of the line-of-business (product)
19209           required: true
19210           type: string
19211           example: __LINE-OF-BUSINESS-NAME__
19212         - name: body
19213           in: body
19214           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
19215           required: true
19216           schema:
19217             $ref: "#/definitions/line-of-business"
19218     patch:
19219       tags:
19220         - Business
19221       summary: update an existing line-of-business
19222       description: |
19223         Update an existing line-of-business
19224         #
19225         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19226         The PUT operation will entirely replace an existing object.
19227         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19228         #
19229         Other differences between PUT and PATCH are:
19230         #
19231         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19232         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19233         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19234       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
19235       consumes:
19236         - application/json
19237         - application/xml
19238       produces:
19239         - application/json
19240         - application/xml
19241       responses:
19242         "default":
19243           description: Response codes found in [response codes](https://wiki.onap.org/).
19244       parameters:
19245         - name: line-of-business-name
19246           in: path
19247           description: Name of the line-of-business (product)
19248           required: true
19249           type: string
19250           example: __LINE-OF-BUSINESS-NAME__
19251         - name: body
19252           in: body
19253           description: line-of-business object that needs to be created or updated.
19254           required: true
19255           schema:
19256             $ref: "#/patchDefinitions/line-of-business"
19257     delete:
19258       tags:
19259         - Business
19260       summary: delete an existing line-of-business
19261       description: delete an existing line-of-business
19262       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
19263       consumes:
19264         - application/json
19265         - application/xml
19266       produces:
19267         - application/json
19268         - application/xml
19269       responses:
19270         "default":
19271           description: Response codes found in [response codes](https://wiki.onap.org/).
19272       parameters:
19273         - name: line-of-business-name
19274           in: path
19275           description: Name of the line-of-business (product)
19276           required: true
19277           type: string
19278           example: __LINE-OF-BUSINESS-NAME__
19279         - name: resource-version
19280           in: query
19281           description: resource-version for concurrency
19282           required: true
19283           type: string
19284   /business/lines-of-business:
19285     get:
19286       tags:
19287         - Business
19288       summary: returns lines-of-business
19289       description: returns lines-of-business
19290       operationId: getBusinessLinesOfBusiness
19291       produces:
19292         - application/json
19293         - application/xml
19294       responses:
19295         "200":
19296           description: successful operation
19297           schema:
19298               $ref: "#/getDefinitions/lines-of-business"
19299         "default":
19300           description: Response codes found in [response codes](https://wiki.onap.org/).
19301   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
19302     put:
19303       tags:
19304         - Business
19305       summary: see node definition for valid relationships
19306       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
19307       consumes:
19308         - application/json
19309         - application/xml
19310       produces:
19311         - application/json
19312         - application/xml
19313       responses:
19314         "default":
19315           description: Response codes found in [response codes](https://wiki.onap.org/).
19316       parameters:
19317         - name: owning-entity-id
19318           in: path
19319           description: UUID of an owning entity
19320           required: true
19321           type: string
19322           example: __OWNING-ENTITY-ID__
19323         - name: body
19324           in: body
19325           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
19326           required: true
19327           schema:
19328             $ref: "#/definitions/relationship"
19329     delete:
19330       tags:
19331         - Business
19332       summary: delete an existing relationship
19333       description: delete an existing relationship
19334       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
19335       consumes:
19336         - application/json
19337         - application/xml
19338       produces:
19339         - application/json
19340         - application/xml
19341       responses:
19342         "default":
19343           description: Response codes found in [response codes](https://wiki.onap.org/).
19344       parameters:
19345         - name: owning-entity-id
19346           in: path
19347           description: UUID of an owning entity
19348           required: true
19349           type: string
19350           example: __OWNING-ENTITY-ID__
19351   /business/owning-entities/owning-entity/{owning-entity-id}:
19352     get:
19353       tags:
19354         - Business
19355       summary: returns owning-entity
19356       description: returns owning-entity
19357       operationId: getBusinessOwningEntitiesOwningEntity
19358       produces:
19359         - application/json
19360         - application/xml
19361       responses:
19362         "200":
19363           description: successful operation
19364           schema:
19365               $ref: "#/getDefinitions/owning-entity"
19366         "default":
19367           description: Response codes found in [response codes](https://wiki.onap.org/).
19368       parameters:
19369         - name: owning-entity-id
19370           in: path
19371           description: UUID of an owning entity
19372           required: true
19373           type: string
19374           example: __OWNING-ENTITY-ID__
19375     put:
19376       tags:
19377         - Business
19378       summary: create or update an existing owning-entity
19379       description: |
19380         Create or update an existing owning-entity.
19381         #
19382         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19383       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
19384       consumes:
19385         - application/json
19386         - application/xml
19387       produces:
19388         - application/json
19389         - application/xml
19390       responses:
19391         "default":
19392           description: Response codes found in [response codes](https://wiki.onap.org/).
19393       parameters:
19394         - name: owning-entity-id
19395           in: path
19396           description: UUID of an owning entity
19397           required: true
19398           type: string
19399           example: __OWNING-ENTITY-ID__
19400         - name: body
19401           in: body
19402           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
19403           required: true
19404           schema:
19405             $ref: "#/definitions/owning-entity"
19406     patch:
19407       tags:
19408         - Business
19409       summary: update an existing owning-entity
19410       description: |
19411         Update an existing owning-entity
19412         #
19413         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19414         The PUT operation will entirely replace an existing object.
19415         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19416         #
19417         Other differences between PUT and PATCH are:
19418         #
19419         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19420         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19421         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19422       operationId: UpdateBusinessOwningEntitiesOwningEntity
19423       consumes:
19424         - application/json
19425         - application/xml
19426       produces:
19427         - application/json
19428         - application/xml
19429       responses:
19430         "default":
19431           description: Response codes found in [response codes](https://wiki.onap.org/).
19432       parameters:
19433         - name: owning-entity-id
19434           in: path
19435           description: UUID of an owning entity
19436           required: true
19437           type: string
19438           example: __OWNING-ENTITY-ID__
19439         - name: body
19440           in: body
19441           description: owning-entity object that needs to be created or updated.
19442           required: true
19443           schema:
19444             $ref: "#/patchDefinitions/owning-entity"
19445     delete:
19446       tags:
19447         - Business
19448       summary: delete an existing owning-entity
19449       description: delete an existing owning-entity
19450       operationId: deleteBusinessOwningEntitiesOwningEntity
19451       consumes:
19452         - application/json
19453         - application/xml
19454       produces:
19455         - application/json
19456         - application/xml
19457       responses:
19458         "default":
19459           description: Response codes found in [response codes](https://wiki.onap.org/).
19460       parameters:
19461         - name: owning-entity-id
19462           in: path
19463           description: UUID of an owning entity
19464           required: true
19465           type: string
19466           example: __OWNING-ENTITY-ID__
19467         - name: resource-version
19468           in: query
19469           description: resource-version for concurrency
19470           required: true
19471           type: string
19472   /business/owning-entities:
19473     get:
19474       tags:
19475         - Business
19476       summary: returns owning-entities
19477       description: returns owning-entities
19478       operationId: getBusinessOwningEntities
19479       produces:
19480         - application/json
19481         - application/xml
19482       responses:
19483         "200":
19484           description: successful operation
19485           schema:
19486               $ref: "#/getDefinitions/owning-entities"
19487         "default":
19488           description: Response codes found in [response codes](https://wiki.onap.org/).
19489   /business/platforms/platform/{platform-name}/relationship-list/relationship:
19490     put:
19491       tags:
19492         - Business
19493       summary: see node definition for valid relationships
19494       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
19495       consumes:
19496         - application/json
19497         - application/xml
19498       produces:
19499         - application/json
19500         - application/xml
19501       responses:
19502         "default":
19503           description: Response codes found in [response codes](https://wiki.onap.org/).
19504       parameters:
19505         - name: platform-name
19506           in: path
19507           description: Name of the platform
19508           required: true
19509           type: string
19510           example: __PLATFORM-NAME__
19511         - name: body
19512           in: body
19513           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
19514           required: true
19515           schema:
19516             $ref: "#/definitions/relationship"
19517     delete:
19518       tags:
19519         - Business
19520       summary: delete an existing relationship
19521       description: delete an existing relationship
19522       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
19523       consumes:
19524         - application/json
19525         - application/xml
19526       produces:
19527         - application/json
19528         - application/xml
19529       responses:
19530         "default":
19531           description: Response codes found in [response codes](https://wiki.onap.org/).
19532       parameters:
19533         - name: platform-name
19534           in: path
19535           description: Name of the platform
19536           required: true
19537           type: string
19538           example: __PLATFORM-NAME__
19539   /business/platforms/platform/{platform-name}:
19540     get:
19541       tags:
19542         - Business
19543       summary: returns platform
19544       description: returns platform
19545       operationId: getBusinessPlatformsPlatform
19546       produces:
19547         - application/json
19548         - application/xml
19549       responses:
19550         "200":
19551           description: successful operation
19552           schema:
19553               $ref: "#/getDefinitions/platform"
19554         "default":
19555           description: Response codes found in [response codes](https://wiki.onap.org/).
19556       parameters:
19557         - name: platform-name
19558           in: path
19559           description: Name of the platform
19560           required: true
19561           type: string
19562           example: __PLATFORM-NAME__
19563     put:
19564       tags:
19565         - Business
19566       summary: create or update an existing platform
19567       description: |
19568         Create or update an existing platform.
19569         #
19570         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19571       operationId: createOrUpdateBusinessPlatformsPlatform
19572       consumes:
19573         - application/json
19574         - application/xml
19575       produces:
19576         - application/json
19577         - application/xml
19578       responses:
19579         "default":
19580           description: Response codes found in [response codes](https://wiki.onap.org/).
19581       parameters:
19582         - name: platform-name
19583           in: path
19584           description: Name of the platform
19585           required: true
19586           type: string
19587           example: __PLATFORM-NAME__
19588         - name: body
19589           in: body
19590           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
19591           required: true
19592           schema:
19593             $ref: "#/definitions/platform"
19594     patch:
19595       tags:
19596         - Business
19597       summary: update an existing platform
19598       description: |
19599         Update an existing platform
19600         #
19601         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19602         The PUT operation will entirely replace an existing object.
19603         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19604         #
19605         Other differences between PUT and PATCH are:
19606         #
19607         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19608         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19609         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19610       operationId: UpdateBusinessPlatformsPlatform
19611       consumes:
19612         - application/json
19613         - application/xml
19614       produces:
19615         - application/json
19616         - application/xml
19617       responses:
19618         "default":
19619           description: Response codes found in [response codes](https://wiki.onap.org/).
19620       parameters:
19621         - name: platform-name
19622           in: path
19623           description: Name of the platform
19624           required: true
19625           type: string
19626           example: __PLATFORM-NAME__
19627         - name: body
19628           in: body
19629           description: platform object that needs to be created or updated.
19630           required: true
19631           schema:
19632             $ref: "#/patchDefinitions/platform"
19633     delete:
19634       tags:
19635         - Business
19636       summary: delete an existing platform
19637       description: delete an existing platform
19638       operationId: deleteBusinessPlatformsPlatform
19639       consumes:
19640         - application/json
19641         - application/xml
19642       produces:
19643         - application/json
19644         - application/xml
19645       responses:
19646         "default":
19647           description: Response codes found in [response codes](https://wiki.onap.org/).
19648       parameters:
19649         - name: platform-name
19650           in: path
19651           description: Name of the platform
19652           required: true
19653           type: string
19654           example: __PLATFORM-NAME__
19655         - name: resource-version
19656           in: query
19657           description: resource-version for concurrency
19658           required: true
19659           type: string
19660   /business/platforms:
19661     get:
19662       tags:
19663         - Business
19664       summary: returns platforms
19665       description: returns platforms
19666       operationId: getBusinessPlatforms
19667       produces:
19668         - application/json
19669         - application/xml
19670       responses:
19671         "200":
19672           description: successful operation
19673           schema:
19674               $ref: "#/getDefinitions/platforms"
19675         "default":
19676           description: Response codes found in [response codes](https://wiki.onap.org/).
19677   /business/projects/project/{project-name}/relationship-list/relationship:
19678     put:
19679       tags:
19680         - Business
19681       summary: see node definition for valid relationships
19682       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
19683       consumes:
19684         - application/json
19685         - application/xml
19686       produces:
19687         - application/json
19688         - application/xml
19689       responses:
19690         "default":
19691           description: Response codes found in [response codes](https://wiki.onap.org/).
19692       parameters:
19693         - name: project-name
19694           in: path
19695           description: Name of the project deploying a service
19696           required: true
19697           type: string
19698           example: __PROJECT-NAME__
19699         - name: body
19700           in: body
19701           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
19702           required: true
19703           schema:
19704             $ref: "#/definitions/relationship"
19705     delete:
19706       tags:
19707         - Business
19708       summary: delete an existing relationship
19709       description: delete an existing relationship
19710       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
19711       consumes:
19712         - application/json
19713         - application/xml
19714       produces:
19715         - application/json
19716         - application/xml
19717       responses:
19718         "default":
19719           description: Response codes found in [response codes](https://wiki.onap.org/).
19720       parameters:
19721         - name: project-name
19722           in: path
19723           description: Name of the project deploying a service
19724           required: true
19725           type: string
19726           example: __PROJECT-NAME__
19727   /business/projects/project/{project-name}:
19728     get:
19729       tags:
19730         - Business
19731       summary: returns project
19732       description: returns project
19733       operationId: getBusinessProjectsProject
19734       produces:
19735         - application/json
19736         - application/xml
19737       responses:
19738         "200":
19739           description: successful operation
19740           schema:
19741               $ref: "#/getDefinitions/project"
19742         "default":
19743           description: Response codes found in [response codes](https://wiki.onap.org/).
19744       parameters:
19745         - name: project-name
19746           in: path
19747           description: Name of the project deploying a service
19748           required: true
19749           type: string
19750           example: __PROJECT-NAME__
19751     put:
19752       tags:
19753         - Business
19754       summary: create or update an existing project
19755       description: |
19756         Create or update an existing project.
19757         #
19758         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19759       operationId: createOrUpdateBusinessProjectsProject
19760       consumes:
19761         - application/json
19762         - application/xml
19763       produces:
19764         - application/json
19765         - application/xml
19766       responses:
19767         "default":
19768           description: Response codes found in [response codes](https://wiki.onap.org/).
19769       parameters:
19770         - name: project-name
19771           in: path
19772           description: Name of the project deploying a service
19773           required: true
19774           type: string
19775           example: __PROJECT-NAME__
19776         - name: body
19777           in: body
19778           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
19779           required: true
19780           schema:
19781             $ref: "#/definitions/project"
19782     patch:
19783       tags:
19784         - Business
19785       summary: update an existing project
19786       description: |
19787         Update an existing project
19788         #
19789         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19790         The PUT operation will entirely replace an existing object.
19791         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19792         #
19793         Other differences between PUT and PATCH are:
19794         #
19795         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19796         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19797         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19798       operationId: UpdateBusinessProjectsProject
19799       consumes:
19800         - application/json
19801         - application/xml
19802       produces:
19803         - application/json
19804         - application/xml
19805       responses:
19806         "default":
19807           description: Response codes found in [response codes](https://wiki.onap.org/).
19808       parameters:
19809         - name: project-name
19810           in: path
19811           description: Name of the project deploying a service
19812           required: true
19813           type: string
19814           example: __PROJECT-NAME__
19815         - name: body
19816           in: body
19817           description: project object that needs to be created or updated.
19818           required: true
19819           schema:
19820             $ref: "#/patchDefinitions/project"
19821     delete:
19822       tags:
19823         - Business
19824       summary: delete an existing project
19825       description: delete an existing project
19826       operationId: deleteBusinessProjectsProject
19827       consumes:
19828         - application/json
19829         - application/xml
19830       produces:
19831         - application/json
19832         - application/xml
19833       responses:
19834         "default":
19835           description: Response codes found in [response codes](https://wiki.onap.org/).
19836       parameters:
19837         - name: project-name
19838           in: path
19839           description: Name of the project deploying a service
19840           required: true
19841           type: string
19842           example: __PROJECT-NAME__
19843         - name: resource-version
19844           in: query
19845           description: resource-version for concurrency
19846           required: true
19847           type: string
19848   /business/projects:
19849     get:
19850       tags:
19851         - Business
19852       summary: returns projects
19853       description: returns projects
19854       operationId: getBusinessProjects
19855       produces:
19856         - application/json
19857         - application/xml
19858       responses:
19859         "200":
19860           description: successful operation
19861           schema:
19862               $ref: "#/getDefinitions/projects"
19863         "default":
19864           description: Response codes found in [response codes](https://wiki.onap.org/).
19865   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
19866     put:
19867       tags:
19868         - ServiceDesignAndCreation
19869       summary: see node definition for valid relationships
19870       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
19871       consumes:
19872         - application/json
19873         - application/xml
19874       produces:
19875         - application/json
19876         - application/xml
19877       responses:
19878         "default":
19879           description: Response codes found in [response codes](https://wiki.onap.org/).
19880       parameters:
19881         - name: vnf-image-uuid
19882           in: path
19883           description: Unique ID of this asset
19884           required: true
19885           type: string
19886           example: __VNF-IMAGE-UUID__
19887         - name: body
19888           in: body
19889           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
19890           required: true
19891           schema:
19892             $ref: "#/definitions/relationship"
19893     delete:
19894       tags:
19895         - ServiceDesignAndCreation
19896       summary: delete an existing relationship
19897       description: delete an existing relationship
19898       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
19899       consumes:
19900         - application/json
19901         - application/xml
19902       produces:
19903         - application/json
19904         - application/xml
19905       responses:
19906         "default":
19907           description: Response codes found in [response codes](https://wiki.onap.org/).
19908       parameters:
19909         - name: vnf-image-uuid
19910           in: path
19911           description: Unique ID of this asset
19912           required: true
19913           type: string
19914           example: __VNF-IMAGE-UUID__
19915   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
19916     get:
19917       tags:
19918         - ServiceDesignAndCreation
19919       summary: returns vnf-image
19920       description: returns vnf-image
19921       operationId: getServiceDesignAndCreationVnfImagesVnfImage
19922       produces:
19923         - application/json
19924         - application/xml
19925       responses:
19926         "200":
19927           description: successful operation
19928           schema:
19929               $ref: "#/getDefinitions/vnf-image"
19930         "default":
19931           description: Response codes found in [response codes](https://wiki.onap.org/).
19932       parameters:
19933         - name: vnf-image-uuid
19934           in: path
19935           description: Unique ID of this asset
19936           required: true
19937           type: string
19938           example: __VNF-IMAGE-UUID__
19939         - name: application
19940           in: query
19941           description: The application that the image instantiates.
19942           required: false
19943           type: string
19944         - name: application-vendor
19945           in: query
19946           description: The vendor of the application.
19947           required: false
19948           type: string
19949         - name: application-version
19950           in: query
19951           description: The version of the application.
19952           required: false
19953           type: string
19954     put:
19955       tags:
19956         - ServiceDesignAndCreation
19957       summary: create or update an existing vnf-image
19958       description: |
19959         Create or update an existing vnf-image.
19960         #
19961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19962       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
19963       consumes:
19964         - application/json
19965         - application/xml
19966       produces:
19967         - application/json
19968         - application/xml
19969       responses:
19970         "default":
19971           description: Response codes found in [response codes](https://wiki.onap.org/).
19972       parameters:
19973         - name: vnf-image-uuid
19974           in: path
19975           description: Unique ID of this asset
19976           required: true
19977           type: string
19978           example: __VNF-IMAGE-UUID__
19979         - name: body
19980           in: body
19981           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
19982           required: true
19983           schema:
19984             $ref: "#/definitions/vnf-image"
19985     patch:
19986       tags:
19987         - ServiceDesignAndCreation
19988       summary: update an existing vnf-image
19989       description: |
19990         Update an existing vnf-image
19991         #
19992         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19993         The PUT operation will entirely replace an existing object.
19994         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19995         #
19996         Other differences between PUT and PATCH are:
19997         #
19998         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19999         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20000         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20001       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
20002       consumes:
20003         - application/json
20004         - application/xml
20005       produces:
20006         - application/json
20007         - application/xml
20008       responses:
20009         "default":
20010           description: Response codes found in [response codes](https://wiki.onap.org/).
20011       parameters:
20012         - name: vnf-image-uuid
20013           in: path
20014           description: Unique ID of this asset
20015           required: true
20016           type: string
20017           example: __VNF-IMAGE-UUID__
20018         - name: body
20019           in: body
20020           description: vnf-image object that needs to be created or updated.
20021           required: true
20022           schema:
20023             $ref: "#/patchDefinitions/vnf-image"
20024     delete:
20025       tags:
20026         - ServiceDesignAndCreation
20027       summary: delete an existing vnf-image
20028       description: delete an existing vnf-image
20029       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
20030       consumes:
20031         - application/json
20032         - application/xml
20033       produces:
20034         - application/json
20035         - application/xml
20036       responses:
20037         "default":
20038           description: Response codes found in [response codes](https://wiki.onap.org/).
20039       parameters:
20040         - name: vnf-image-uuid
20041           in: path
20042           description: Unique ID of this asset
20043           required: true
20044           type: string
20045           example: __VNF-IMAGE-UUID__
20046         - name: resource-version
20047           in: query
20048           description: resource-version for concurrency
20049           required: true
20050           type: string
20051   /service-design-and-creation/vnf-images:
20052     get:
20053       tags:
20054         - ServiceDesignAndCreation
20055       summary: returns vnf-images
20056       description: returns vnf-images
20057       operationId: getServiceDesignAndCreationVnfImages
20058       produces:
20059         - application/json
20060         - application/xml
20061       responses:
20062         "200":
20063           description: successful operation
20064           schema:
20065               $ref: "#/getDefinitions/vnf-images"
20066         "default":
20067           description: Response codes found in [response codes](https://wiki.onap.org/).
20068   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
20069     put:
20070       tags:
20071         - ServiceDesignAndCreation
20072       summary: see node definition for valid relationships
20073       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
20074       consumes:
20075         - application/json
20076         - application/xml
20077       produces:
20078         - application/json
20079         - application/xml
20080       responses:
20081         "default":
20082           description: Response codes found in [response codes](https://wiki.onap.org/).
20083       parameters:
20084         - name: service-id
20085           in: path
20086           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20087           required: true
20088           type: string
20089           example: __SERVICE-ID__
20090         - name: body
20091           in: body
20092           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
20093           required: true
20094           schema:
20095             $ref: "#/definitions/relationship"
20096     delete:
20097       tags:
20098         - ServiceDesignAndCreation
20099       summary: delete an existing relationship
20100       description: delete an existing relationship
20101       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
20102       consumes:
20103         - application/json
20104         - application/xml
20105       produces:
20106         - application/json
20107         - application/xml
20108       responses:
20109         "default":
20110           description: Response codes found in [response codes](https://wiki.onap.org/).
20111       parameters:
20112         - name: service-id
20113           in: path
20114           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20115           required: true
20116           type: string
20117           example: __SERVICE-ID__
20118   /service-design-and-creation/services/service/{service-id}:
20119     get:
20120       tags:
20121         - ServiceDesignAndCreation
20122       summary: returns service
20123       description: returns service
20124       operationId: getServiceDesignAndCreationServicesService
20125       produces:
20126         - application/json
20127         - application/xml
20128       responses:
20129         "200":
20130           description: successful operation
20131           schema:
20132               $ref: "#/getDefinitions/service"
20133         "default":
20134           description: Response codes found in [response codes](https://wiki.onap.org/).
20135       parameters:
20136         - name: service-id
20137           in: path
20138           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20139           required: true
20140           type: string
20141           example: __SERVICE-ID__
20142         - name: service-description
20143           in: query
20144           description: Description of the service
20145           required: false
20146           type: string
20147     put:
20148       tags:
20149         - ServiceDesignAndCreation
20150       summary: create or update an existing service
20151       description: |
20152         Create or update an existing service.
20153         #
20154         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20155       operationId: createOrUpdateServiceDesignAndCreationServicesService
20156       consumes:
20157         - application/json
20158         - application/xml
20159       produces:
20160         - application/json
20161         - application/xml
20162       responses:
20163         "default":
20164           description: Response codes found in [response codes](https://wiki.onap.org/).
20165       parameters:
20166         - name: service-id
20167           in: path
20168           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20169           required: true
20170           type: string
20171           example: __SERVICE-ID__
20172         - name: body
20173           in: body
20174           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
20175           required: true
20176           schema:
20177             $ref: "#/definitions/service"
20178     patch:
20179       tags:
20180         - ServiceDesignAndCreation
20181       summary: update an existing service
20182       description: |
20183         Update an existing service
20184         #
20185         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20186         The PUT operation will entirely replace an existing object.
20187         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20188         #
20189         Other differences between PUT and PATCH are:
20190         #
20191         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20192         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20193         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20194       operationId: UpdateServiceDesignAndCreationServicesService
20195       consumes:
20196         - application/json
20197         - application/xml
20198       produces:
20199         - application/json
20200         - application/xml
20201       responses:
20202         "default":
20203           description: Response codes found in [response codes](https://wiki.onap.org/).
20204       parameters:
20205         - name: service-id
20206           in: path
20207           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20208           required: true
20209           type: string
20210           example: __SERVICE-ID__
20211         - name: body
20212           in: body
20213           description: service object that needs to be created or updated.
20214           required: true
20215           schema:
20216             $ref: "#/patchDefinitions/service"
20217     delete:
20218       tags:
20219         - ServiceDesignAndCreation
20220       summary: delete an existing service
20221       description: delete an existing service
20222       operationId: deleteServiceDesignAndCreationServicesService
20223       consumes:
20224         - application/json
20225         - application/xml
20226       produces:
20227         - application/json
20228         - application/xml
20229       responses:
20230         "default":
20231           description: Response codes found in [response codes](https://wiki.onap.org/).
20232       parameters:
20233         - name: service-id
20234           in: path
20235           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20236           required: true
20237           type: string
20238           example: __SERVICE-ID__
20239         - name: resource-version
20240           in: query
20241           description: resource-version for concurrency
20242           required: true
20243           type: string
20244   /service-design-and-creation/services:
20245     get:
20246       tags:
20247         - ServiceDesignAndCreation
20248       summary: returns services
20249       description: returns services
20250       operationId: getServiceDesignAndCreationServices
20251       produces:
20252         - application/json
20253         - application/xml
20254       responses:
20255         "200":
20256           description: successful operation
20257           schema:
20258               $ref: "#/getDefinitions/services"
20259         "default":
20260           description: Response codes found in [response codes](https://wiki.onap.org/).
20261   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
20262     put:
20263       tags:
20264         - ServiceDesignAndCreation
20265       summary: see node definition for valid relationships
20266       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
20267       consumes:
20268         - application/json
20269         - application/xml
20270       produces:
20271         - application/json
20272         - application/xml
20273       responses:
20274         "default":
20275           description: Response codes found in [response codes](https://wiki.onap.org/).
20276       parameters:
20277         - name: service-type
20278           in: path
20279           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20280           required: true
20281           type: string
20282           example: __SERVICE-TYPE__
20283         - name: vnf-type
20284           in: path
20285           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.
20286           required: true
20287           type: string
20288           example: __VNF-TYPE__
20289         - name: body
20290           in: body
20291           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
20292           required: true
20293           schema:
20294             $ref: "#/definitions/relationship"
20295     delete:
20296       tags:
20297         - ServiceDesignAndCreation
20298       summary: delete an existing relationship
20299       description: delete an existing relationship
20300       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
20301       consumes:
20302         - application/json
20303         - application/xml
20304       produces:
20305         - application/json
20306         - application/xml
20307       responses:
20308         "default":
20309           description: Response codes found in [response codes](https://wiki.onap.org/).
20310       parameters:
20311         - name: service-type
20312           in: path
20313           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20314           required: true
20315           type: string
20316           example: __SERVICE-TYPE__
20317         - name: vnf-type
20318           in: path
20319           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.
20320           required: true
20321           type: string
20322           example: __VNF-TYPE__
20323   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
20324     get:
20325       tags:
20326         - ServiceDesignAndCreation
20327       summary: returns service-capability
20328       description: returns service-capability
20329       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
20330       produces:
20331         - application/json
20332         - application/xml
20333       responses:
20334         "200":
20335           description: successful operation
20336           schema:
20337               $ref: "#/getDefinitions/service-capability"
20338         "default":
20339           description: Response codes found in [response codes](https://wiki.onap.org/).
20340       parameters:
20341         - name: service-type
20342           in: path
20343           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20344           required: true
20345           type: string
20346           example: __SERVICE-TYPE__
20347         - name: vnf-type
20348           in: path
20349           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.
20350           required: true
20351           type: string
20352           example: __VNF-TYPE__
20353     put:
20354       tags:
20355         - ServiceDesignAndCreation
20356       summary: create or update an existing service-capability
20357       description: |
20358         Create or update an existing service-capability.
20359         #
20360         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20361       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
20362       consumes:
20363         - application/json
20364         - application/xml
20365       produces:
20366         - application/json
20367         - application/xml
20368       responses:
20369         "default":
20370           description: Response codes found in [response codes](https://wiki.onap.org/).
20371       parameters:
20372         - name: service-type
20373           in: path
20374           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20375           required: true
20376           type: string
20377           example: __SERVICE-TYPE__
20378         - name: vnf-type
20379           in: path
20380           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.
20381           required: true
20382           type: string
20383           example: __VNF-TYPE__
20384         - name: body
20385           in: body
20386           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
20387           required: true
20388           schema:
20389             $ref: "#/definitions/service-capability"
20390     patch:
20391       tags:
20392         - ServiceDesignAndCreation
20393       summary: update an existing service-capability
20394       description: |
20395         Update an existing service-capability
20396         #
20397         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20398         The PUT operation will entirely replace an existing object.
20399         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20400         #
20401         Other differences between PUT and PATCH are:
20402         #
20403         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20404         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20405         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20406       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
20407       consumes:
20408         - application/json
20409         - application/xml
20410       produces:
20411         - application/json
20412         - application/xml
20413       responses:
20414         "default":
20415           description: Response codes found in [response codes](https://wiki.onap.org/).
20416       parameters:
20417         - name: service-type
20418           in: path
20419           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20420           required: true
20421           type: string
20422           example: __SERVICE-TYPE__
20423         - name: vnf-type
20424           in: path
20425           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.
20426           required: true
20427           type: string
20428           example: __VNF-TYPE__
20429         - name: body
20430           in: body
20431           description: service-capability object that needs to be created or updated.
20432           required: true
20433           schema:
20434             $ref: "#/patchDefinitions/service-capability"
20435     delete:
20436       tags:
20437         - ServiceDesignAndCreation
20438       summary: delete an existing service-capability
20439       description: delete an existing service-capability
20440       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
20441       consumes:
20442         - application/json
20443         - application/xml
20444       produces:
20445         - application/json
20446         - application/xml
20447       responses:
20448         "default":
20449           description: Response codes found in [response codes](https://wiki.onap.org/).
20450       parameters:
20451         - name: service-type
20452           in: path
20453           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20454           required: true
20455           type: string
20456           example: __SERVICE-TYPE__
20457         - name: vnf-type
20458           in: path
20459           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.
20460           required: true
20461           type: string
20462           example: __VNF-TYPE__
20463         - name: resource-version
20464           in: query
20465           description: resource-version for concurrency
20466           required: true
20467           type: string
20468   /service-design-and-creation/service-capabilities:
20469     get:
20470       tags:
20471         - ServiceDesignAndCreation
20472       summary: returns service-capabilities
20473       description: returns service-capabilities
20474       operationId: getServiceDesignAndCreationServiceCapabilities
20475       produces:
20476         - application/json
20477         - application/xml
20478       responses:
20479         "200":
20480           description: successful operation
20481           schema:
20482               $ref: "#/getDefinitions/service-capabilities"
20483         "default":
20484           description: Response codes found in [response codes](https://wiki.onap.org/).
20485   /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:
20486     put:
20487       tags:
20488         - ServiceDesignAndCreation
20489       summary: see node definition for valid relationships
20490       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
20491       consumes:
20492         - application/json
20493         - application/xml
20494       produces:
20495         - application/json
20496         - application/xml
20497       responses:
20498         "default":
20499           description: Response codes found in [response codes](https://wiki.onap.org/).
20500       parameters:
20501         - name: model-invariant-id
20502           in: path
20503           description: Unique identifier corresponding to the main definition of a model in ASDC
20504           required: true
20505           type: string
20506           example: __MODEL-INVARIANT-ID__
20507         - name: model-version-id
20508           in: path
20509           description: Unique identifier corresponding to one version of a model in ASDC
20510           required: true
20511           type: string
20512           example: __MODEL-VERSION-ID__
20513         - name: model-element-uuid
20514           in: path
20515           required: true
20516           type: string
20517           example: __MODEL-ELEMENT-UUID__
20518         - name: model-constraint-uuid
20519           in: path
20520           required: true
20521           type: string
20522           example: __MODEL-CONSTRAINT-UUID__
20523         - name: constrained-element-set-uuid
20524           in: path
20525           required: true
20526           type: string
20527           example: __CONSTRAINED-ELEMENT-SET-UUID__
20528         - name: element-choice-set-uuid
20529           in: path
20530           required: true
20531           type: string
20532           example: __ELEMENT-CHOICE-SET-UUID__
20533         - name: body
20534           in: body
20535           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
20536           required: true
20537           schema:
20538             $ref: "#/definitions/relationship"
20539     delete:
20540       tags:
20541         - ServiceDesignAndCreation
20542       summary: delete an existing relationship
20543       description: delete an existing relationship
20544       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
20545       consumes:
20546         - application/json
20547         - application/xml
20548       produces:
20549         - application/json
20550         - application/xml
20551       responses:
20552         "default":
20553           description: Response codes found in [response codes](https://wiki.onap.org/).
20554       parameters:
20555         - name: model-invariant-id
20556           in: path
20557           description: Unique identifier corresponding to the main definition of a model in ASDC
20558           required: true
20559           type: string
20560           example: __MODEL-INVARIANT-ID__
20561         - name: model-version-id
20562           in: path
20563           description: Unique identifier corresponding to one version of a model in ASDC
20564           required: true
20565           type: string
20566           example: __MODEL-VERSION-ID__
20567         - name: model-element-uuid
20568           in: path
20569           required: true
20570           type: string
20571           example: __MODEL-ELEMENT-UUID__
20572         - name: model-constraint-uuid
20573           in: path
20574           required: true
20575           type: string
20576           example: __MODEL-CONSTRAINT-UUID__
20577         - name: constrained-element-set-uuid
20578           in: path
20579           required: true
20580           type: string
20581           example: __CONSTRAINED-ELEMENT-SET-UUID__
20582         - name: element-choice-set-uuid
20583           in: path
20584           required: true
20585           type: string
20586           example: __ELEMENT-CHOICE-SET-UUID__
20587   /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}:
20588     get:
20589       tags:
20590         - ServiceDesignAndCreation
20591       summary: returns element-choice-set
20592       description: returns element-choice-set
20593       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20594       produces:
20595         - application/json
20596         - application/xml
20597       responses:
20598         "200":
20599           description: successful operation
20600           schema:
20601               $ref: "#/getDefinitions/element-choice-set"
20602         "default":
20603           description: Response codes found in [response codes](https://wiki.onap.org/).
20604       parameters:
20605         - name: model-invariant-id
20606           in: path
20607           description: Unique identifier corresponding to the main definition of a model in ASDC
20608           required: true
20609           type: string
20610           example: __MODEL-INVARIANT-ID__
20611         - name: model-version-id
20612           in: path
20613           description: Unique identifier corresponding to one version of a model in ASDC
20614           required: true
20615           type: string
20616           example: __MODEL-VERSION-ID__
20617         - name: model-element-uuid
20618           in: path
20619           required: true
20620           type: string
20621           example: __MODEL-ELEMENT-UUID__
20622         - name: model-constraint-uuid
20623           in: path
20624           required: true
20625           type: string
20626           example: __MODEL-CONSTRAINT-UUID__
20627         - name: constrained-element-set-uuid
20628           in: path
20629           required: true
20630           type: string
20631           example: __CONSTRAINED-ELEMENT-SET-UUID__
20632         - name: element-choice-set-uuid
20633           in: path
20634           required: true
20635           type: string
20636           example: __ELEMENT-CHOICE-SET-UUID__
20637         - name: model-type
20638           in: query
20639           description: Type of the model, e.g., service, resource, widget, etc.
20640           required: false
20641           type: string
20642         - name: model-name
20643           in: query
20644           description: Name of the model, which can change from version to version.
20645           required: false
20646           type: string
20647         - name: model-version
20648           in: query
20649           description: Version
20650           required: false
20651           type: string
20652         - name: distribution-status
20653           in: query
20654           description: Distribution Status
20655           required: false
20656           type: string
20657     put:
20658       tags:
20659         - ServiceDesignAndCreation
20660       summary: create or update an existing element-choice-set
20661       description: |
20662         Create or update an existing element-choice-set.
20663         #
20664         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20665       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20666       consumes:
20667         - application/json
20668         - application/xml
20669       produces:
20670         - application/json
20671         - application/xml
20672       responses:
20673         "default":
20674           description: Response codes found in [response codes](https://wiki.onap.org/).
20675       parameters:
20676         - name: model-invariant-id
20677           in: path
20678           description: Unique identifier corresponding to the main definition of a model in ASDC
20679           required: true
20680           type: string
20681           example: __MODEL-INVARIANT-ID__
20682         - name: model-version-id
20683           in: path
20684           description: Unique identifier corresponding to one version of a model in ASDC
20685           required: true
20686           type: string
20687           example: __MODEL-VERSION-ID__
20688         - name: model-element-uuid
20689           in: path
20690           required: true
20691           type: string
20692           example: __MODEL-ELEMENT-UUID__
20693         - name: model-constraint-uuid
20694           in: path
20695           required: true
20696           type: string
20697           example: __MODEL-CONSTRAINT-UUID__
20698         - name: constrained-element-set-uuid
20699           in: path
20700           required: true
20701           type: string
20702           example: __CONSTRAINED-ELEMENT-SET-UUID__
20703         - name: element-choice-set-uuid
20704           in: path
20705           required: true
20706           type: string
20707           example: __ELEMENT-CHOICE-SET-UUID__
20708         - name: body
20709           in: body
20710           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
20711           required: true
20712           schema:
20713             $ref: "#/definitions/element-choice-set"
20714     patch:
20715       tags:
20716         - ServiceDesignAndCreation
20717       summary: update an existing element-choice-set
20718       description: |
20719         Update an existing element-choice-set
20720         #
20721         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20722         The PUT operation will entirely replace an existing object.
20723         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20724         #
20725         Other differences between PUT and PATCH are:
20726         #
20727         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20728         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20729         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20730       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20731       consumes:
20732         - application/json
20733         - application/xml
20734       produces:
20735         - application/json
20736         - application/xml
20737       responses:
20738         "default":
20739           description: Response codes found in [response codes](https://wiki.onap.org/).
20740       parameters:
20741         - name: model-invariant-id
20742           in: path
20743           description: Unique identifier corresponding to the main definition of a model in ASDC
20744           required: true
20745           type: string
20746           example: __MODEL-INVARIANT-ID__
20747         - name: model-version-id
20748           in: path
20749           description: Unique identifier corresponding to one version of a model in ASDC
20750           required: true
20751           type: string
20752           example: __MODEL-VERSION-ID__
20753         - name: model-element-uuid
20754           in: path
20755           required: true
20756           type: string
20757           example: __MODEL-ELEMENT-UUID__
20758         - name: model-constraint-uuid
20759           in: path
20760           required: true
20761           type: string
20762           example: __MODEL-CONSTRAINT-UUID__
20763         - name: constrained-element-set-uuid
20764           in: path
20765           required: true
20766           type: string
20767           example: __CONSTRAINED-ELEMENT-SET-UUID__
20768         - name: element-choice-set-uuid
20769           in: path
20770           required: true
20771           type: string
20772           example: __ELEMENT-CHOICE-SET-UUID__
20773         - name: body
20774           in: body
20775           description: element-choice-set object that needs to be created or updated.
20776           required: true
20777           schema:
20778             $ref: "#/patchDefinitions/element-choice-set"
20779     delete:
20780       tags:
20781         - ServiceDesignAndCreation
20782       summary: delete an existing element-choice-set
20783       description: delete an existing element-choice-set
20784       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20785       consumes:
20786         - application/json
20787         - application/xml
20788       produces:
20789         - application/json
20790         - application/xml
20791       responses:
20792         "default":
20793           description: Response codes found in [response codes](https://wiki.onap.org/).
20794       parameters:
20795         - name: model-invariant-id
20796           in: path
20797           description: Unique identifier corresponding to the main definition of a model in ASDC
20798           required: true
20799           type: string
20800           example: __MODEL-INVARIANT-ID__
20801         - name: model-version-id
20802           in: path
20803           description: Unique identifier corresponding to one version of a model in ASDC
20804           required: true
20805           type: string
20806           example: __MODEL-VERSION-ID__
20807         - name: model-element-uuid
20808           in: path
20809           required: true
20810           type: string
20811           example: __MODEL-ELEMENT-UUID__
20812         - name: model-constraint-uuid
20813           in: path
20814           required: true
20815           type: string
20816           example: __MODEL-CONSTRAINT-UUID__
20817         - name: constrained-element-set-uuid
20818           in: path
20819           required: true
20820           type: string
20821           example: __CONSTRAINED-ELEMENT-SET-UUID__
20822         - name: element-choice-set-uuid
20823           in: path
20824           required: true
20825           type: string
20826           example: __ELEMENT-CHOICE-SET-UUID__
20827         - name: resource-version
20828           in: query
20829           description: resource-version for concurrency
20830           required: true
20831           type: string
20832   /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:
20833     get:
20834       tags:
20835         - ServiceDesignAndCreation
20836       summary: returns element-choice-sets
20837       description: returns element-choice-sets
20838       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
20839       produces:
20840         - application/json
20841         - application/xml
20842       responses:
20843         "200":
20844           description: successful operation
20845           schema:
20846               $ref: "#/getDefinitions/element-choice-sets"
20847         "default":
20848           description: Response codes found in [response codes](https://wiki.onap.org/).
20849       parameters:
20850         - name: model-invariant-id
20851           in: path
20852           description: Unique identifier corresponding to the main definition of a model in ASDC
20853           required: true
20854           type: string
20855           example: __MODEL-INVARIANT-ID__
20856         - name: model-version-id
20857           in: path
20858           description: Unique identifier corresponding to one version of a model in ASDC
20859           required: true
20860           type: string
20861           example: __MODEL-VERSION-ID__
20862         - name: model-element-uuid
20863           in: path
20864           required: true
20865           type: string
20866           example: __MODEL-ELEMENT-UUID__
20867         - name: model-constraint-uuid
20868           in: path
20869           required: true
20870           type: string
20871           example: __MODEL-CONSTRAINT-UUID__
20872         - name: constrained-element-set-uuid
20873           in: path
20874           required: true
20875           type: string
20876           example: __CONSTRAINED-ELEMENT-SET-UUID__
20877         - name: model-type
20878           in: query
20879           description: Type of the model, e.g., service, resource, widget, etc.
20880           required: false
20881           type: string
20882         - name: model-name
20883           in: query
20884           description: Name of the model, which can change from version to version.
20885           required: false
20886           type: string
20887         - name: model-version
20888           in: query
20889           description: Version
20890           required: false
20891           type: string
20892         - name: distribution-status
20893           in: query
20894           description: Distribution Status
20895           required: false
20896           type: string
20897   /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:
20898     put:
20899       tags:
20900         - ServiceDesignAndCreation
20901       summary: see node definition for valid relationships
20902       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
20903       consumes:
20904         - application/json
20905         - application/xml
20906       produces:
20907         - application/json
20908         - application/xml
20909       responses:
20910         "default":
20911           description: Response codes found in [response codes](https://wiki.onap.org/).
20912       parameters:
20913         - name: model-invariant-id
20914           in: path
20915           description: Unique identifier corresponding to the main definition of a model in ASDC
20916           required: true
20917           type: string
20918           example: __MODEL-INVARIANT-ID__
20919         - name: model-version-id
20920           in: path
20921           description: Unique identifier corresponding to one version of a model in ASDC
20922           required: true
20923           type: string
20924           example: __MODEL-VERSION-ID__
20925         - name: model-element-uuid
20926           in: path
20927           required: true
20928           type: string
20929           example: __MODEL-ELEMENT-UUID__
20930         - name: model-constraint-uuid
20931           in: path
20932           required: true
20933           type: string
20934           example: __MODEL-CONSTRAINT-UUID__
20935         - name: constrained-element-set-uuid
20936           in: path
20937           required: true
20938           type: string
20939           example: __CONSTRAINED-ELEMENT-SET-UUID__
20940         - name: body
20941           in: body
20942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
20943           required: true
20944           schema:
20945             $ref: "#/definitions/relationship"
20946     delete:
20947       tags:
20948         - ServiceDesignAndCreation
20949       summary: delete an existing relationship
20950       description: delete an existing relationship
20951       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
20952       consumes:
20953         - application/json
20954         - application/xml
20955       produces:
20956         - application/json
20957         - application/xml
20958       responses:
20959         "default":
20960           description: Response codes found in [response codes](https://wiki.onap.org/).
20961       parameters:
20962         - name: model-invariant-id
20963           in: path
20964           description: Unique identifier corresponding to the main definition of a model in ASDC
20965           required: true
20966           type: string
20967           example: __MODEL-INVARIANT-ID__
20968         - name: model-version-id
20969           in: path
20970           description: Unique identifier corresponding to one version of a model in ASDC
20971           required: true
20972           type: string
20973           example: __MODEL-VERSION-ID__
20974         - name: model-element-uuid
20975           in: path
20976           required: true
20977           type: string
20978           example: __MODEL-ELEMENT-UUID__
20979         - name: model-constraint-uuid
20980           in: path
20981           required: true
20982           type: string
20983           example: __MODEL-CONSTRAINT-UUID__
20984         - name: constrained-element-set-uuid
20985           in: path
20986           required: true
20987           type: string
20988           example: __CONSTRAINED-ELEMENT-SET-UUID__
20989   /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}:
20990     get:
20991       tags:
20992         - ServiceDesignAndCreation
20993       summary: returns constrained-element-set
20994       description: returns constrained-element-set
20995       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
20996       produces:
20997         - application/json
20998         - application/xml
20999       responses:
21000         "200":
21001           description: successful operation
21002           schema:
21003               $ref: "#/getDefinitions/constrained-element-set"
21004         "default":
21005           description: Response codes found in [response codes](https://wiki.onap.org/).
21006       parameters:
21007         - name: model-invariant-id
21008           in: path
21009           description: Unique identifier corresponding to the main definition of a model in ASDC
21010           required: true
21011           type: string
21012           example: __MODEL-INVARIANT-ID__
21013         - name: model-version-id
21014           in: path
21015           description: Unique identifier corresponding to one version of a model in ASDC
21016           required: true
21017           type: string
21018           example: __MODEL-VERSION-ID__
21019         - name: model-element-uuid
21020           in: path
21021           required: true
21022           type: string
21023           example: __MODEL-ELEMENT-UUID__
21024         - name: model-constraint-uuid
21025           in: path
21026           required: true
21027           type: string
21028           example: __MODEL-CONSTRAINT-UUID__
21029         - name: constrained-element-set-uuid
21030           in: path
21031           required: true
21032           type: string
21033           example: __CONSTRAINED-ELEMENT-SET-UUID__
21034         - name: model-type
21035           in: query
21036           description: Type of the model, e.g., service, resource, widget, etc.
21037           required: false
21038           type: string
21039         - name: model-name
21040           in: query
21041           description: Name of the model, which can change from version to version.
21042           required: false
21043           type: string
21044         - name: model-version
21045           in: query
21046           description: Version
21047           required: false
21048           type: string
21049         - name: distribution-status
21050           in: query
21051           description: Distribution Status
21052           required: false
21053           type: string
21054     put:
21055       tags:
21056         - ServiceDesignAndCreation
21057       summary: create or update an existing constrained-element-set
21058       description: |
21059         Create or update an existing constrained-element-set.
21060         #
21061         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21062       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
21063       consumes:
21064         - application/json
21065         - application/xml
21066       produces:
21067         - application/json
21068         - application/xml
21069       responses:
21070         "default":
21071           description: Response codes found in [response codes](https://wiki.onap.org/).
21072       parameters:
21073         - name: model-invariant-id
21074           in: path
21075           description: Unique identifier corresponding to the main definition of a model in ASDC
21076           required: true
21077           type: string
21078           example: __MODEL-INVARIANT-ID__
21079         - name: model-version-id
21080           in: path
21081           description: Unique identifier corresponding to one version of a model in ASDC
21082           required: true
21083           type: string
21084           example: __MODEL-VERSION-ID__
21085         - name: model-element-uuid
21086           in: path
21087           required: true
21088           type: string
21089           example: __MODEL-ELEMENT-UUID__
21090         - name: model-constraint-uuid
21091           in: path
21092           required: true
21093           type: string
21094           example: __MODEL-CONSTRAINT-UUID__
21095         - name: constrained-element-set-uuid
21096           in: path
21097           required: true
21098           type: string
21099           example: __CONSTRAINED-ELEMENT-SET-UUID__
21100         - name: body
21101           in: body
21102           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
21103           required: true
21104           schema:
21105             $ref: "#/definitions/constrained-element-set"
21106     patch:
21107       tags:
21108         - ServiceDesignAndCreation
21109       summary: update an existing constrained-element-set
21110       description: |
21111         Update an existing constrained-element-set
21112         #
21113         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21114         The PUT operation will entirely replace an existing object.
21115         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21116         #
21117         Other differences between PUT and PATCH are:
21118         #
21119         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21120         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21121         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21122       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
21123       consumes:
21124         - application/json
21125         - application/xml
21126       produces:
21127         - application/json
21128         - application/xml
21129       responses:
21130         "default":
21131           description: Response codes found in [response codes](https://wiki.onap.org/).
21132       parameters:
21133         - name: model-invariant-id
21134           in: path
21135           description: Unique identifier corresponding to the main definition of a model in ASDC
21136           required: true
21137           type: string
21138           example: __MODEL-INVARIANT-ID__
21139         - name: model-version-id
21140           in: path
21141           description: Unique identifier corresponding to one version of a model in ASDC
21142           required: true
21143           type: string
21144           example: __MODEL-VERSION-ID__
21145         - name: model-element-uuid
21146           in: path
21147           required: true
21148           type: string
21149           example: __MODEL-ELEMENT-UUID__
21150         - name: model-constraint-uuid
21151           in: path
21152           required: true
21153           type: string
21154           example: __MODEL-CONSTRAINT-UUID__
21155         - name: constrained-element-set-uuid
21156           in: path
21157           required: true
21158           type: string
21159           example: __CONSTRAINED-ELEMENT-SET-UUID__
21160         - name: body
21161           in: body
21162           description: constrained-element-set object that needs to be created or updated.
21163           required: true
21164           schema:
21165             $ref: "#/patchDefinitions/constrained-element-set"
21166     delete:
21167       tags:
21168         - ServiceDesignAndCreation
21169       summary: delete an existing constrained-element-set
21170       description: delete an existing constrained-element-set
21171       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
21172       consumes:
21173         - application/json
21174         - application/xml
21175       produces:
21176         - application/json
21177         - application/xml
21178       responses:
21179         "default":
21180           description: Response codes found in [response codes](https://wiki.onap.org/).
21181       parameters:
21182         - name: model-invariant-id
21183           in: path
21184           description: Unique identifier corresponding to the main definition of a model in ASDC
21185           required: true
21186           type: string
21187           example: __MODEL-INVARIANT-ID__
21188         - name: model-version-id
21189           in: path
21190           description: Unique identifier corresponding to one version of a model in ASDC
21191           required: true
21192           type: string
21193           example: __MODEL-VERSION-ID__
21194         - name: model-element-uuid
21195           in: path
21196           required: true
21197           type: string
21198           example: __MODEL-ELEMENT-UUID__
21199         - name: model-constraint-uuid
21200           in: path
21201           required: true
21202           type: string
21203           example: __MODEL-CONSTRAINT-UUID__
21204         - name: constrained-element-set-uuid
21205           in: path
21206           required: true
21207           type: string
21208           example: __CONSTRAINED-ELEMENT-SET-UUID__
21209         - name: resource-version
21210           in: query
21211           description: resource-version for concurrency
21212           required: true
21213           type: string
21214   /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:
21215     get:
21216       tags:
21217         - ServiceDesignAndCreation
21218       summary: returns constrained-element-sets
21219       description: returns constrained-element-sets
21220       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
21221       produces:
21222         - application/json
21223         - application/xml
21224       responses:
21225         "200":
21226           description: successful operation
21227           schema:
21228               $ref: "#/getDefinitions/constrained-element-sets"
21229         "default":
21230           description: Response codes found in [response codes](https://wiki.onap.org/).
21231       parameters:
21232         - name: model-invariant-id
21233           in: path
21234           description: Unique identifier corresponding to the main definition of a model in ASDC
21235           required: true
21236           type: string
21237           example: __MODEL-INVARIANT-ID__
21238         - name: model-version-id
21239           in: path
21240           description: Unique identifier corresponding to one version of a model in ASDC
21241           required: true
21242           type: string
21243           example: __MODEL-VERSION-ID__
21244         - name: model-element-uuid
21245           in: path
21246           required: true
21247           type: string
21248           example: __MODEL-ELEMENT-UUID__
21249         - name: model-constraint-uuid
21250           in: path
21251           required: true
21252           type: string
21253           example: __MODEL-CONSTRAINT-UUID__
21254         - name: model-type
21255           in: query
21256           description: Type of the model, e.g., service, resource, widget, etc.
21257           required: false
21258           type: string
21259         - name: model-name
21260           in: query
21261           description: Name of the model, which can change from version to version.
21262           required: false
21263           type: string
21264         - name: model-version
21265           in: query
21266           description: Version
21267           required: false
21268           type: string
21269         - name: distribution-status
21270           in: query
21271           description: Distribution Status
21272           required: false
21273           type: string
21274   /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}:
21275     get:
21276       tags:
21277         - ServiceDesignAndCreation
21278       summary: returns model-constraint
21279       description: returns model-constraint
21280       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
21281       produces:
21282         - application/json
21283         - application/xml
21284       responses:
21285         "200":
21286           description: successful operation
21287           schema:
21288               $ref: "#/getDefinitions/model-constraint"
21289         "default":
21290           description: Response codes found in [response codes](https://wiki.onap.org/).
21291       parameters:
21292         - name: model-invariant-id
21293           in: path
21294           description: Unique identifier corresponding to the main definition of a model in ASDC
21295           required: true
21296           type: string
21297           example: __MODEL-INVARIANT-ID__
21298         - name: model-version-id
21299           in: path
21300           description: Unique identifier corresponding to one version of a model in ASDC
21301           required: true
21302           type: string
21303           example: __MODEL-VERSION-ID__
21304         - name: model-element-uuid
21305           in: path
21306           required: true
21307           type: string
21308           example: __MODEL-ELEMENT-UUID__
21309         - name: model-constraint-uuid
21310           in: path
21311           required: true
21312           type: string
21313           example: __MODEL-CONSTRAINT-UUID__
21314         - name: model-type
21315           in: query
21316           description: Type of the model, e.g., service, resource, widget, etc.
21317           required: false
21318           type: string
21319         - name: model-name
21320           in: query
21321           description: Name of the model, which can change from version to version.
21322           required: false
21323           type: string
21324         - name: model-version
21325           in: query
21326           description: Version
21327           required: false
21328           type: string
21329         - name: distribution-status
21330           in: query
21331           description: Distribution Status
21332           required: false
21333           type: string
21334     put:
21335       tags:
21336         - ServiceDesignAndCreation
21337       summary: create or update an existing model-constraint
21338       description: |
21339         Create or update an existing model-constraint.
21340         #
21341         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21342       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
21343       consumes:
21344         - application/json
21345         - application/xml
21346       produces:
21347         - application/json
21348         - application/xml
21349       responses:
21350         "default":
21351           description: Response codes found in [response codes](https://wiki.onap.org/).
21352       parameters:
21353         - name: model-invariant-id
21354           in: path
21355           description: Unique identifier corresponding to the main definition of a model in ASDC
21356           required: true
21357           type: string
21358           example: __MODEL-INVARIANT-ID__
21359         - name: model-version-id
21360           in: path
21361           description: Unique identifier corresponding to one version of a model in ASDC
21362           required: true
21363           type: string
21364           example: __MODEL-VERSION-ID__
21365         - name: model-element-uuid
21366           in: path
21367           required: true
21368           type: string
21369           example: __MODEL-ELEMENT-UUID__
21370         - name: model-constraint-uuid
21371           in: path
21372           required: true
21373           type: string
21374           example: __MODEL-CONSTRAINT-UUID__
21375         - name: body
21376           in: body
21377           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
21378           required: true
21379           schema:
21380             $ref: "#/definitions/model-constraint"
21381     patch:
21382       tags:
21383         - ServiceDesignAndCreation
21384       summary: update an existing model-constraint
21385       description: |
21386         Update an existing model-constraint
21387         #
21388         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21389         The PUT operation will entirely replace an existing object.
21390         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21391         #
21392         Other differences between PUT and PATCH are:
21393         #
21394         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21395         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21396         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21397       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
21398       consumes:
21399         - application/json
21400         - application/xml
21401       produces:
21402         - application/json
21403         - application/xml
21404       responses:
21405         "default":
21406           description: Response codes found in [response codes](https://wiki.onap.org/).
21407       parameters:
21408         - name: model-invariant-id
21409           in: path
21410           description: Unique identifier corresponding to the main definition of a model in ASDC
21411           required: true
21412           type: string
21413           example: __MODEL-INVARIANT-ID__
21414         - name: model-version-id
21415           in: path
21416           description: Unique identifier corresponding to one version of a model in ASDC
21417           required: true
21418           type: string
21419           example: __MODEL-VERSION-ID__
21420         - name: model-element-uuid
21421           in: path
21422           required: true
21423           type: string
21424           example: __MODEL-ELEMENT-UUID__
21425         - name: model-constraint-uuid
21426           in: path
21427           required: true
21428           type: string
21429           example: __MODEL-CONSTRAINT-UUID__
21430         - name: body
21431           in: body
21432           description: model-constraint object that needs to be created or updated.
21433           required: true
21434           schema:
21435             $ref: "#/patchDefinitions/model-constraint"
21436     delete:
21437       tags:
21438         - ServiceDesignAndCreation
21439       summary: delete an existing model-constraint
21440       description: delete an existing model-constraint
21441       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
21442       consumes:
21443         - application/json
21444         - application/xml
21445       produces:
21446         - application/json
21447         - application/xml
21448       responses:
21449         "default":
21450           description: Response codes found in [response codes](https://wiki.onap.org/).
21451       parameters:
21452         - name: model-invariant-id
21453           in: path
21454           description: Unique identifier corresponding to the main definition of a model in ASDC
21455           required: true
21456           type: string
21457           example: __MODEL-INVARIANT-ID__
21458         - name: model-version-id
21459           in: path
21460           description: Unique identifier corresponding to one version of a model in ASDC
21461           required: true
21462           type: string
21463           example: __MODEL-VERSION-ID__
21464         - name: model-element-uuid
21465           in: path
21466           required: true
21467           type: string
21468           example: __MODEL-ELEMENT-UUID__
21469         - name: model-constraint-uuid
21470           in: path
21471           required: true
21472           type: string
21473           example: __MODEL-CONSTRAINT-UUID__
21474         - name: resource-version
21475           in: query
21476           description: resource-version for concurrency
21477           required: true
21478           type: string
21479   /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:
21480     get:
21481       tags:
21482         - ServiceDesignAndCreation
21483       summary: returns model-constraints
21484       description: returns model-constraints
21485       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
21486       produces:
21487         - application/json
21488         - application/xml
21489       responses:
21490         "200":
21491           description: successful operation
21492           schema:
21493               $ref: "#/getDefinitions/model-constraints"
21494         "default":
21495           description: Response codes found in [response codes](https://wiki.onap.org/).
21496       parameters:
21497         - name: model-invariant-id
21498           in: path
21499           description: Unique identifier corresponding to the main definition of a model in ASDC
21500           required: true
21501           type: string
21502           example: __MODEL-INVARIANT-ID__
21503         - name: model-version-id
21504           in: path
21505           description: Unique identifier corresponding to one version of a model in ASDC
21506           required: true
21507           type: string
21508           example: __MODEL-VERSION-ID__
21509         - name: model-element-uuid
21510           in: path
21511           required: true
21512           type: string
21513           example: __MODEL-ELEMENT-UUID__
21514         - name: model-type
21515           in: query
21516           description: Type of the model, e.g., service, resource, widget, etc.
21517           required: false
21518           type: string
21519         - name: model-name
21520           in: query
21521           description: Name of the model, which can change from version to version.
21522           required: false
21523           type: string
21524         - name: model-version
21525           in: query
21526           description: Version
21527           required: false
21528           type: string
21529         - name: distribution-status
21530           in: query
21531           description: Distribution Status
21532           required: false
21533           type: string
21534   /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:
21535     put:
21536       tags:
21537         - ServiceDesignAndCreation
21538       summary: see node definition for valid relationships
21539       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
21540       consumes:
21541         - application/json
21542         - application/xml
21543       produces:
21544         - application/json
21545         - application/xml
21546       responses:
21547         "default":
21548           description: Response codes found in [response codes](https://wiki.onap.org/).
21549       parameters:
21550         - name: model-invariant-id
21551           in: path
21552           description: Unique identifier corresponding to the main definition of a model in ASDC
21553           required: true
21554           type: string
21555           example: __MODEL-INVARIANT-ID__
21556         - name: model-version-id
21557           in: path
21558           description: Unique identifier corresponding to one version of a model in ASDC
21559           required: true
21560           type: string
21561           example: __MODEL-VERSION-ID__
21562         - name: model-element-uuid
21563           in: path
21564           required: true
21565           type: string
21566           example: __MODEL-ELEMENT-UUID__
21567         - name: body
21568           in: body
21569           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
21570           required: true
21571           schema:
21572             $ref: "#/definitions/relationship"
21573     delete:
21574       tags:
21575         - ServiceDesignAndCreation
21576       summary: delete an existing relationship
21577       description: delete an existing relationship
21578       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
21579       consumes:
21580         - application/json
21581         - application/xml
21582       produces:
21583         - application/json
21584         - application/xml
21585       responses:
21586         "default":
21587           description: Response codes found in [response codes](https://wiki.onap.org/).
21588       parameters:
21589         - name: model-invariant-id
21590           in: path
21591           description: Unique identifier corresponding to the main definition of a model in ASDC
21592           required: true
21593           type: string
21594           example: __MODEL-INVARIANT-ID__
21595         - name: model-version-id
21596           in: path
21597           description: Unique identifier corresponding to one version of a model in ASDC
21598           required: true
21599           type: string
21600           example: __MODEL-VERSION-ID__
21601         - name: model-element-uuid
21602           in: path
21603           required: true
21604           type: string
21605           example: __MODEL-ELEMENT-UUID__
21606   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
21607     get:
21608       tags:
21609         - ServiceDesignAndCreation
21610       summary: returns model-element
21611       description: returns model-element
21612       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21613       produces:
21614         - application/json
21615         - application/xml
21616       responses:
21617         "200":
21618           description: successful operation
21619           schema:
21620               $ref: "#/getDefinitions/model-element"
21621         "default":
21622           description: Response codes found in [response codes](https://wiki.onap.org/).
21623       parameters:
21624         - name: model-invariant-id
21625           in: path
21626           description: Unique identifier corresponding to the main definition of a model in ASDC
21627           required: true
21628           type: string
21629           example: __MODEL-INVARIANT-ID__
21630         - name: model-version-id
21631           in: path
21632           description: Unique identifier corresponding to one version of a model in ASDC
21633           required: true
21634           type: string
21635           example: __MODEL-VERSION-ID__
21636         - name: model-element-uuid
21637           in: path
21638           required: true
21639           type: string
21640           example: __MODEL-ELEMENT-UUID__
21641         - name: model-type
21642           in: query
21643           description: Type of the model, e.g., service, resource, widget, etc.
21644           required: false
21645           type: string
21646         - name: model-name
21647           in: query
21648           description: Name of the model, which can change from version to version.
21649           required: false
21650           type: string
21651         - name: model-version
21652           in: query
21653           description: Version
21654           required: false
21655           type: string
21656         - name: distribution-status
21657           in: query
21658           description: Distribution Status
21659           required: false
21660           type: string
21661     put:
21662       tags:
21663         - ServiceDesignAndCreation
21664       summary: create or update an existing model-element
21665       description: |
21666         Create or update an existing model-element.
21667         #
21668         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21669       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21670       consumes:
21671         - application/json
21672         - application/xml
21673       produces:
21674         - application/json
21675         - application/xml
21676       responses:
21677         "default":
21678           description: Response codes found in [response codes](https://wiki.onap.org/).
21679       parameters:
21680         - name: model-invariant-id
21681           in: path
21682           description: Unique identifier corresponding to the main definition of a model in ASDC
21683           required: true
21684           type: string
21685           example: __MODEL-INVARIANT-ID__
21686         - name: model-version-id
21687           in: path
21688           description: Unique identifier corresponding to one version of a model in ASDC
21689           required: true
21690           type: string
21691           example: __MODEL-VERSION-ID__
21692         - name: model-element-uuid
21693           in: path
21694           required: true
21695           type: string
21696           example: __MODEL-ELEMENT-UUID__
21697         - name: body
21698           in: body
21699           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
21700           required: true
21701           schema:
21702             $ref: "#/definitions/model-element"
21703     patch:
21704       tags:
21705         - ServiceDesignAndCreation
21706       summary: update an existing model-element
21707       description: |
21708         Update an existing model-element
21709         #
21710         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21711         The PUT operation will entirely replace an existing object.
21712         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21713         #
21714         Other differences between PUT and PATCH are:
21715         #
21716         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21717         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21718         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21719       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21720       consumes:
21721         - application/json
21722         - application/xml
21723       produces:
21724         - application/json
21725         - application/xml
21726       responses:
21727         "default":
21728           description: Response codes found in [response codes](https://wiki.onap.org/).
21729       parameters:
21730         - name: model-invariant-id
21731           in: path
21732           description: Unique identifier corresponding to the main definition of a model in ASDC
21733           required: true
21734           type: string
21735           example: __MODEL-INVARIANT-ID__
21736         - name: model-version-id
21737           in: path
21738           description: Unique identifier corresponding to one version of a model in ASDC
21739           required: true
21740           type: string
21741           example: __MODEL-VERSION-ID__
21742         - name: model-element-uuid
21743           in: path
21744           required: true
21745           type: string
21746           example: __MODEL-ELEMENT-UUID__
21747         - name: body
21748           in: body
21749           description: model-element object that needs to be created or updated.
21750           required: true
21751           schema:
21752             $ref: "#/patchDefinitions/model-element"
21753     delete:
21754       tags:
21755         - ServiceDesignAndCreation
21756       summary: delete an existing model-element
21757       description: delete an existing model-element
21758       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21759       consumes:
21760         - application/json
21761         - application/xml
21762       produces:
21763         - application/json
21764         - application/xml
21765       responses:
21766         "default":
21767           description: Response codes found in [response codes](https://wiki.onap.org/).
21768       parameters:
21769         - name: model-invariant-id
21770           in: path
21771           description: Unique identifier corresponding to the main definition of a model in ASDC
21772           required: true
21773           type: string
21774           example: __MODEL-INVARIANT-ID__
21775         - name: model-version-id
21776           in: path
21777           description: Unique identifier corresponding to one version of a model in ASDC
21778           required: true
21779           type: string
21780           example: __MODEL-VERSION-ID__
21781         - name: model-element-uuid
21782           in: path
21783           required: true
21784           type: string
21785           example: __MODEL-ELEMENT-UUID__
21786         - name: resource-version
21787           in: query
21788           description: resource-version for concurrency
21789           required: true
21790           type: string
21791   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
21792     get:
21793       tags:
21794         - ServiceDesignAndCreation
21795       summary: returns model-elements
21796       description: returns model-elements
21797       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
21798       produces:
21799         - application/json
21800         - application/xml
21801       responses:
21802         "200":
21803           description: successful operation
21804           schema:
21805               $ref: "#/getDefinitions/model-elements"
21806         "default":
21807           description: Response codes found in [response codes](https://wiki.onap.org/).
21808       parameters:
21809         - name: model-invariant-id
21810           in: path
21811           description: Unique identifier corresponding to the main definition of a model in ASDC
21812           required: true
21813           type: string
21814           example: __MODEL-INVARIANT-ID__
21815         - name: model-version-id
21816           in: path
21817           description: Unique identifier corresponding to one version of a model in ASDC
21818           required: true
21819           type: string
21820           example: __MODEL-VERSION-ID__
21821         - name: model-type
21822           in: query
21823           description: Type of the model, e.g., service, resource, widget, etc.
21824           required: false
21825           type: string
21826         - name: model-name
21827           in: query
21828           description: Name of the model, which can change from version to version.
21829           required: false
21830           type: string
21831         - name: model-version
21832           in: query
21833           description: Version
21834           required: false
21835           type: string
21836         - name: distribution-status
21837           in: query
21838           description: Distribution Status
21839           required: false
21840           type: string
21841   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
21842     get:
21843       tags:
21844         - ServiceDesignAndCreation
21845       summary: returns metadatum
21846       description: returns metadatum
21847       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21848       produces:
21849         - application/json
21850         - application/xml
21851       responses:
21852         "200":
21853           description: successful operation
21854           schema:
21855               $ref: "#/getDefinitions/metadatum"
21856         "default":
21857           description: Response codes found in [response codes](https://wiki.onap.org/).
21858       parameters:
21859         - name: model-invariant-id
21860           in: path
21861           description: Unique identifier corresponding to the main definition of a model in ASDC
21862           required: true
21863           type: string
21864           example: __MODEL-INVARIANT-ID__
21865         - name: model-version-id
21866           in: path
21867           description: Unique identifier corresponding to one version of a model in ASDC
21868           required: true
21869           type: string
21870           example: __MODEL-VERSION-ID__
21871         - name: metaname
21872           in: path
21873           required: true
21874           type: string
21875           example: __METANAME__
21876         - name: model-type
21877           in: query
21878           description: Type of the model, e.g., service, resource, widget, etc.
21879           required: false
21880           type: string
21881         - name: model-name
21882           in: query
21883           description: Name of the model, which can change from version to version.
21884           required: false
21885           type: string
21886         - name: model-version
21887           in: query
21888           description: Version
21889           required: false
21890           type: string
21891         - name: distribution-status
21892           in: query
21893           description: Distribution Status
21894           required: false
21895           type: string
21896     put:
21897       tags:
21898         - ServiceDesignAndCreation
21899       summary: create or update an existing metadatum
21900       description: |
21901         Create or update an existing metadatum.
21902         #
21903         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21904       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21905       consumes:
21906         - application/json
21907         - application/xml
21908       produces:
21909         - application/json
21910         - application/xml
21911       responses:
21912         "default":
21913           description: Response codes found in [response codes](https://wiki.onap.org/).
21914       parameters:
21915         - name: model-invariant-id
21916           in: path
21917           description: Unique identifier corresponding to the main definition of a model in ASDC
21918           required: true
21919           type: string
21920           example: __MODEL-INVARIANT-ID__
21921         - name: model-version-id
21922           in: path
21923           description: Unique identifier corresponding to one version of a model in ASDC
21924           required: true
21925           type: string
21926           example: __MODEL-VERSION-ID__
21927         - name: metaname
21928           in: path
21929           required: true
21930           type: string
21931           example: __METANAME__
21932         - name: body
21933           in: body
21934           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
21935           required: true
21936           schema:
21937             $ref: "#/definitions/metadatum"
21938     patch:
21939       tags:
21940         - ServiceDesignAndCreation
21941       summary: update an existing metadatum
21942       description: |
21943         Update an existing metadatum
21944         #
21945         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21946         The PUT operation will entirely replace an existing object.
21947         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21948         #
21949         Other differences between PUT and PATCH are:
21950         #
21951         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21952         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21953         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21954       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21955       consumes:
21956         - application/json
21957         - application/xml
21958       produces:
21959         - application/json
21960         - application/xml
21961       responses:
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-version-id
21972           in: path
21973           description: Unique identifier corresponding to one version of a model in ASDC
21974           required: true
21975           type: string
21976           example: __MODEL-VERSION-ID__
21977         - name: metaname
21978           in: path
21979           required: true
21980           type: string
21981           example: __METANAME__
21982         - name: body
21983           in: body
21984           description: metadatum object that needs to be created or updated.
21985           required: true
21986           schema:
21987             $ref: "#/patchDefinitions/metadatum"
21988     delete:
21989       tags:
21990         - ServiceDesignAndCreation
21991       summary: delete an existing metadatum
21992       description: delete an existing metadatum
21993       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21994       consumes:
21995         - application/json
21996         - application/xml
21997       produces:
21998         - application/json
21999         - application/xml
22000       responses:
22001         "default":
22002           description: Response codes found in [response codes](https://wiki.onap.org/).
22003       parameters:
22004         - name: model-invariant-id
22005           in: path
22006           description: Unique identifier corresponding to the main definition of a model in ASDC
22007           required: true
22008           type: string
22009           example: __MODEL-INVARIANT-ID__
22010         - name: model-version-id
22011           in: path
22012           description: Unique identifier corresponding to one version of a model in ASDC
22013           required: true
22014           type: string
22015           example: __MODEL-VERSION-ID__
22016         - name: metaname
22017           in: path
22018           required: true
22019           type: string
22020           example: __METANAME__
22021         - name: resource-version
22022           in: query
22023           description: resource-version for concurrency
22024           required: true
22025           type: string
22026   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
22027     get:
22028       tags:
22029         - ServiceDesignAndCreation
22030       summary: returns metadata
22031       description: returns metadata
22032       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
22033       produces:
22034         - application/json
22035         - application/xml
22036       responses:
22037         "200":
22038           description: successful operation
22039           schema:
22040               $ref: "#/getDefinitions/metadata"
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-version-id
22051           in: path
22052           description: Unique identifier corresponding to one version of a model in ASDC
22053           required: true
22054           type: string
22055           example: __MODEL-VERSION-ID__
22056         - name: model-type
22057           in: query
22058           description: Type of the model, e.g., service, resource, widget, etc.
22059           required: false
22060           type: string
22061         - name: model-name
22062           in: query
22063           description: Name of the model, which can change from version to version.
22064           required: false
22065           type: string
22066         - name: model-version
22067           in: query
22068           description: Version
22069           required: false
22070           type: string
22071         - name: distribution-status
22072           in: query
22073           description: Distribution Status
22074           required: false
22075           type: string
22076   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
22077     put:
22078       tags:
22079         - ServiceDesignAndCreation
22080       summary: see node definition for valid relationships
22081       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
22082       consumes:
22083         - application/json
22084         - application/xml
22085       produces:
22086         - application/json
22087         - application/xml
22088       responses:
22089         "default":
22090           description: Response codes found in [response codes](https://wiki.onap.org/).
22091       parameters:
22092         - name: model-invariant-id
22093           in: path
22094           description: Unique identifier corresponding to the main definition of a model in ASDC
22095           required: true
22096           type: string
22097           example: __MODEL-INVARIANT-ID__
22098         - name: model-version-id
22099           in: path
22100           description: Unique identifier corresponding to one version of a model in ASDC
22101           required: true
22102           type: string
22103           example: __MODEL-VERSION-ID__
22104         - name: body
22105           in: body
22106           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
22107           required: true
22108           schema:
22109             $ref: "#/definitions/relationship"
22110     delete:
22111       tags:
22112         - ServiceDesignAndCreation
22113       summary: delete an existing relationship
22114       description: delete an existing relationship
22115       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
22116       consumes:
22117         - application/json
22118         - application/xml
22119       produces:
22120         - application/json
22121         - application/xml
22122       responses:
22123         "default":
22124           description: Response codes found in [response codes](https://wiki.onap.org/).
22125       parameters:
22126         - name: model-invariant-id
22127           in: path
22128           description: Unique identifier corresponding to the main definition of a model in ASDC
22129           required: true
22130           type: string
22131           example: __MODEL-INVARIANT-ID__
22132         - name: model-version-id
22133           in: path
22134           description: Unique identifier corresponding to one version of a model in ASDC
22135           required: true
22136           type: string
22137           example: __MODEL-VERSION-ID__
22138   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
22139     get:
22140       tags:
22141         - ServiceDesignAndCreation
22142       summary: returns model-ver
22143       description: returns model-ver
22144       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
22145       produces:
22146         - application/json
22147         - application/xml
22148       responses:
22149         "200":
22150           description: successful operation
22151           schema:
22152               $ref: "#/getDefinitions/model-ver"
22153         "default":
22154           description: Response codes found in [response codes](https://wiki.onap.org/).
22155       parameters:
22156         - name: model-invariant-id
22157           in: path
22158           description: Unique identifier corresponding to the main definition of a model in ASDC
22159           required: true
22160           type: string
22161           example: __MODEL-INVARIANT-ID__
22162         - name: model-version-id
22163           in: path
22164           description: Unique identifier corresponding to one version of a model in ASDC
22165           required: true
22166           type: string
22167           example: __MODEL-VERSION-ID__
22168         - name: model-type
22169           in: query
22170           description: Type of the model, e.g., service, resource, widget, etc.
22171           required: false
22172           type: string
22173         - name: model-name
22174           in: query
22175           description: Name of the model, which can change from version to version.
22176           required: false
22177           type: string
22178         - name: model-version
22179           in: query
22180           description: Version
22181           required: false
22182           type: string
22183         - name: distribution-status
22184           in: query
22185           description: Distribution Status
22186           required: false
22187           type: string
22188     put:
22189       tags:
22190         - ServiceDesignAndCreation
22191       summary: create or update an existing model-ver
22192       description: |
22193         Create or update an existing model-ver.
22194         #
22195         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22196       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
22197       consumes:
22198         - application/json
22199         - application/xml
22200       produces:
22201         - application/json
22202         - application/xml
22203       responses:
22204         "default":
22205           description: Response codes found in [response codes](https://wiki.onap.org/).
22206       parameters:
22207         - name: model-invariant-id
22208           in: path
22209           description: Unique identifier corresponding to the main definition of a model in ASDC
22210           required: true
22211           type: string
22212           example: __MODEL-INVARIANT-ID__
22213         - name: model-version-id
22214           in: path
22215           description: Unique identifier corresponding to one version of a model in ASDC
22216           required: true
22217           type: string
22218           example: __MODEL-VERSION-ID__
22219         - name: body
22220           in: body
22221           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
22222           required: true
22223           schema:
22224             $ref: "#/definitions/model-ver"
22225     patch:
22226       tags:
22227         - ServiceDesignAndCreation
22228       summary: update an existing model-ver
22229       description: |
22230         Update an existing model-ver
22231         #
22232         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22233         The PUT operation will entirely replace an existing object.
22234         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22235         #
22236         Other differences between PUT and PATCH are:
22237         #
22238         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22239         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22240         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22241       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
22242       consumes:
22243         - application/json
22244         - application/xml
22245       produces:
22246         - application/json
22247         - application/xml
22248       responses:
22249         "default":
22250           description: Response codes found in [response codes](https://wiki.onap.org/).
22251       parameters:
22252         - name: model-invariant-id
22253           in: path
22254           description: Unique identifier corresponding to the main definition of a model in ASDC
22255           required: true
22256           type: string
22257           example: __MODEL-INVARIANT-ID__
22258         - name: model-version-id
22259           in: path
22260           description: Unique identifier corresponding to one version of a model in ASDC
22261           required: true
22262           type: string
22263           example: __MODEL-VERSION-ID__
22264         - name: body
22265           in: body
22266           description: model-ver object that needs to be created or updated.
22267           required: true
22268           schema:
22269             $ref: "#/patchDefinitions/model-ver"
22270     delete:
22271       tags:
22272         - ServiceDesignAndCreation
22273       summary: delete an existing model-ver
22274       description: delete an existing model-ver
22275       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
22276       consumes:
22277         - application/json
22278         - application/xml
22279       produces:
22280         - application/json
22281         - application/xml
22282       responses:
22283         "default":
22284           description: Response codes found in [response codes](https://wiki.onap.org/).
22285       parameters:
22286         - name: model-invariant-id
22287           in: path
22288           description: Unique identifier corresponding to the main definition of a model in ASDC
22289           required: true
22290           type: string
22291           example: __MODEL-INVARIANT-ID__
22292         - name: model-version-id
22293           in: path
22294           description: Unique identifier corresponding to one version of a model in ASDC
22295           required: true
22296           type: string
22297           example: __MODEL-VERSION-ID__
22298         - name: resource-version
22299           in: query
22300           description: resource-version for concurrency
22301           required: true
22302           type: string
22303   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
22304     get:
22305       tags:
22306         - ServiceDesignAndCreation
22307       summary: returns model-vers
22308       description: returns model-vers
22309       operationId: getServiceDesignAndCreationModelsModelModelVers
22310       produces:
22311         - application/json
22312         - application/xml
22313       responses:
22314         "200":
22315           description: successful operation
22316           schema:
22317               $ref: "#/getDefinitions/model-vers"
22318         "default":
22319           description: Response codes found in [response codes](https://wiki.onap.org/).
22320       parameters:
22321         - name: model-invariant-id
22322           in: path
22323           description: Unique identifier corresponding to the main definition of a model in ASDC
22324           required: true
22325           type: string
22326           example: __MODEL-INVARIANT-ID__
22327         - name: model-type
22328           in: query
22329           description: Type of the model, e.g., service, resource, widget, etc.
22330           required: false
22331           type: string
22332   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
22333     put:
22334       tags:
22335         - ServiceDesignAndCreation
22336       summary: see node definition for valid relationships
22337       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
22338       consumes:
22339         - application/json
22340         - application/xml
22341       produces:
22342         - application/json
22343         - application/xml
22344       responses:
22345         "default":
22346           description: Response codes found in [response codes](https://wiki.onap.org/).
22347       parameters:
22348         - name: model-invariant-id
22349           in: path
22350           description: Unique identifier corresponding to the main definition of a model in ASDC
22351           required: true
22352           type: string
22353           example: __MODEL-INVARIANT-ID__
22354         - name: body
22355           in: body
22356           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
22357           required: true
22358           schema:
22359             $ref: "#/definitions/relationship"
22360     delete:
22361       tags:
22362         - ServiceDesignAndCreation
22363       summary: delete an existing relationship
22364       description: delete an existing relationship
22365       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
22366       consumes:
22367         - application/json
22368         - application/xml
22369       produces:
22370         - application/json
22371         - application/xml
22372       responses:
22373         "default":
22374           description: Response codes found in [response codes](https://wiki.onap.org/).
22375       parameters:
22376         - name: model-invariant-id
22377           in: path
22378           description: Unique identifier corresponding to the main definition of a model in ASDC
22379           required: true
22380           type: string
22381           example: __MODEL-INVARIANT-ID__
22382   /service-design-and-creation/models/model/{model-invariant-id}:
22383     get:
22384       tags:
22385         - ServiceDesignAndCreation
22386       summary: returns model
22387       description: returns model
22388       operationId: getServiceDesignAndCreationModelsModel
22389       produces:
22390         - application/json
22391         - application/xml
22392       responses:
22393         "200":
22394           description: successful operation
22395           schema:
22396               $ref: "#/getDefinitions/model"
22397         "default":
22398           description: Response codes found in [response codes](https://wiki.onap.org/).
22399       parameters:
22400         - name: model-invariant-id
22401           in: path
22402           description: Unique identifier corresponding to the main definition of a model in ASDC
22403           required: true
22404           type: string
22405           example: __MODEL-INVARIANT-ID__
22406         - name: model-type
22407           in: query
22408           description: Type of the model, e.g., service, resource, widget, etc.
22409           required: false
22410           type: string
22411     put:
22412       tags:
22413         - ServiceDesignAndCreation
22414       summary: create or update an existing model
22415       description: |
22416         Create or update an existing model.
22417         #
22418         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22419       operationId: createOrUpdateServiceDesignAndCreationModelsModel
22420       consumes:
22421         - application/json
22422         - application/xml
22423       produces:
22424         - application/json
22425         - application/xml
22426       responses:
22427         "default":
22428           description: Response codes found in [response codes](https://wiki.onap.org/).
22429       parameters:
22430         - name: model-invariant-id
22431           in: path
22432           description: Unique identifier corresponding to the main definition of a model in ASDC
22433           required: true
22434           type: string
22435           example: __MODEL-INVARIANT-ID__
22436         - name: body
22437           in: body
22438           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
22439           required: true
22440           schema:
22441             $ref: "#/definitions/model"
22442     patch:
22443       tags:
22444         - ServiceDesignAndCreation
22445       summary: update an existing model
22446       description: |
22447         Update an existing model
22448         #
22449         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22450         The PUT operation will entirely replace an existing object.
22451         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22452         #
22453         Other differences between PUT and PATCH are:
22454         #
22455         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22456         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22457         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22458       operationId: UpdateServiceDesignAndCreationModelsModel
22459       consumes:
22460         - application/json
22461         - application/xml
22462       produces:
22463         - application/json
22464         - application/xml
22465       responses:
22466         "default":
22467           description: Response codes found in [response codes](https://wiki.onap.org/).
22468       parameters:
22469         - name: model-invariant-id
22470           in: path
22471           description: Unique identifier corresponding to the main definition of a model in ASDC
22472           required: true
22473           type: string
22474           example: __MODEL-INVARIANT-ID__
22475         - name: body
22476           in: body
22477           description: model object that needs to be created or updated.
22478           required: true
22479           schema:
22480             $ref: "#/patchDefinitions/model"
22481     delete:
22482       tags:
22483         - ServiceDesignAndCreation
22484       summary: delete an existing model
22485       description: delete an existing model
22486       operationId: deleteServiceDesignAndCreationModelsModel
22487       consumes:
22488         - application/json
22489         - application/xml
22490       produces:
22491         - application/json
22492         - application/xml
22493       responses:
22494         "default":
22495           description: Response codes found in [response codes](https://wiki.onap.org/).
22496       parameters:
22497         - name: model-invariant-id
22498           in: path
22499           description: Unique identifier corresponding to the main definition of a model in ASDC
22500           required: true
22501           type: string
22502           example: __MODEL-INVARIANT-ID__
22503         - name: resource-version
22504           in: query
22505           description: resource-version for concurrency
22506           required: true
22507           type: string
22508   /service-design-and-creation/models:
22509     get:
22510       tags:
22511         - ServiceDesignAndCreation
22512       summary: returns models
22513       description: returns models
22514       operationId: getServiceDesignAndCreationModels
22515       produces:
22516         - application/json
22517         - application/xml
22518       responses:
22519         "200":
22520           description: successful operation
22521           schema:
22522               $ref: "#/getDefinitions/models"
22523         "default":
22524           description: Response codes found in [response codes](https://wiki.onap.org/).
22525   /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:
22526     put:
22527       tags:
22528         - ServiceDesignAndCreation
22529       summary: see node definition for valid relationships
22530       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
22531       consumes:
22532         - application/json
22533         - application/xml
22534       produces:
22535         - application/json
22536         - application/xml
22537       responses:
22538         "default":
22539           description: Response codes found in [response codes](https://wiki.onap.org/).
22540       parameters:
22541         - name: named-query-uuid
22542           in: path
22543           required: true
22544           type: string
22545           example: __NAMED-QUERY-UUID__
22546         - name: named-query-element-uuid
22547           in: path
22548           required: true
22549           type: string
22550           example: __NAMED-QUERY-ELEMENT-UUID__
22551         - name: related-lookup-uuid
22552           in: path
22553           required: true
22554           type: string
22555           example: __RELATED-LOOKUP-UUID__
22556         - name: body
22557           in: body
22558           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
22559           required: true
22560           schema:
22561             $ref: "#/definitions/relationship"
22562     delete:
22563       tags:
22564         - ServiceDesignAndCreation
22565       summary: delete an existing relationship
22566       description: delete an existing relationship
22567       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
22568       consumes:
22569         - application/json
22570         - application/xml
22571       produces:
22572         - application/json
22573         - application/xml
22574       responses:
22575         "default":
22576           description: Response codes found in [response codes](https://wiki.onap.org/).
22577       parameters:
22578         - name: named-query-uuid
22579           in: path
22580           required: true
22581           type: string
22582           example: __NAMED-QUERY-UUID__
22583         - name: named-query-element-uuid
22584           in: path
22585           required: true
22586           type: string
22587           example: __NAMED-QUERY-ELEMENT-UUID__
22588         - name: related-lookup-uuid
22589           in: path
22590           required: true
22591           type: string
22592           example: __RELATED-LOOKUP-UUID__
22593   /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}:
22594     get:
22595       tags:
22596         - ServiceDesignAndCreation
22597       summary: returns related-lookup
22598       description: returns related-lookup
22599       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22600       produces:
22601         - application/json
22602         - application/xml
22603       responses:
22604         "200":
22605           description: successful operation
22606           schema:
22607               $ref: "#/getDefinitions/related-lookup"
22608         "default":
22609           description: Response codes found in [response codes](https://wiki.onap.org/).
22610       parameters:
22611         - name: named-query-uuid
22612           in: path
22613           required: true
22614           type: string
22615           example: __NAMED-QUERY-UUID__
22616         - name: named-query-element-uuid
22617           in: path
22618           required: true
22619           type: string
22620           example: __NAMED-QUERY-ELEMENT-UUID__
22621         - name: related-lookup-uuid
22622           in: path
22623           required: true
22624           type: string
22625           example: __RELATED-LOOKUP-UUID__
22626         - name: named-query-name
22627           in: query
22628           required: false
22629           type: string
22630     put:
22631       tags:
22632         - ServiceDesignAndCreation
22633       summary: create or update an existing related-lookup
22634       description: |
22635         Create or update an existing related-lookup.
22636         #
22637         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22638       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22639       consumes:
22640         - application/json
22641         - application/xml
22642       produces:
22643         - application/json
22644         - application/xml
22645       responses:
22646         "default":
22647           description: Response codes found in [response codes](https://wiki.onap.org/).
22648       parameters:
22649         - name: named-query-uuid
22650           in: path
22651           required: true
22652           type: string
22653           example: __NAMED-QUERY-UUID__
22654         - name: named-query-element-uuid
22655           in: path
22656           required: true
22657           type: string
22658           example: __NAMED-QUERY-ELEMENT-UUID__
22659         - name: related-lookup-uuid
22660           in: path
22661           required: true
22662           type: string
22663           example: __RELATED-LOOKUP-UUID__
22664         - name: body
22665           in: body
22666           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
22667           required: true
22668           schema:
22669             $ref: "#/definitions/related-lookup"
22670     patch:
22671       tags:
22672         - ServiceDesignAndCreation
22673       summary: update an existing related-lookup
22674       description: |
22675         Update an existing related-lookup
22676         #
22677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22678         The PUT operation will entirely replace an existing object.
22679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22680         #
22681         Other differences between PUT and PATCH are:
22682         #
22683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22686       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22687       consumes:
22688         - application/json
22689         - application/xml
22690       produces:
22691         - application/json
22692         - application/xml
22693       responses:
22694         "default":
22695           description: Response codes found in [response codes](https://wiki.onap.org/).
22696       parameters:
22697         - name: named-query-uuid
22698           in: path
22699           required: true
22700           type: string
22701           example: __NAMED-QUERY-UUID__
22702         - name: named-query-element-uuid
22703           in: path
22704           required: true
22705           type: string
22706           example: __NAMED-QUERY-ELEMENT-UUID__
22707         - name: related-lookup-uuid
22708           in: path
22709           required: true
22710           type: string
22711           example: __RELATED-LOOKUP-UUID__
22712         - name: body
22713           in: body
22714           description: related-lookup object that needs to be created or updated.
22715           required: true
22716           schema:
22717             $ref: "#/patchDefinitions/related-lookup"
22718     delete:
22719       tags:
22720         - ServiceDesignAndCreation
22721       summary: delete an existing related-lookup
22722       description: delete an existing related-lookup
22723       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22724       consumes:
22725         - application/json
22726         - application/xml
22727       produces:
22728         - application/json
22729         - application/xml
22730       responses:
22731         "default":
22732           description: Response codes found in [response codes](https://wiki.onap.org/).
22733       parameters:
22734         - name: named-query-uuid
22735           in: path
22736           required: true
22737           type: string
22738           example: __NAMED-QUERY-UUID__
22739         - name: named-query-element-uuid
22740           in: path
22741           required: true
22742           type: string
22743           example: __NAMED-QUERY-ELEMENT-UUID__
22744         - name: related-lookup-uuid
22745           in: path
22746           required: true
22747           type: string
22748           example: __RELATED-LOOKUP-UUID__
22749         - name: resource-version
22750           in: query
22751           description: resource-version for concurrency
22752           required: true
22753           type: string
22754   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
22755     get:
22756       tags:
22757         - ServiceDesignAndCreation
22758       summary: returns related-lookups
22759       description: returns related-lookups
22760       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
22761       produces:
22762         - application/json
22763         - application/xml
22764       responses:
22765         "200":
22766           description: successful operation
22767           schema:
22768               $ref: "#/getDefinitions/related-lookups"
22769         "default":
22770           description: Response codes found in [response codes](https://wiki.onap.org/).
22771       parameters:
22772         - name: named-query-uuid
22773           in: path
22774           required: true
22775           type: string
22776           example: __NAMED-QUERY-UUID__
22777         - name: named-query-element-uuid
22778           in: path
22779           required: true
22780           type: string
22781           example: __NAMED-QUERY-ELEMENT-UUID__
22782         - name: named-query-name
22783           in: query
22784           required: false
22785           type: string
22786   /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}:
22787     get:
22788       tags:
22789         - ServiceDesignAndCreation
22790       summary: returns property-constraint
22791       description: returns property-constraint
22792       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22793       produces:
22794         - application/json
22795         - application/xml
22796       responses:
22797         "200":
22798           description: successful operation
22799           schema:
22800               $ref: "#/getDefinitions/property-constraint"
22801         "default":
22802           description: Response codes found in [response codes](https://wiki.onap.org/).
22803       parameters:
22804         - name: named-query-uuid
22805           in: path
22806           required: true
22807           type: string
22808           example: __NAMED-QUERY-UUID__
22809         - name: named-query-element-uuid
22810           in: path
22811           required: true
22812           type: string
22813           example: __NAMED-QUERY-ELEMENT-UUID__
22814         - name: property-constraint-uuid
22815           in: path
22816           required: true
22817           type: string
22818           example: __PROPERTY-CONSTRAINT-UUID__
22819         - name: named-query-name
22820           in: query
22821           required: false
22822           type: string
22823     put:
22824       tags:
22825         - ServiceDesignAndCreation
22826       summary: create or update an existing property-constraint
22827       description: |
22828         Create or update an existing property-constraint.
22829         #
22830         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22831       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22832       consumes:
22833         - application/json
22834         - application/xml
22835       produces:
22836         - application/json
22837         - application/xml
22838       responses:
22839         "default":
22840           description: Response codes found in [response codes](https://wiki.onap.org/).
22841       parameters:
22842         - name: named-query-uuid
22843           in: path
22844           required: true
22845           type: string
22846           example: __NAMED-QUERY-UUID__
22847         - name: named-query-element-uuid
22848           in: path
22849           required: true
22850           type: string
22851           example: __NAMED-QUERY-ELEMENT-UUID__
22852         - name: property-constraint-uuid
22853           in: path
22854           required: true
22855           type: string
22856           example: __PROPERTY-CONSTRAINT-UUID__
22857         - name: body
22858           in: body
22859           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
22860           required: true
22861           schema:
22862             $ref: "#/definitions/property-constraint"
22863     patch:
22864       tags:
22865         - ServiceDesignAndCreation
22866       summary: update an existing property-constraint
22867       description: |
22868         Update an existing property-constraint
22869         #
22870         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22871         The PUT operation will entirely replace an existing object.
22872         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22873         #
22874         Other differences between PUT and PATCH are:
22875         #
22876         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22877         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22878         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22879       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22880       consumes:
22881         - application/json
22882         - application/xml
22883       produces:
22884         - application/json
22885         - application/xml
22886       responses:
22887         "default":
22888           description: Response codes found in [response codes](https://wiki.onap.org/).
22889       parameters:
22890         - name: named-query-uuid
22891           in: path
22892           required: true
22893           type: string
22894           example: __NAMED-QUERY-UUID__
22895         - name: named-query-element-uuid
22896           in: path
22897           required: true
22898           type: string
22899           example: __NAMED-QUERY-ELEMENT-UUID__
22900         - name: property-constraint-uuid
22901           in: path
22902           required: true
22903           type: string
22904           example: __PROPERTY-CONSTRAINT-UUID__
22905         - name: body
22906           in: body
22907           description: property-constraint object that needs to be created or updated.
22908           required: true
22909           schema:
22910             $ref: "#/patchDefinitions/property-constraint"
22911     delete:
22912       tags:
22913         - ServiceDesignAndCreation
22914       summary: delete an existing property-constraint
22915       description: delete an existing property-constraint
22916       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22917       consumes:
22918         - application/json
22919         - application/xml
22920       produces:
22921         - application/json
22922         - application/xml
22923       responses:
22924         "default":
22925           description: Response codes found in [response codes](https://wiki.onap.org/).
22926       parameters:
22927         - name: named-query-uuid
22928           in: path
22929           required: true
22930           type: string
22931           example: __NAMED-QUERY-UUID__
22932         - name: named-query-element-uuid
22933           in: path
22934           required: true
22935           type: string
22936           example: __NAMED-QUERY-ELEMENT-UUID__
22937         - name: property-constraint-uuid
22938           in: path
22939           required: true
22940           type: string
22941           example: __PROPERTY-CONSTRAINT-UUID__
22942         - name: resource-version
22943           in: query
22944           description: resource-version for concurrency
22945           required: true
22946           type: string
22947   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
22948     get:
22949       tags:
22950         - ServiceDesignAndCreation
22951       summary: returns property-constraints
22952       description: returns property-constraints
22953       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
22954       produces:
22955         - application/json
22956         - application/xml
22957       responses:
22958         "200":
22959           description: successful operation
22960           schema:
22961               $ref: "#/getDefinitions/property-constraints"
22962         "default":
22963           description: Response codes found in [response codes](https://wiki.onap.org/).
22964       parameters:
22965         - name: named-query-uuid
22966           in: path
22967           required: true
22968           type: string
22969           example: __NAMED-QUERY-UUID__
22970         - name: named-query-element-uuid
22971           in: path
22972           required: true
22973           type: string
22974           example: __NAMED-QUERY-ELEMENT-UUID__
22975         - name: named-query-name
22976           in: query
22977           required: false
22978           type: string
22979   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
22980     put:
22981       tags:
22982         - ServiceDesignAndCreation
22983       summary: see node definition for valid relationships
22984       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
22985       consumes:
22986         - application/json
22987         - application/xml
22988       produces:
22989         - application/json
22990         - application/xml
22991       responses:
22992         "default":
22993           description: Response codes found in [response codes](https://wiki.onap.org/).
22994       parameters:
22995         - name: named-query-uuid
22996           in: path
22997           required: true
22998           type: string
22999           example: __NAMED-QUERY-UUID__
23000         - name: named-query-element-uuid
23001           in: path
23002           required: true
23003           type: string
23004           example: __NAMED-QUERY-ELEMENT-UUID__
23005         - name: body
23006           in: body
23007           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
23008           required: true
23009           schema:
23010             $ref: "#/definitions/relationship"
23011     delete:
23012       tags:
23013         - ServiceDesignAndCreation
23014       summary: delete an existing relationship
23015       description: delete an existing relationship
23016       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
23017       consumes:
23018         - application/json
23019         - application/xml
23020       produces:
23021         - application/json
23022         - application/xml
23023       responses:
23024         "default":
23025           description: Response codes found in [response codes](https://wiki.onap.org/).
23026       parameters:
23027         - name: named-query-uuid
23028           in: path
23029           required: true
23030           type: string
23031           example: __NAMED-QUERY-UUID__
23032         - name: named-query-element-uuid
23033           in: path
23034           required: true
23035           type: string
23036           example: __NAMED-QUERY-ELEMENT-UUID__
23037   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
23038     get:
23039       tags:
23040         - ServiceDesignAndCreation
23041       summary: returns named-query-element
23042       description: returns named-query-element
23043       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
23044       produces:
23045         - application/json
23046         - application/xml
23047       responses:
23048         "200":
23049           description: successful operation
23050           schema:
23051               $ref: "#/getDefinitions/named-query-element"
23052         "default":
23053           description: Response codes found in [response codes](https://wiki.onap.org/).
23054       parameters:
23055         - name: named-query-uuid
23056           in: path
23057           required: true
23058           type: string
23059           example: __NAMED-QUERY-UUID__
23060         - name: named-query-element-uuid
23061           in: path
23062           required: true
23063           type: string
23064           example: __NAMED-QUERY-ELEMENT-UUID__
23065         - name: named-query-name
23066           in: query
23067           required: false
23068           type: string
23069     put:
23070       tags:
23071         - ServiceDesignAndCreation
23072       summary: create or update an existing named-query-element
23073       description: |
23074         Create or update an existing named-query-element.
23075         #
23076         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23077       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
23078       consumes:
23079         - application/json
23080         - application/xml
23081       produces:
23082         - application/json
23083         - application/xml
23084       responses:
23085         "default":
23086           description: Response codes found in [response codes](https://wiki.onap.org/).
23087       parameters:
23088         - name: named-query-uuid
23089           in: path
23090           required: true
23091           type: string
23092           example: __NAMED-QUERY-UUID__
23093         - name: named-query-element-uuid
23094           in: path
23095           required: true
23096           type: string
23097           example: __NAMED-QUERY-ELEMENT-UUID__
23098         - name: body
23099           in: body
23100           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
23101           required: true
23102           schema:
23103             $ref: "#/definitions/named-query-element"
23104     patch:
23105       tags:
23106         - ServiceDesignAndCreation
23107       summary: update an existing named-query-element
23108       description: |
23109         Update an existing named-query-element
23110         #
23111         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23112         The PUT operation will entirely replace an existing object.
23113         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23114         #
23115         Other differences between PUT and PATCH are:
23116         #
23117         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23118         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23119         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23120       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
23121       consumes:
23122         - application/json
23123         - application/xml
23124       produces:
23125         - application/json
23126         - application/xml
23127       responses:
23128         "default":
23129           description: Response codes found in [response codes](https://wiki.onap.org/).
23130       parameters:
23131         - name: named-query-uuid
23132           in: path
23133           required: true
23134           type: string
23135           example: __NAMED-QUERY-UUID__
23136         - name: named-query-element-uuid
23137           in: path
23138           required: true
23139           type: string
23140           example: __NAMED-QUERY-ELEMENT-UUID__
23141         - name: body
23142           in: body
23143           description: named-query-element object that needs to be created or updated.
23144           required: true
23145           schema:
23146             $ref: "#/patchDefinitions/named-query-element"
23147     delete:
23148       tags:
23149         - ServiceDesignAndCreation
23150       summary: delete an existing named-query-element
23151       description: delete an existing named-query-element
23152       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
23153       consumes:
23154         - application/json
23155         - application/xml
23156       produces:
23157         - application/json
23158         - application/xml
23159       responses:
23160         "default":
23161           description: Response codes found in [response codes](https://wiki.onap.org/).
23162       parameters:
23163         - name: named-query-uuid
23164           in: path
23165           required: true
23166           type: string
23167           example: __NAMED-QUERY-UUID__
23168         - name: named-query-element-uuid
23169           in: path
23170           required: true
23171           type: string
23172           example: __NAMED-QUERY-ELEMENT-UUID__
23173         - name: resource-version
23174           in: query
23175           description: resource-version for concurrency
23176           required: true
23177           type: string
23178   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
23179     get:
23180       tags:
23181         - ServiceDesignAndCreation
23182       summary: returns named-query-elements
23183       description: returns named-query-elements
23184       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
23185       produces:
23186         - application/json
23187         - application/xml
23188       responses:
23189         "200":
23190           description: successful operation
23191           schema:
23192               $ref: "#/getDefinitions/named-query-elements"
23193         "default":
23194           description: Response codes found in [response codes](https://wiki.onap.org/).
23195       parameters:
23196         - name: named-query-uuid
23197           in: path
23198           required: true
23199           type: string
23200           example: __NAMED-QUERY-UUID__
23201         - name: named-query-name
23202           in: query
23203           required: false
23204           type: string
23205   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
23206     put:
23207       tags:
23208         - ServiceDesignAndCreation
23209       summary: see node definition for valid relationships
23210       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
23211       consumes:
23212         - application/json
23213         - application/xml
23214       produces:
23215         - application/json
23216         - application/xml
23217       responses:
23218         "default":
23219           description: Response codes found in [response codes](https://wiki.onap.org/).
23220       parameters:
23221         - name: named-query-uuid
23222           in: path
23223           required: true
23224           type: string
23225           example: __NAMED-QUERY-UUID__
23226         - name: body
23227           in: body
23228           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
23229           required: true
23230           schema:
23231             $ref: "#/definitions/relationship"
23232     delete:
23233       tags:
23234         - ServiceDesignAndCreation
23235       summary: delete an existing relationship
23236       description: delete an existing relationship
23237       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
23238       consumes:
23239         - application/json
23240         - application/xml
23241       produces:
23242         - application/json
23243         - application/xml
23244       responses:
23245         "default":
23246           description: Response codes found in [response codes](https://wiki.onap.org/).
23247       parameters:
23248         - name: named-query-uuid
23249           in: path
23250           required: true
23251           type: string
23252           example: __NAMED-QUERY-UUID__
23253   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
23254     get:
23255       tags:
23256         - ServiceDesignAndCreation
23257       summary: returns named-query
23258       description: returns named-query
23259       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
23260       produces:
23261         - application/json
23262         - application/xml
23263       responses:
23264         "200":
23265           description: successful operation
23266           schema:
23267               $ref: "#/getDefinitions/named-query"
23268         "default":
23269           description: Response codes found in [response codes](https://wiki.onap.org/).
23270       parameters:
23271         - name: named-query-uuid
23272           in: path
23273           required: true
23274           type: string
23275           example: __NAMED-QUERY-UUID__
23276         - name: named-query-name
23277           in: query
23278           required: false
23279           type: string
23280     put:
23281       tags:
23282         - ServiceDesignAndCreation
23283       summary: create or update an existing named-query
23284       description: |
23285         Create or update an existing named-query.
23286         #
23287         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23288       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
23289       consumes:
23290         - application/json
23291         - application/xml
23292       produces:
23293         - application/json
23294         - application/xml
23295       responses:
23296         "default":
23297           description: Response codes found in [response codes](https://wiki.onap.org/).
23298       parameters:
23299         - name: named-query-uuid
23300           in: path
23301           required: true
23302           type: string
23303           example: __NAMED-QUERY-UUID__
23304         - name: body
23305           in: body
23306           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
23307           required: true
23308           schema:
23309             $ref: "#/definitions/named-query"
23310     patch:
23311       tags:
23312         - ServiceDesignAndCreation
23313       summary: update an existing named-query
23314       description: |
23315         Update an existing named-query
23316         #
23317         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23318         The PUT operation will entirely replace an existing object.
23319         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23320         #
23321         Other differences between PUT and PATCH are:
23322         #
23323         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23324         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23325         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23326       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
23327       consumes:
23328         - application/json
23329         - application/xml
23330       produces:
23331         - application/json
23332         - application/xml
23333       responses:
23334         "default":
23335           description: Response codes found in [response codes](https://wiki.onap.org/).
23336       parameters:
23337         - name: named-query-uuid
23338           in: path
23339           required: true
23340           type: string
23341           example: __NAMED-QUERY-UUID__
23342         - name: body
23343           in: body
23344           description: named-query object that needs to be created or updated.
23345           required: true
23346           schema:
23347             $ref: "#/patchDefinitions/named-query"
23348     delete:
23349       tags:
23350         - ServiceDesignAndCreation
23351       summary: delete an existing named-query
23352       description: delete an existing named-query
23353       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
23354       consumes:
23355         - application/json
23356         - application/xml
23357       produces:
23358         - application/json
23359         - application/xml
23360       responses:
23361         "default":
23362           description: Response codes found in [response codes](https://wiki.onap.org/).
23363       parameters:
23364         - name: named-query-uuid
23365           in: path
23366           required: true
23367           type: string
23368           example: __NAMED-QUERY-UUID__
23369         - name: resource-version
23370           in: query
23371           description: resource-version for concurrency
23372           required: true
23373           type: string
23374   /service-design-and-creation/named-queries:
23375     get:
23376       tags:
23377         - ServiceDesignAndCreation
23378       summary: returns named-queries
23379       description: returns named-queries
23380       operationId: getServiceDesignAndCreationNamedQueries
23381       produces:
23382         - application/json
23383         - application/xml
23384       responses:
23385         "200":
23386           description: successful operation
23387           schema:
23388               $ref: "#/getDefinitions/named-queries"
23389         "default":
23390           description: Response codes found in [response codes](https://wiki.onap.org/).
23391   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
23392     put:
23393       tags:
23394         - Network
23395       summary: see node definition for valid relationships
23396       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
23397       consumes:
23398         - application/json
23399         - application/xml
23400       produces:
23401         - application/json
23402         - application/xml
23403       responses:
23404         "default":
23405           description: Response codes found in [response codes](https://wiki.onap.org/).
23406       parameters:
23407         - name: link-name
23408           in: path
23409           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23410           required: true
23411           type: string
23412           example: __LINK-NAME__
23413         - name: body
23414           in: body
23415           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
23416           required: true
23417           schema:
23418             $ref: "#/definitions/relationship"
23419     delete:
23420       tags:
23421         - Network
23422       summary: delete an existing relationship
23423       description: delete an existing relationship
23424       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
23425       consumes:
23426         - application/json
23427         - application/xml
23428       produces:
23429         - application/json
23430         - application/xml
23431       responses:
23432         "default":
23433           description: Response codes found in [response codes](https://wiki.onap.org/).
23434       parameters:
23435         - name: link-name
23436           in: path
23437           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23438           required: true
23439           type: string
23440           example: __LINK-NAME__
23441   /network/logical-links/logical-link/{link-name}:
23442     get:
23443       tags:
23444         - Network
23445       summary: returns logical-link
23446       description: returns logical-link
23447       operationId: getNetworkLogicalLinksLogicalLink
23448       produces:
23449         - application/json
23450         - application/xml
23451       responses:
23452         "200":
23453           description: successful operation
23454           schema:
23455               $ref: "#/getDefinitions/logical-link"
23456         "default":
23457           description: Response codes found in [response codes](https://wiki.onap.org/).
23458       parameters:
23459         - name: link-name
23460           in: path
23461           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23462           required: true
23463           type: string
23464           example: __LINK-NAME__
23465         - name: model-invariant-id
23466           in: query
23467           description: the ASDC model id for this resource or service model.
23468           required: false
23469           type: string
23470         - name: model-version-id
23471           in: query
23472           description: the ASDC model version for this resource or service model.
23473           required: false
23474           type: string
23475         - name: widget-model-id
23476           in: query
23477           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
23478           required: false
23479           type: string
23480         - name: widget-model-version
23481           in: query
23482           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
23483           required: false
23484           type: string
23485         - name: prov-status
23486           in: query
23487           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23488           required: false
23489           type: string
23490         - name: link-id
23491           in: query
23492           description: UUID of the logical-link, SDNC generates this.
23493           required: false
23494           type: string
23495         - name: circuit-id
23496           in: query
23497           description: Circuit id
23498           required: false
23499           type: string
23500         - name: purpose
23501           in: query
23502           description: Reason for this entity, role it is playing
23503           required: false
23504           type: string
23505     put:
23506       tags:
23507         - Network
23508       summary: create or update an existing logical-link
23509       description: |
23510         Create or update an existing logical-link.
23511         #
23512         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23513       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
23514       consumes:
23515         - application/json
23516         - application/xml
23517       produces:
23518         - application/json
23519         - application/xml
23520       responses:
23521         "default":
23522           description: Response codes found in [response codes](https://wiki.onap.org/).
23523       parameters:
23524         - name: link-name
23525           in: path
23526           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23527           required: true
23528           type: string
23529           example: __LINK-NAME__
23530         - name: body
23531           in: body
23532           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
23533           required: true
23534           schema:
23535             $ref: "#/definitions/logical-link"
23536     patch:
23537       tags:
23538         - Network
23539       summary: update an existing logical-link
23540       description: |
23541         Update an existing logical-link
23542         #
23543         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23544         The PUT operation will entirely replace an existing object.
23545         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23546         #
23547         Other differences between PUT and PATCH are:
23548         #
23549         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23550         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23551         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23552       operationId: UpdateNetworkLogicalLinksLogicalLink
23553       consumes:
23554         - application/json
23555         - application/xml
23556       produces:
23557         - application/json
23558         - application/xml
23559       responses:
23560         "default":
23561           description: Response codes found in [response codes](https://wiki.onap.org/).
23562       parameters:
23563         - name: link-name
23564           in: path
23565           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23566           required: true
23567           type: string
23568           example: __LINK-NAME__
23569         - name: body
23570           in: body
23571           description: logical-link object that needs to be created or updated.
23572           required: true
23573           schema:
23574             $ref: "#/patchDefinitions/logical-link"
23575     delete:
23576       tags:
23577         - Network
23578       summary: delete an existing logical-link
23579       description: delete an existing logical-link
23580       operationId: deleteNetworkLogicalLinksLogicalLink
23581       consumes:
23582         - application/json
23583         - application/xml
23584       produces:
23585         - application/json
23586         - application/xml
23587       responses:
23588         "default":
23589           description: Response codes found in [response codes](https://wiki.onap.org/).
23590       parameters:
23591         - name: link-name
23592           in: path
23593           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23594           required: true
23595           type: string
23596           example: __LINK-NAME__
23597         - name: resource-version
23598           in: query
23599           description: resource-version for concurrency
23600           required: true
23601           type: string
23602   /network/logical-links:
23603     get:
23604       tags:
23605         - Network
23606       summary: returns logical-links
23607       description: returns logical-links
23608       operationId: getNetworkLogicalLinks
23609       produces:
23610         - application/json
23611         - application/xml
23612       responses:
23613         "200":
23614           description: successful operation
23615           schema:
23616               $ref: "#/getDefinitions/logical-links"
23617         "default":
23618           description: Response codes found in [response codes](https://wiki.onap.org/).
23619   /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:
23620     put:
23621       tags:
23622         - Network
23623       summary: see node definition for valid relationships
23624       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
23625       consumes:
23626         - application/json
23627         - application/xml
23628       produces:
23629         - application/json
23630         - application/xml
23631       responses:
23632         "default":
23633           description: Response codes found in [response codes](https://wiki.onap.org/).
23634       parameters:
23635         - name: site-pair-set-id
23636           in: path
23637           description: Unique id of site pair set.
23638           required: true
23639           type: string
23640           example: __SITE-PAIR-SET-ID__
23641         - name: routing-instance-id
23642           in: path
23643           description: Unique id of routing instance
23644           required: true
23645           type: string
23646           example: __ROUTING-INSTANCE-ID__
23647         - name: site-pair-id
23648           in: path
23649           description: unique identifier of probe
23650           required: true
23651           type: string
23652           example: __SITE-PAIR-ID__
23653         - name: cos
23654           in: path
23655           description: unique identifier of probe
23656           required: true
23657           type: string
23658           example: __COS__
23659         - name: body
23660           in: body
23661           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
23662           required: true
23663           schema:
23664             $ref: "#/definitions/relationship"
23665     delete:
23666       tags:
23667         - Network
23668       summary: delete an existing relationship
23669       description: delete an existing relationship
23670       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
23671       consumes:
23672         - application/json
23673         - application/xml
23674       produces:
23675         - application/json
23676         - application/xml
23677       responses:
23678         "default":
23679           description: Response codes found in [response codes](https://wiki.onap.org/).
23680       parameters:
23681         - name: site-pair-set-id
23682           in: path
23683           description: Unique id of site pair set.
23684           required: true
23685           type: string
23686           example: __SITE-PAIR-SET-ID__
23687         - name: routing-instance-id
23688           in: path
23689           description: Unique id of routing instance
23690           required: true
23691           type: string
23692           example: __ROUTING-INSTANCE-ID__
23693         - name: site-pair-id
23694           in: path
23695           description: unique identifier of probe
23696           required: true
23697           type: string
23698           example: __SITE-PAIR-ID__
23699         - name: cos
23700           in: path
23701           description: unique identifier of probe
23702           required: true
23703           type: string
23704           example: __COS__
23705   /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}:
23706     get:
23707       tags:
23708         - Network
23709       summary: returns class-of-service
23710       description: returns class-of-service
23711       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23712       produces:
23713         - application/json
23714         - application/xml
23715       responses:
23716         "200":
23717           description: successful operation
23718           schema:
23719               $ref: "#/getDefinitions/class-of-service"
23720         "default":
23721           description: Response codes found in [response codes](https://wiki.onap.org/).
23722       parameters:
23723         - name: site-pair-set-id
23724           in: path
23725           description: Unique id of site pair set.
23726           required: true
23727           type: string
23728           example: __SITE-PAIR-SET-ID__
23729         - name: routing-instance-id
23730           in: path
23731           description: Unique id of routing instance
23732           required: true
23733           type: string
23734           example: __ROUTING-INSTANCE-ID__
23735         - name: site-pair-id
23736           in: path
23737           description: unique identifier of probe
23738           required: true
23739           type: string
23740           example: __SITE-PAIR-ID__
23741         - name: cos
23742           in: path
23743           description: unique identifier of probe
23744           required: true
23745           type: string
23746           example: __COS__
23747     put:
23748       tags:
23749         - Network
23750       summary: create or update an existing class-of-service
23751       description: |
23752         Create or update an existing class-of-service.
23753         #
23754         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23755       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23756       consumes:
23757         - application/json
23758         - application/xml
23759       produces:
23760         - application/json
23761         - application/xml
23762       responses:
23763         "default":
23764           description: Response codes found in [response codes](https://wiki.onap.org/).
23765       parameters:
23766         - name: site-pair-set-id
23767           in: path
23768           description: Unique id of site pair set.
23769           required: true
23770           type: string
23771           example: __SITE-PAIR-SET-ID__
23772         - name: routing-instance-id
23773           in: path
23774           description: Unique id of routing instance
23775           required: true
23776           type: string
23777           example: __ROUTING-INSTANCE-ID__
23778         - name: site-pair-id
23779           in: path
23780           description: unique identifier of probe
23781           required: true
23782           type: string
23783           example: __SITE-PAIR-ID__
23784         - name: cos
23785           in: path
23786           description: unique identifier of probe
23787           required: true
23788           type: string
23789           example: __COS__
23790         - name: body
23791           in: body
23792           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
23793           required: true
23794           schema:
23795             $ref: "#/definitions/class-of-service"
23796     patch:
23797       tags:
23798         - Network
23799       summary: update an existing class-of-service
23800       description: |
23801         Update an existing class-of-service
23802         #
23803         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23804         The PUT operation will entirely replace an existing object.
23805         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23806         #
23807         Other differences between PUT and PATCH are:
23808         #
23809         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23810         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23811         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23812       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23813       consumes:
23814         - application/json
23815         - application/xml
23816       produces:
23817         - application/json
23818         - application/xml
23819       responses:
23820         "default":
23821           description: Response codes found in [response codes](https://wiki.onap.org/).
23822       parameters:
23823         - name: site-pair-set-id
23824           in: path
23825           description: Unique id of site pair set.
23826           required: true
23827           type: string
23828           example: __SITE-PAIR-SET-ID__
23829         - name: routing-instance-id
23830           in: path
23831           description: Unique id of routing instance
23832           required: true
23833           type: string
23834           example: __ROUTING-INSTANCE-ID__
23835         - name: site-pair-id
23836           in: path
23837           description: unique identifier of probe
23838           required: true
23839           type: string
23840           example: __SITE-PAIR-ID__
23841         - name: cos
23842           in: path
23843           description: unique identifier of probe
23844           required: true
23845           type: string
23846           example: __COS__
23847         - name: body
23848           in: body
23849           description: class-of-service object that needs to be created or updated.
23850           required: true
23851           schema:
23852             $ref: "#/patchDefinitions/class-of-service"
23853     delete:
23854       tags:
23855         - Network
23856       summary: delete an existing class-of-service
23857       description: delete an existing class-of-service
23858       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23859       consumes:
23860         - application/json
23861         - application/xml
23862       produces:
23863         - application/json
23864         - application/xml
23865       responses:
23866         "default":
23867           description: Response codes found in [response codes](https://wiki.onap.org/).
23868       parameters:
23869         - name: site-pair-set-id
23870           in: path
23871           description: Unique id of site pair set.
23872           required: true
23873           type: string
23874           example: __SITE-PAIR-SET-ID__
23875         - name: routing-instance-id
23876           in: path
23877           description: Unique id of routing instance
23878           required: true
23879           type: string
23880           example: __ROUTING-INSTANCE-ID__
23881         - name: site-pair-id
23882           in: path
23883           description: unique identifier of probe
23884           required: true
23885           type: string
23886           example: __SITE-PAIR-ID__
23887         - name: cos
23888           in: path
23889           description: unique identifier of probe
23890           required: true
23891           type: string
23892           example: __COS__
23893         - name: resource-version
23894           in: query
23895           description: resource-version for concurrency
23896           required: true
23897           type: string
23898   /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:
23899     get:
23900       tags:
23901         - Network
23902       summary: returns classes-of-service
23903       description: returns classes-of-service
23904       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
23905       produces:
23906         - application/json
23907         - application/xml
23908       responses:
23909         "200":
23910           description: successful operation
23911           schema:
23912               $ref: "#/getDefinitions/classes-of-service"
23913         "default":
23914           description: Response codes found in [response codes](https://wiki.onap.org/).
23915       parameters:
23916         - name: site-pair-set-id
23917           in: path
23918           description: Unique id of site pair set.
23919           required: true
23920           type: string
23921           example: __SITE-PAIR-SET-ID__
23922         - name: routing-instance-id
23923           in: path
23924           description: Unique id of routing instance
23925           required: true
23926           type: string
23927           example: __ROUTING-INSTANCE-ID__
23928         - name: site-pair-id
23929           in: path
23930           description: unique identifier of probe
23931           required: true
23932           type: string
23933           example: __SITE-PAIR-ID__
23934   /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:
23935     put:
23936       tags:
23937         - Network
23938       summary: see node definition for valid relationships
23939       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
23940       consumes:
23941         - application/json
23942         - application/xml
23943       produces:
23944         - application/json
23945         - application/xml
23946       responses:
23947         "default":
23948           description: Response codes found in [response codes](https://wiki.onap.org/).
23949       parameters:
23950         - name: site-pair-set-id
23951           in: path
23952           description: Unique id of site pair set.
23953           required: true
23954           type: string
23955           example: __SITE-PAIR-SET-ID__
23956         - name: routing-instance-id
23957           in: path
23958           description: Unique id of routing instance
23959           required: true
23960           type: string
23961           example: __ROUTING-INSTANCE-ID__
23962         - name: site-pair-id
23963           in: path
23964           description: unique identifier of probe
23965           required: true
23966           type: string
23967           example: __SITE-PAIR-ID__
23968         - name: body
23969           in: body
23970           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
23971           required: true
23972           schema:
23973             $ref: "#/definitions/relationship"
23974     delete:
23975       tags:
23976         - Network
23977       summary: delete an existing relationship
23978       description: delete an existing relationship
23979       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
23980       consumes:
23981         - application/json
23982         - application/xml
23983       produces:
23984         - application/json
23985         - application/xml
23986       responses:
23987         "default":
23988           description: Response codes found in [response codes](https://wiki.onap.org/).
23989       parameters:
23990         - name: site-pair-set-id
23991           in: path
23992           description: Unique id of site pair set.
23993           required: true
23994           type: string
23995           example: __SITE-PAIR-SET-ID__
23996         - name: routing-instance-id
23997           in: path
23998           description: Unique id of routing instance
23999           required: true
24000           type: string
24001           example: __ROUTING-INSTANCE-ID__
24002         - name: site-pair-id
24003           in: path
24004           description: unique identifier of probe
24005           required: true
24006           type: string
24007           example: __SITE-PAIR-ID__
24008   /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}:
24009     get:
24010       tags:
24011         - Network
24012       summary: returns site-pair
24013       description: returns site-pair
24014       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
24015       produces:
24016         - application/json
24017         - application/xml
24018       responses:
24019         "200":
24020           description: successful operation
24021           schema:
24022               $ref: "#/getDefinitions/site-pair"
24023         "default":
24024           description: Response codes found in [response codes](https://wiki.onap.org/).
24025       parameters:
24026         - name: site-pair-set-id
24027           in: path
24028           description: Unique id of site pair set.
24029           required: true
24030           type: string
24031           example: __SITE-PAIR-SET-ID__
24032         - name: routing-instance-id
24033           in: path
24034           description: Unique id of routing instance
24035           required: true
24036           type: string
24037           example: __ROUTING-INSTANCE-ID__
24038         - name: site-pair-id
24039           in: path
24040           description: unique identifier of probe
24041           required: true
24042           type: string
24043           example: __SITE-PAIR-ID__
24044     put:
24045       tags:
24046         - Network
24047       summary: create or update an existing site-pair
24048       description: |
24049         Create or update an existing site-pair.
24050         #
24051         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24052       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
24053       consumes:
24054         - application/json
24055         - application/xml
24056       produces:
24057         - application/json
24058         - application/xml
24059       responses:
24060         "default":
24061           description: Response codes found in [response codes](https://wiki.onap.org/).
24062       parameters:
24063         - name: site-pair-set-id
24064           in: path
24065           description: Unique id of site pair set.
24066           required: true
24067           type: string
24068           example: __SITE-PAIR-SET-ID__
24069         - name: routing-instance-id
24070           in: path
24071           description: Unique id of routing instance
24072           required: true
24073           type: string
24074           example: __ROUTING-INSTANCE-ID__
24075         - name: site-pair-id
24076           in: path
24077           description: unique identifier of probe
24078           required: true
24079           type: string
24080           example: __SITE-PAIR-ID__
24081         - name: body
24082           in: body
24083           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
24084           required: true
24085           schema:
24086             $ref: "#/definitions/site-pair"
24087     patch:
24088       tags:
24089         - Network
24090       summary: update an existing site-pair
24091       description: |
24092         Update an existing site-pair
24093         #
24094         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24095         The PUT operation will entirely replace an existing object.
24096         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24097         #
24098         Other differences between PUT and PATCH are:
24099         #
24100         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24101         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24102         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24103       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
24104       consumes:
24105         - application/json
24106         - application/xml
24107       produces:
24108         - application/json
24109         - application/xml
24110       responses:
24111         "default":
24112           description: Response codes found in [response codes](https://wiki.onap.org/).
24113       parameters:
24114         - name: site-pair-set-id
24115           in: path
24116           description: Unique id of site pair set.
24117           required: true
24118           type: string
24119           example: __SITE-PAIR-SET-ID__
24120         - name: routing-instance-id
24121           in: path
24122           description: Unique id of routing instance
24123           required: true
24124           type: string
24125           example: __ROUTING-INSTANCE-ID__
24126         - name: site-pair-id
24127           in: path
24128           description: unique identifier of probe
24129           required: true
24130           type: string
24131           example: __SITE-PAIR-ID__
24132         - name: body
24133           in: body
24134           description: site-pair object that needs to be created or updated.
24135           required: true
24136           schema:
24137             $ref: "#/patchDefinitions/site-pair"
24138     delete:
24139       tags:
24140         - Network
24141       summary: delete an existing site-pair
24142       description: delete an existing site-pair
24143       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
24144       consumes:
24145         - application/json
24146         - application/xml
24147       produces:
24148         - application/json
24149         - application/xml
24150       responses:
24151         "default":
24152           description: Response codes found in [response codes](https://wiki.onap.org/).
24153       parameters:
24154         - name: site-pair-set-id
24155           in: path
24156           description: Unique id of site pair set.
24157           required: true
24158           type: string
24159           example: __SITE-PAIR-SET-ID__
24160         - name: routing-instance-id
24161           in: path
24162           description: Unique id of routing instance
24163           required: true
24164           type: string
24165           example: __ROUTING-INSTANCE-ID__
24166         - name: site-pair-id
24167           in: path
24168           description: unique identifier of probe
24169           required: true
24170           type: string
24171           example: __SITE-PAIR-ID__
24172         - name: resource-version
24173           in: query
24174           description: resource-version for concurrency
24175           required: true
24176           type: string
24177   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
24178     get:
24179       tags:
24180         - Network
24181       summary: returns site-pairs
24182       description: returns site-pairs
24183       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
24184       produces:
24185         - application/json
24186         - application/xml
24187       responses:
24188         "200":
24189           description: successful operation
24190           schema:
24191               $ref: "#/getDefinitions/site-pairs"
24192         "default":
24193           description: Response codes found in [response codes](https://wiki.onap.org/).
24194       parameters:
24195         - name: site-pair-set-id
24196           in: path
24197           description: Unique id of site pair set.
24198           required: true
24199           type: string
24200           example: __SITE-PAIR-SET-ID__
24201         - name: routing-instance-id
24202           in: path
24203           description: Unique id of routing instance
24204           required: true
24205           type: string
24206           example: __ROUTING-INSTANCE-ID__
24207   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
24208     put:
24209       tags:
24210         - Network
24211       summary: see node definition for valid relationships
24212       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
24213       consumes:
24214         - application/json
24215         - application/xml
24216       produces:
24217         - application/json
24218         - application/xml
24219       responses:
24220         "default":
24221           description: Response codes found in [response codes](https://wiki.onap.org/).
24222       parameters:
24223         - name: site-pair-set-id
24224           in: path
24225           description: Unique id of site pair set.
24226           required: true
24227           type: string
24228           example: __SITE-PAIR-SET-ID__
24229         - name: routing-instance-id
24230           in: path
24231           description: Unique id of routing instance
24232           required: true
24233           type: string
24234           example: __ROUTING-INSTANCE-ID__
24235         - name: body
24236           in: body
24237           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
24238           required: true
24239           schema:
24240             $ref: "#/definitions/relationship"
24241     delete:
24242       tags:
24243         - Network
24244       summary: delete an existing relationship
24245       description: delete an existing relationship
24246       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
24247       consumes:
24248         - application/json
24249         - application/xml
24250       produces:
24251         - application/json
24252         - application/xml
24253       responses:
24254         "default":
24255           description: Response codes found in [response codes](https://wiki.onap.org/).
24256       parameters:
24257         - name: site-pair-set-id
24258           in: path
24259           description: Unique id of site pair set.
24260           required: true
24261           type: string
24262           example: __SITE-PAIR-SET-ID__
24263         - name: routing-instance-id
24264           in: path
24265           description: Unique id of routing instance
24266           required: true
24267           type: string
24268           example: __ROUTING-INSTANCE-ID__
24269   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
24270     get:
24271       tags:
24272         - Network
24273       summary: returns routing-instance
24274       description: returns routing-instance
24275       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
24276       produces:
24277         - application/json
24278         - application/xml
24279       responses:
24280         "200":
24281           description: successful operation
24282           schema:
24283               $ref: "#/getDefinitions/routing-instance"
24284         "default":
24285           description: Response codes found in [response codes](https://wiki.onap.org/).
24286       parameters:
24287         - name: site-pair-set-id
24288           in: path
24289           description: Unique id of site pair set.
24290           required: true
24291           type: string
24292           example: __SITE-PAIR-SET-ID__
24293         - name: routing-instance-id
24294           in: path
24295           description: Unique id of routing instance
24296           required: true
24297           type: string
24298           example: __ROUTING-INSTANCE-ID__
24299     put:
24300       tags:
24301         - Network
24302       summary: create or update an existing routing-instance
24303       description: |
24304         Create or update an existing routing-instance.
24305         #
24306         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24307       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
24308       consumes:
24309         - application/json
24310         - application/xml
24311       produces:
24312         - application/json
24313         - application/xml
24314       responses:
24315         "default":
24316           description: Response codes found in [response codes](https://wiki.onap.org/).
24317       parameters:
24318         - name: site-pair-set-id
24319           in: path
24320           description: Unique id of site pair set.
24321           required: true
24322           type: string
24323           example: __SITE-PAIR-SET-ID__
24324         - name: routing-instance-id
24325           in: path
24326           description: Unique id of routing instance
24327           required: true
24328           type: string
24329           example: __ROUTING-INSTANCE-ID__
24330         - name: body
24331           in: body
24332           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
24333           required: true
24334           schema:
24335             $ref: "#/definitions/routing-instance"
24336     patch:
24337       tags:
24338         - Network
24339       summary: update an existing routing-instance
24340       description: |
24341         Update an existing routing-instance
24342         #
24343         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24344         The PUT operation will entirely replace an existing object.
24345         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24346         #
24347         Other differences between PUT and PATCH are:
24348         #
24349         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24350         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24351         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24352       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
24353       consumes:
24354         - application/json
24355         - application/xml
24356       produces:
24357         - application/json
24358         - application/xml
24359       responses:
24360         "default":
24361           description: Response codes found in [response codes](https://wiki.onap.org/).
24362       parameters:
24363         - name: site-pair-set-id
24364           in: path
24365           description: Unique id of site pair set.
24366           required: true
24367           type: string
24368           example: __SITE-PAIR-SET-ID__
24369         - name: routing-instance-id
24370           in: path
24371           description: Unique id of routing instance
24372           required: true
24373           type: string
24374           example: __ROUTING-INSTANCE-ID__
24375         - name: body
24376           in: body
24377           description: routing-instance object that needs to be created or updated.
24378           required: true
24379           schema:
24380             $ref: "#/patchDefinitions/routing-instance"
24381     delete:
24382       tags:
24383         - Network
24384       summary: delete an existing routing-instance
24385       description: delete an existing routing-instance
24386       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
24387       consumes:
24388         - application/json
24389         - application/xml
24390       produces:
24391         - application/json
24392         - application/xml
24393       responses:
24394         "default":
24395           description: Response codes found in [response codes](https://wiki.onap.org/).
24396       parameters:
24397         - name: site-pair-set-id
24398           in: path
24399           description: Unique id of site pair set.
24400           required: true
24401           type: string
24402           example: __SITE-PAIR-SET-ID__
24403         - name: routing-instance-id
24404           in: path
24405           description: Unique id of routing instance
24406           required: true
24407           type: string
24408           example: __ROUTING-INSTANCE-ID__
24409         - name: resource-version
24410           in: query
24411           description: resource-version for concurrency
24412           required: true
24413           type: string
24414   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
24415     get:
24416       tags:
24417         - Network
24418       summary: returns routing-instances
24419       description: returns routing-instances
24420       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
24421       produces:
24422         - application/json
24423         - application/xml
24424       responses:
24425         "200":
24426           description: successful operation
24427           schema:
24428               $ref: "#/getDefinitions/routing-instances"
24429         "default":
24430           description: Response codes found in [response codes](https://wiki.onap.org/).
24431       parameters:
24432         - name: site-pair-set-id
24433           in: path
24434           description: Unique id of site pair set.
24435           required: true
24436           type: string
24437           example: __SITE-PAIR-SET-ID__
24438   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
24439     put:
24440       tags:
24441         - Network
24442       summary: see node definition for valid relationships
24443       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
24444       consumes:
24445         - application/json
24446         - application/xml
24447       produces:
24448         - application/json
24449         - application/xml
24450       responses:
24451         "default":
24452           description: Response codes found in [response codes](https://wiki.onap.org/).
24453       parameters:
24454         - name: site-pair-set-id
24455           in: path
24456           description: Unique id of site pair set.
24457           required: true
24458           type: string
24459           example: __SITE-PAIR-SET-ID__
24460         - name: body
24461           in: body
24462           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
24463           required: true
24464           schema:
24465             $ref: "#/definitions/relationship"
24466     delete:
24467       tags:
24468         - Network
24469       summary: delete an existing relationship
24470       description: delete an existing relationship
24471       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
24472       consumes:
24473         - application/json
24474         - application/xml
24475       produces:
24476         - application/json
24477         - application/xml
24478       responses:
24479         "default":
24480           description: Response codes found in [response codes](https://wiki.onap.org/).
24481       parameters:
24482         - name: site-pair-set-id
24483           in: path
24484           description: Unique id of site pair set.
24485           required: true
24486           type: string
24487           example: __SITE-PAIR-SET-ID__
24488   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
24489     get:
24490       tags:
24491         - Network
24492       summary: returns site-pair-set
24493       description: returns site-pair-set
24494       operationId: getNetworkSitePairSetsSitePairSet
24495       produces:
24496         - application/json
24497         - application/xml
24498       responses:
24499         "200":
24500           description: successful operation
24501           schema:
24502               $ref: "#/getDefinitions/site-pair-set"
24503         "default":
24504           description: Response codes found in [response codes](https://wiki.onap.org/).
24505       parameters:
24506         - name: site-pair-set-id
24507           in: path
24508           description: Unique id of site pair set.
24509           required: true
24510           type: string
24511           example: __SITE-PAIR-SET-ID__
24512     put:
24513       tags:
24514         - Network
24515       summary: create or update an existing site-pair-set
24516       description: |
24517         Create or update an existing site-pair-set.
24518         #
24519         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24520       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
24521       consumes:
24522         - application/json
24523         - application/xml
24524       produces:
24525         - application/json
24526         - application/xml
24527       responses:
24528         "default":
24529           description: Response codes found in [response codes](https://wiki.onap.org/).
24530       parameters:
24531         - name: site-pair-set-id
24532           in: path
24533           description: Unique id of site pair set.
24534           required: true
24535           type: string
24536           example: __SITE-PAIR-SET-ID__
24537         - name: body
24538           in: body
24539           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
24540           required: true
24541           schema:
24542             $ref: "#/definitions/site-pair-set"
24543     patch:
24544       tags:
24545         - Network
24546       summary: update an existing site-pair-set
24547       description: |
24548         Update an existing site-pair-set
24549         #
24550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24551         The PUT operation will entirely replace an existing object.
24552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24553         #
24554         Other differences between PUT and PATCH are:
24555         #
24556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24559       operationId: UpdateNetworkSitePairSetsSitePairSet
24560       consumes:
24561         - application/json
24562         - application/xml
24563       produces:
24564         - application/json
24565         - application/xml
24566       responses:
24567         "default":
24568           description: Response codes found in [response codes](https://wiki.onap.org/).
24569       parameters:
24570         - name: site-pair-set-id
24571           in: path
24572           description: Unique id of site pair set.
24573           required: true
24574           type: string
24575           example: __SITE-PAIR-SET-ID__
24576         - name: body
24577           in: body
24578           description: site-pair-set object that needs to be created or updated.
24579           required: true
24580           schema:
24581             $ref: "#/patchDefinitions/site-pair-set"
24582     delete:
24583       tags:
24584         - Network
24585       summary: delete an existing site-pair-set
24586       description: delete an existing site-pair-set
24587       operationId: deleteNetworkSitePairSetsSitePairSet
24588       consumes:
24589         - application/json
24590         - application/xml
24591       produces:
24592         - application/json
24593         - application/xml
24594       responses:
24595         "default":
24596           description: Response codes found in [response codes](https://wiki.onap.org/).
24597       parameters:
24598         - name: site-pair-set-id
24599           in: path
24600           description: Unique id of site pair set.
24601           required: true
24602           type: string
24603           example: __SITE-PAIR-SET-ID__
24604         - name: resource-version
24605           in: query
24606           description: resource-version for concurrency
24607           required: true
24608           type: string
24609   /network/site-pair-sets:
24610     get:
24611       tags:
24612         - Network
24613       summary: returns site-pair-sets
24614       description: returns site-pair-sets
24615       operationId: getNetworkSitePairSets
24616       produces:
24617         - application/json
24618         - application/xml
24619       responses:
24620         "200":
24621           description: successful operation
24622           schema:
24623               $ref: "#/getDefinitions/site-pair-sets"
24624         "default":
24625           description: Response codes found in [response codes](https://wiki.onap.org/).
24626   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
24627     put:
24628       tags:
24629         - Network
24630       summary: see node definition for valid relationships
24631       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
24632       consumes:
24633         - application/json
24634         - application/xml
24635       produces:
24636         - application/json
24637         - application/xml
24638       responses:
24639         "default":
24640           description: Response codes found in [response codes](https://wiki.onap.org/).
24641       parameters:
24642         - name: vpn-id
24643           in: path
24644           description: VPN ID, globally unique within A&AI
24645           required: true
24646           type: string
24647           example: __VPN-ID__
24648         - name: global-route-target
24649           in: path
24650           description: Number used to identify an RT, globally unique in the network
24651           required: true
24652           type: string
24653           example: __GLOBAL-ROUTE-TARGET__
24654         - name: route-target-role
24655           in: path
24656           description: Role assigned to this route target
24657           required: true
24658           type: string
24659           example: __ROUTE-TARGET-ROLE__
24660         - name: body
24661           in: body
24662           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
24663           required: true
24664           schema:
24665             $ref: "#/definitions/relationship"
24666     delete:
24667       tags:
24668         - Network
24669       summary: delete an existing relationship
24670       description: delete an existing relationship
24671       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
24672       consumes:
24673         - application/json
24674         - application/xml
24675       produces:
24676         - application/json
24677         - application/xml
24678       responses:
24679         "default":
24680           description: Response codes found in [response codes](https://wiki.onap.org/).
24681       parameters:
24682         - name: vpn-id
24683           in: path
24684           description: VPN ID, globally unique within A&AI
24685           required: true
24686           type: string
24687           example: __VPN-ID__
24688         - name: global-route-target
24689           in: path
24690           description: Number used to identify an RT, globally unique in the network
24691           required: true
24692           type: string
24693           example: __GLOBAL-ROUTE-TARGET__
24694         - name: route-target-role
24695           in: path
24696           description: Role assigned to this route target
24697           required: true
24698           type: string
24699           example: __ROUTE-TARGET-ROLE__
24700   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
24701     get:
24702       tags:
24703         - Network
24704       summary: returns route-target
24705       description: returns route-target
24706       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24707       produces:
24708         - application/json
24709         - application/xml
24710       responses:
24711         "200":
24712           description: successful operation
24713           schema:
24714               $ref: "#/getDefinitions/route-target"
24715         "default":
24716           description: Response codes found in [response codes](https://wiki.onap.org/).
24717       parameters:
24718         - name: vpn-id
24719           in: path
24720           description: VPN ID, globally unique within A&AI
24721           required: true
24722           type: string
24723           example: __VPN-ID__
24724         - name: global-route-target
24725           in: path
24726           description: Number used to identify an RT, globally unique in the network
24727           required: true
24728           type: string
24729           example: __GLOBAL-ROUTE-TARGET__
24730         - name: route-target-role
24731           in: path
24732           description: Role assigned to this route target
24733           required: true
24734           type: string
24735           example: __ROUTE-TARGET-ROLE__
24736         - name: vpn-name
24737           in: query
24738           description: VPN Name
24739           required: false
24740           type: string
24741         - name: vpn-type
24742           in: query
24743           description: Type of the vpn, should be taken from enumerated/valid values
24744           required: false
24745           type: string
24746     put:
24747       tags:
24748         - Network
24749       summary: create or update an existing route-target
24750       description: |
24751         Create or update an existing route-target.
24752         #
24753         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24754       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24755       consumes:
24756         - application/json
24757         - application/xml
24758       produces:
24759         - application/json
24760         - application/xml
24761       responses:
24762         "default":
24763           description: Response codes found in [response codes](https://wiki.onap.org/).
24764       parameters:
24765         - name: vpn-id
24766           in: path
24767           description: VPN ID, globally unique within A&AI
24768           required: true
24769           type: string
24770           example: __VPN-ID__
24771         - name: global-route-target
24772           in: path
24773           description: Number used to identify an RT, globally unique in the network
24774           required: true
24775           type: string
24776           example: __GLOBAL-ROUTE-TARGET__
24777         - name: route-target-role
24778           in: path
24779           description: Role assigned to this route target
24780           required: true
24781           type: string
24782           example: __ROUTE-TARGET-ROLE__
24783         - name: body
24784           in: body
24785           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
24786           required: true
24787           schema:
24788             $ref: "#/definitions/route-target"
24789     patch:
24790       tags:
24791         - Network
24792       summary: update an existing route-target
24793       description: |
24794         Update an existing route-target
24795         #
24796         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24797         The PUT operation will entirely replace an existing object.
24798         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24799         #
24800         Other differences between PUT and PATCH are:
24801         #
24802         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24803         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24804         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24805       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24806       consumes:
24807         - application/json
24808         - application/xml
24809       produces:
24810         - application/json
24811         - application/xml
24812       responses:
24813         "default":
24814           description: Response codes found in [response codes](https://wiki.onap.org/).
24815       parameters:
24816         - name: vpn-id
24817           in: path
24818           description: VPN ID, globally unique within A&AI
24819           required: true
24820           type: string
24821           example: __VPN-ID__
24822         - name: global-route-target
24823           in: path
24824           description: Number used to identify an RT, globally unique in the network
24825           required: true
24826           type: string
24827           example: __GLOBAL-ROUTE-TARGET__
24828         - name: route-target-role
24829           in: path
24830           description: Role assigned to this route target
24831           required: true
24832           type: string
24833           example: __ROUTE-TARGET-ROLE__
24834         - name: body
24835           in: body
24836           description: route-target object that needs to be created or updated.
24837           required: true
24838           schema:
24839             $ref: "#/patchDefinitions/route-target"
24840     delete:
24841       tags:
24842         - Network
24843       summary: delete an existing route-target
24844       description: delete an existing route-target
24845       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24846       consumes:
24847         - application/json
24848         - application/xml
24849       produces:
24850         - application/json
24851         - application/xml
24852       responses:
24853         "default":
24854           description: Response codes found in [response codes](https://wiki.onap.org/).
24855       parameters:
24856         - name: vpn-id
24857           in: path
24858           description: VPN ID, globally unique within A&AI
24859           required: true
24860           type: string
24861           example: __VPN-ID__
24862         - name: global-route-target
24863           in: path
24864           description: Number used to identify an RT, globally unique in the network
24865           required: true
24866           type: string
24867           example: __GLOBAL-ROUTE-TARGET__
24868         - name: route-target-role
24869           in: path
24870           description: Role assigned to this route target
24871           required: true
24872           type: string
24873           example: __ROUTE-TARGET-ROLE__
24874         - name: resource-version
24875           in: query
24876           description: resource-version for concurrency
24877           required: true
24878           type: string
24879   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
24880     get:
24881       tags:
24882         - Network
24883       summary: returns route-targets
24884       description: returns route-targets
24885       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
24886       produces:
24887         - application/json
24888         - application/xml
24889       responses:
24890         "200":
24891           description: successful operation
24892           schema:
24893               $ref: "#/getDefinitions/route-targets"
24894         "default":
24895           description: Response codes found in [response codes](https://wiki.onap.org/).
24896       parameters:
24897         - name: vpn-id
24898           in: path
24899           description: VPN ID, globally unique within A&AI
24900           required: true
24901           type: string
24902           example: __VPN-ID__
24903         - name: vpn-name
24904           in: query
24905           description: VPN Name
24906           required: false
24907           type: string
24908         - name: vpn-type
24909           in: query
24910           description: Type of the vpn, should be taken from enumerated/valid values
24911           required: false
24912           type: string
24913   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
24914     put:
24915       tags:
24916         - Network
24917       summary: see node definition for valid relationships
24918       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
24919       consumes:
24920         - application/json
24921         - application/xml
24922       produces:
24923         - application/json
24924         - application/xml
24925       responses:
24926         "default":
24927           description: Response codes found in [response codes](https://wiki.onap.org/).
24928       parameters:
24929         - name: vpn-id
24930           in: path
24931           description: VPN ID, globally unique within A&AI
24932           required: true
24933           type: string
24934           example: __VPN-ID__
24935         - name: body
24936           in: body
24937           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
24938           required: true
24939           schema:
24940             $ref: "#/definitions/relationship"
24941     delete:
24942       tags:
24943         - Network
24944       summary: delete an existing relationship
24945       description: delete an existing relationship
24946       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
24947       consumes:
24948         - application/json
24949         - application/xml
24950       produces:
24951         - application/json
24952         - application/xml
24953       responses:
24954         "default":
24955           description: Response codes found in [response codes](https://wiki.onap.org/).
24956       parameters:
24957         - name: vpn-id
24958           in: path
24959           description: VPN ID, globally unique within A&AI
24960           required: true
24961           type: string
24962           example: __VPN-ID__
24963   /network/vpn-bindings/vpn-binding/{vpn-id}:
24964     get:
24965       tags:
24966         - Network
24967       summary: returns vpn-binding
24968       description: returns vpn-binding
24969       operationId: getNetworkVpnBindingsVpnBinding
24970       produces:
24971         - application/json
24972         - application/xml
24973       responses:
24974         "200":
24975           description: successful operation
24976           schema:
24977               $ref: "#/getDefinitions/vpn-binding"
24978         "default":
24979           description: Response codes found in [response codes](https://wiki.onap.org/).
24980       parameters:
24981         - name: vpn-id
24982           in: path
24983           description: VPN ID, globally unique within A&AI
24984           required: true
24985           type: string
24986           example: __VPN-ID__
24987         - name: vpn-name
24988           in: query
24989           description: VPN Name
24990           required: false
24991           type: string
24992         - name: vpn-type
24993           in: query
24994           description: Type of the vpn, should be taken from enumerated/valid values
24995           required: false
24996           type: string
24997     put:
24998       tags:
24999         - Network
25000       summary: create or update an existing vpn-binding
25001       description: |
25002         Create or update an existing vpn-binding.
25003         #
25004         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25005       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
25006       consumes:
25007         - application/json
25008         - application/xml
25009       produces:
25010         - application/json
25011         - application/xml
25012       responses:
25013         "default":
25014           description: Response codes found in [response codes](https://wiki.onap.org/).
25015       parameters:
25016         - name: vpn-id
25017           in: path
25018           description: VPN ID, globally unique within A&AI
25019           required: true
25020           type: string
25021           example: __VPN-ID__
25022         - name: body
25023           in: body
25024           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
25025           required: true
25026           schema:
25027             $ref: "#/definitions/vpn-binding"
25028     patch:
25029       tags:
25030         - Network
25031       summary: update an existing vpn-binding
25032       description: |
25033         Update an existing vpn-binding
25034         #
25035         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25036         The PUT operation will entirely replace an existing object.
25037         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25038         #
25039         Other differences between PUT and PATCH are:
25040         #
25041         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25042         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25043         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25044       operationId: UpdateNetworkVpnBindingsVpnBinding
25045       consumes:
25046         - application/json
25047         - application/xml
25048       produces:
25049         - application/json
25050         - application/xml
25051       responses:
25052         "default":
25053           description: Response codes found in [response codes](https://wiki.onap.org/).
25054       parameters:
25055         - name: vpn-id
25056           in: path
25057           description: VPN ID, globally unique within A&AI
25058           required: true
25059           type: string
25060           example: __VPN-ID__
25061         - name: body
25062           in: body
25063           description: vpn-binding object that needs to be created or updated.
25064           required: true
25065           schema:
25066             $ref: "#/patchDefinitions/vpn-binding"
25067     delete:
25068       tags:
25069         - Network
25070       summary: delete an existing vpn-binding
25071       description: delete an existing vpn-binding
25072       operationId: deleteNetworkVpnBindingsVpnBinding
25073       consumes:
25074         - application/json
25075         - application/xml
25076       produces:
25077         - application/json
25078         - application/xml
25079       responses:
25080         "default":
25081           description: Response codes found in [response codes](https://wiki.onap.org/).
25082       parameters:
25083         - name: vpn-id
25084           in: path
25085           description: VPN ID, globally unique within A&AI
25086           required: true
25087           type: string
25088           example: __VPN-ID__
25089         - name: resource-version
25090           in: query
25091           description: resource-version for concurrency
25092           required: true
25093           type: string
25094   /network/vpn-bindings:
25095     get:
25096       tags:
25097         - Network
25098       summary: returns vpn-bindings
25099       description: returns vpn-bindings
25100       operationId: getNetworkVpnBindings
25101       produces:
25102         - application/json
25103         - application/xml
25104       responses:
25105         "200":
25106           description: successful operation
25107           schema:
25108               $ref: "#/getDefinitions/vpn-bindings"
25109         "default":
25110           description: Response codes found in [response codes](https://wiki.onap.org/).
25111   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
25112     put:
25113       tags:
25114         - Network
25115       summary: see node definition for valid relationships
25116       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
25117       consumes:
25118         - application/json
25119         - application/xml
25120       produces:
25121         - application/json
25122         - application/xml
25123       responses:
25124         "default":
25125           description: Response codes found in [response codes](https://wiki.onap.org/).
25126       parameters:
25127         - name: equipment-name
25128           in: path
25129           required: true
25130           type: string
25131           example: __EQUIPMENT-NAME__
25132         - name: body
25133           in: body
25134           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
25135           required: true
25136           schema:
25137             $ref: "#/definitions/relationship"
25138     delete:
25139       tags:
25140         - Network
25141       summary: delete an existing relationship
25142       description: delete an existing relationship
25143       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
25144       consumes:
25145         - application/json
25146         - application/xml
25147       produces:
25148         - application/json
25149         - application/xml
25150       responses:
25151         "default":
25152           description: Response codes found in [response codes](https://wiki.onap.org/).
25153       parameters:
25154         - name: equipment-name
25155           in: path
25156           required: true
25157           type: string
25158           example: __EQUIPMENT-NAME__
25159   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
25160     put:
25161       tags:
25162         - Network
25163       summary: see node definition for valid relationships
25164       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
25165       consumes:
25166         - application/json
25167         - application/xml
25168       produces:
25169         - application/json
25170         - application/xml
25171       responses:
25172         "default":
25173           description: Response codes found in [response codes](https://wiki.onap.org/).
25174       parameters:
25175         - name: equipment-name
25176           in: path
25177           required: true
25178           type: string
25179           example: __EQUIPMENT-NAME__
25180         - name: interface-name
25181           in: path
25182           description: Name that identifies the physical interface
25183           required: true
25184           type: string
25185           example: __INTERFACE-NAME__
25186         - name: body
25187           in: body
25188           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
25189           required: true
25190           schema:
25191             $ref: "#/definitions/relationship"
25192     delete:
25193       tags:
25194         - Network
25195       summary: delete an existing relationship
25196       description: delete an existing relationship
25197       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
25198       consumes:
25199         - application/json
25200         - application/xml
25201       produces:
25202         - application/json
25203         - application/xml
25204       responses:
25205         "default":
25206           description: Response codes found in [response codes](https://wiki.onap.org/).
25207       parameters:
25208         - name: equipment-name
25209           in: path
25210           required: true
25211           type: string
25212           example: __EQUIPMENT-NAME__
25213         - name: interface-name
25214           in: path
25215           description: Name that identifies the physical interface
25216           required: true
25217           type: string
25218           example: __INTERFACE-NAME__
25219   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
25220     put:
25221       tags:
25222         - Network
25223       summary: see node definition for valid relationships
25224       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
25225       consumes:
25226         - application/json
25227         - application/xml
25228       produces:
25229         - application/json
25230         - application/xml
25231       responses:
25232         "default":
25233           description: Response codes found in [response codes](https://wiki.onap.org/).
25234       parameters:
25235         - name: equipment-name
25236           in: path
25237           required: true
25238           type: string
25239           example: __EQUIPMENT-NAME__
25240         - name: interface-name
25241           in: path
25242           description: Name that identifies the physical interface
25243           required: true
25244           type: string
25245           example: __INTERFACE-NAME__
25246         - name: pf-pci-id
25247           in: path
25248           description: Identifier for the sriov-pf
25249           required: true
25250           type: string
25251           example: __PF-PCI-ID__
25252         - name: body
25253           in: body
25254           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
25255           required: true
25256           schema:
25257             $ref: "#/definitions/relationship"
25258     delete:
25259       tags:
25260         - Network
25261       summary: delete an existing relationship
25262       description: delete an existing relationship
25263       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
25264       consumes:
25265         - application/json
25266         - application/xml
25267       produces:
25268         - application/json
25269         - application/xml
25270       responses:
25271         "default":
25272           description: Response codes found in [response codes](https://wiki.onap.org/).
25273       parameters:
25274         - name: equipment-name
25275           in: path
25276           required: true
25277           type: string
25278           example: __EQUIPMENT-NAME__
25279         - name: interface-name
25280           in: path
25281           description: Name that identifies the physical interface
25282           required: true
25283           type: string
25284           example: __INTERFACE-NAME__
25285         - name: pf-pci-id
25286           in: path
25287           description: Identifier for the sriov-pf
25288           required: true
25289           type: string
25290           example: __PF-PCI-ID__
25291   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
25292     get:
25293       tags:
25294         - Network
25295       summary: returns sriov-pf
25296       description: returns sriov-pf
25297       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
25298       produces:
25299         - application/json
25300         - application/xml
25301       responses:
25302         "200":
25303           description: successful operation
25304           schema:
25305               $ref: "#/getDefinitions/sriov-pf"
25306         "default":
25307           description: Response codes found in [response codes](https://wiki.onap.org/).
25308       parameters:
25309         - name: equipment-name
25310           in: path
25311           required: true
25312           type: string
25313           example: __EQUIPMENT-NAME__
25314         - name: interface-name
25315           in: path
25316           description: Name that identifies the physical interface
25317           required: true
25318           type: string
25319           example: __INTERFACE-NAME__
25320         - name: pf-pci-id
25321           in: path
25322           description: Identifier for the sriov-pf
25323           required: true
25324           type: string
25325           example: __PF-PCI-ID__
25326         - name: prov-status
25327           in: query
25328           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25329           required: false
25330           type: string
25331         - name: prov-status
25332           in: query
25333           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25334           required: false
25335           type: string
25336     put:
25337       tags:
25338         - Network
25339       summary: create or update an existing sriov-pf
25340       description: |
25341         Create or update an existing sriov-pf.
25342         #
25343         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25344       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
25345       consumes:
25346         - application/json
25347         - application/xml
25348       produces:
25349         - application/json
25350         - application/xml
25351       responses:
25352         "default":
25353           description: Response codes found in [response codes](https://wiki.onap.org/).
25354       parameters:
25355         - name: equipment-name
25356           in: path
25357           required: true
25358           type: string
25359           example: __EQUIPMENT-NAME__
25360         - name: interface-name
25361           in: path
25362           description: Name that identifies the physical interface
25363           required: true
25364           type: string
25365           example: __INTERFACE-NAME__
25366         - name: pf-pci-id
25367           in: path
25368           description: Identifier for the sriov-pf
25369           required: true
25370           type: string
25371           example: __PF-PCI-ID__
25372         - name: body
25373           in: body
25374           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
25375           required: true
25376           schema:
25377             $ref: "#/definitions/sriov-pf"
25378     patch:
25379       tags:
25380         - Network
25381       summary: update an existing sriov-pf
25382       description: |
25383         Update an existing sriov-pf
25384         #
25385         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25386         The PUT operation will entirely replace an existing object.
25387         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25388         #
25389         Other differences between PUT and PATCH are:
25390         #
25391         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25392         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25393         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25394       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
25395       consumes:
25396         - application/json
25397         - application/xml
25398       produces:
25399         - application/json
25400         - application/xml
25401       responses:
25402         "default":
25403           description: Response codes found in [response codes](https://wiki.onap.org/).
25404       parameters:
25405         - name: equipment-name
25406           in: path
25407           required: true
25408           type: string
25409           example: __EQUIPMENT-NAME__
25410         - name: interface-name
25411           in: path
25412           description: Name that identifies the physical interface
25413           required: true
25414           type: string
25415           example: __INTERFACE-NAME__
25416         - name: pf-pci-id
25417           in: path
25418           description: Identifier for the sriov-pf
25419           required: true
25420           type: string
25421           example: __PF-PCI-ID__
25422         - name: body
25423           in: body
25424           description: sriov-pf object that needs to be created or updated.
25425           required: true
25426           schema:
25427             $ref: "#/patchDefinitions/sriov-pf"
25428     delete:
25429       tags:
25430         - Network
25431       summary: delete an existing sriov-pf
25432       description: delete an existing sriov-pf
25433       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
25434       consumes:
25435         - application/json
25436         - application/xml
25437       produces:
25438         - application/json
25439         - application/xml
25440       responses:
25441         "default":
25442           description: Response codes found in [response codes](https://wiki.onap.org/).
25443       parameters:
25444         - name: equipment-name
25445           in: path
25446           required: true
25447           type: string
25448           example: __EQUIPMENT-NAME__
25449         - name: interface-name
25450           in: path
25451           description: Name that identifies the physical interface
25452           required: true
25453           type: string
25454           example: __INTERFACE-NAME__
25455         - name: pf-pci-id
25456           in: path
25457           description: Identifier for the sriov-pf
25458           required: true
25459           type: string
25460           example: __PF-PCI-ID__
25461         - name: resource-version
25462           in: query
25463           description: resource-version for concurrency
25464           required: true
25465           type: string
25466   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
25467     get:
25468       tags:
25469         - Network
25470       summary: returns sriov-pfs
25471       description: returns sriov-pfs
25472       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
25473       produces:
25474         - application/json
25475         - application/xml
25476       responses:
25477         "200":
25478           description: successful operation
25479           schema:
25480               $ref: "#/getDefinitions/sriov-pfs"
25481         "default":
25482           description: Response codes found in [response codes](https://wiki.onap.org/).
25483       parameters:
25484         - name: equipment-name
25485           in: path
25486           required: true
25487           type: string
25488           example: __EQUIPMENT-NAME__
25489         - name: interface-name
25490           in: path
25491           description: Name that identifies the physical interface
25492           required: true
25493           type: string
25494           example: __INTERFACE-NAME__
25495         - name: prov-status
25496           in: query
25497           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25498           required: false
25499           type: string
25500         - name: prov-status
25501           in: query
25502           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25503           required: false
25504           type: string
25505   /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:
25506     put:
25507       tags:
25508         - Network
25509       summary: see node definition for valid relationships
25510       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25511       consumes:
25512         - application/json
25513         - application/xml
25514       produces:
25515         - application/json
25516         - application/xml
25517       responses:
25518         "default":
25519           description: Response codes found in [response codes](https://wiki.onap.org/).
25520       parameters:
25521         - name: equipment-name
25522           in: path
25523           required: true
25524           type: string
25525           example: __EQUIPMENT-NAME__
25526         - name: interface-name
25527           in: path
25528           description: Name that identifies the physical interface
25529           required: true
25530           type: string
25531           example: __INTERFACE-NAME__
25532         - name: interface-name
25533           in: path
25534           description: Name given to the interface
25535           required: true
25536           type: string
25537           example: __INTERFACE-NAME__
25538         - name: vlan-interface
25539           in: path
25540           description: String that identifies the interface
25541           required: true
25542           type: string
25543           example: __VLAN-INTERFACE__
25544         - name: body
25545           in: body
25546           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
25547           required: true
25548           schema:
25549             $ref: "#/definitions/relationship"
25550     delete:
25551       tags:
25552         - Network
25553       summary: delete an existing relationship
25554       description: delete an existing relationship
25555       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25556       consumes:
25557         - application/json
25558         - application/xml
25559       produces:
25560         - application/json
25561         - application/xml
25562       responses:
25563         "default":
25564           description: Response codes found in [response codes](https://wiki.onap.org/).
25565       parameters:
25566         - name: equipment-name
25567           in: path
25568           required: true
25569           type: string
25570           example: __EQUIPMENT-NAME__
25571         - name: interface-name
25572           in: path
25573           description: Name that identifies the physical interface
25574           required: true
25575           type: string
25576           example: __INTERFACE-NAME__
25577         - name: interface-name
25578           in: path
25579           description: Name given to the interface
25580           required: true
25581           type: string
25582           example: __INTERFACE-NAME__
25583         - name: vlan-interface
25584           in: path
25585           description: String that identifies the interface
25586           required: true
25587           type: string
25588           example: __VLAN-INTERFACE__
25589   /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:
25590     put:
25591       tags:
25592         - Network
25593       summary: see node definition for valid relationships
25594       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25595       consumes:
25596         - application/json
25597         - application/xml
25598       produces:
25599         - application/json
25600         - application/xml
25601       responses:
25602         "default":
25603           description: Response codes found in [response codes](https://wiki.onap.org/).
25604       parameters:
25605         - name: equipment-name
25606           in: path
25607           required: true
25608           type: string
25609           example: __EQUIPMENT-NAME__
25610         - name: interface-name
25611           in: path
25612           description: Name that identifies the physical interface
25613           required: true
25614           type: string
25615           example: __INTERFACE-NAME__
25616         - name: interface-name
25617           in: path
25618           description: Name given to the interface
25619           required: true
25620           type: string
25621           example: __INTERFACE-NAME__
25622         - name: vlan-interface
25623           in: path
25624           description: String that identifies the interface
25625           required: true
25626           type: string
25627           example: __VLAN-INTERFACE__
25628         - name: l3-interface-ipv4-address
25629           in: path
25630           description: IP address
25631           required: true
25632           type: string
25633           example: __L3-INTERFACE-IPV4-ADDRESS__
25634         - name: body
25635           in: body
25636           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25637           required: true
25638           schema:
25639             $ref: "#/definitions/relationship"
25640     delete:
25641       tags:
25642         - Network
25643       summary: delete an existing relationship
25644       description: delete an existing relationship
25645       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25646       consumes:
25647         - application/json
25648         - application/xml
25649       produces:
25650         - application/json
25651         - application/xml
25652       responses:
25653         "default":
25654           description: Response codes found in [response codes](https://wiki.onap.org/).
25655       parameters:
25656         - name: equipment-name
25657           in: path
25658           required: true
25659           type: string
25660           example: __EQUIPMENT-NAME__
25661         - name: interface-name
25662           in: path
25663           description: Name that identifies the physical interface
25664           required: true
25665           type: string
25666           example: __INTERFACE-NAME__
25667         - name: interface-name
25668           in: path
25669           description: Name given to the interface
25670           required: true
25671           type: string
25672           example: __INTERFACE-NAME__
25673         - name: vlan-interface
25674           in: path
25675           description: String that identifies the interface
25676           required: true
25677           type: string
25678           example: __VLAN-INTERFACE__
25679         - name: l3-interface-ipv4-address
25680           in: path
25681           description: IP address
25682           required: true
25683           type: string
25684           example: __L3-INTERFACE-IPV4-ADDRESS__
25685   /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}:
25686     get:
25687       tags:
25688         - Network
25689       summary: returns l3-interface-ipv4-address-list
25690       description: returns l3-interface-ipv4-address-list
25691       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25692       produces:
25693         - application/json
25694         - application/xml
25695       responses:
25696         "200":
25697           description: successful operation
25698           schema:
25699               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25700         "default":
25701           description: Response codes found in [response codes](https://wiki.onap.org/).
25702       parameters:
25703         - name: equipment-name
25704           in: path
25705           required: true
25706           type: string
25707           example: __EQUIPMENT-NAME__
25708         - name: interface-name
25709           in: path
25710           description: Name that identifies the physical interface
25711           required: true
25712           type: string
25713           example: __INTERFACE-NAME__
25714         - name: interface-name
25715           in: path
25716           description: Name given to the interface
25717           required: true
25718           type: string
25719           example: __INTERFACE-NAME__
25720         - name: vlan-interface
25721           in: path
25722           description: String that identifies the interface
25723           required: true
25724           type: string
25725           example: __VLAN-INTERFACE__
25726         - name: l3-interface-ipv4-address
25727           in: path
25728           description: IP address
25729           required: true
25730           type: string
25731           example: __L3-INTERFACE-IPV4-ADDRESS__
25732         - name: prov-status
25733           in: query
25734           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25735           required: false
25736           type: string
25737         - name: prov-status
25738           in: query
25739           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25740           required: false
25741           type: string
25742         - name: interface-id
25743           in: query
25744           description: ID of interface
25745           required: false
25746           type: string
25747         - name: macaddr
25748           in: query
25749           description: MAC address for the interface
25750           required: false
25751           type: string
25752         - name: network-name
25753           in: query
25754           description: Name of the network
25755           required: false
25756           type: string
25757         - name: vlan-id-inner
25758           in: query
25759           description: Inner VLAN tag
25760           required: false
25761           type: integer
25762           format: int64
25763         - name: vpn-key
25764           in: query
25765           description: This indicates the customers VPN ID associated with this vlan
25766           required: false
25767           type: string
25768         - name: vlan-id-inner
25769           in: query
25770           description: Inner VLAN tag
25771           required: false
25772           type: integer
25773           format: int64
25774         - name: neutron-network-id
25775           in: query
25776           description: Neutron network id of the interface that address belongs to
25777           required: false
25778           type: string
25779         - name: neutron-subnet-id
25780           in: query
25781           description: Neutron id of subnet that address belongs to
25782           required: false
25783           type: string
25784     put:
25785       tags:
25786         - Network
25787       summary: create or update an existing l3-interface-ipv4-address-list
25788       description: |
25789         Create or update an existing l3-interface-ipv4-address-list.
25790         #
25791         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25792       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25793       consumes:
25794         - application/json
25795         - application/xml
25796       produces:
25797         - application/json
25798         - application/xml
25799       responses:
25800         "default":
25801           description: Response codes found in [response codes](https://wiki.onap.org/).
25802       parameters:
25803         - name: equipment-name
25804           in: path
25805           required: true
25806           type: string
25807           example: __EQUIPMENT-NAME__
25808         - name: interface-name
25809           in: path
25810           description: Name that identifies the physical interface
25811           required: true
25812           type: string
25813           example: __INTERFACE-NAME__
25814         - name: interface-name
25815           in: path
25816           description: Name given to the interface
25817           required: true
25818           type: string
25819           example: __INTERFACE-NAME__
25820         - name: vlan-interface
25821           in: path
25822           description: String that identifies the interface
25823           required: true
25824           type: string
25825           example: __VLAN-INTERFACE__
25826         - name: l3-interface-ipv4-address
25827           in: path
25828           description: IP address
25829           required: true
25830           type: string
25831           example: __L3-INTERFACE-IPV4-ADDRESS__
25832         - name: body
25833           in: body
25834           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25835           required: true
25836           schema:
25837             $ref: "#/definitions/l3-interface-ipv4-address-list"
25838     patch:
25839       tags:
25840         - Network
25841       summary: update an existing l3-interface-ipv4-address-list
25842       description: |
25843         Update an existing l3-interface-ipv4-address-list
25844         #
25845         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25846         The PUT operation will entirely replace an existing object.
25847         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25848         #
25849         Other differences between PUT and PATCH are:
25850         #
25851         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25852         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25853         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25854       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25855       consumes:
25856         - application/json
25857         - application/xml
25858       produces:
25859         - application/json
25860         - application/xml
25861       responses:
25862         "default":
25863           description: Response codes found in [response codes](https://wiki.onap.org/).
25864       parameters:
25865         - name: equipment-name
25866           in: path
25867           required: true
25868           type: string
25869           example: __EQUIPMENT-NAME__
25870         - name: interface-name
25871           in: path
25872           description: Name that identifies the physical interface
25873           required: true
25874           type: string
25875           example: __INTERFACE-NAME__
25876         - name: interface-name
25877           in: path
25878           description: Name given to the interface
25879           required: true
25880           type: string
25881           example: __INTERFACE-NAME__
25882         - name: vlan-interface
25883           in: path
25884           description: String that identifies the interface
25885           required: true
25886           type: string
25887           example: __VLAN-INTERFACE__
25888         - name: l3-interface-ipv4-address
25889           in: path
25890           description: IP address
25891           required: true
25892           type: string
25893           example: __L3-INTERFACE-IPV4-ADDRESS__
25894         - name: body
25895           in: body
25896           description: l3-interface-ipv4-address-list object that needs to be created or updated.
25897           required: true
25898           schema:
25899             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25900     delete:
25901       tags:
25902         - Network
25903       summary: delete an existing l3-interface-ipv4-address-list
25904       description: delete an existing l3-interface-ipv4-address-list
25905       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25906       consumes:
25907         - application/json
25908         - application/xml
25909       produces:
25910         - application/json
25911         - application/xml
25912       responses:
25913         "default":
25914           description: Response codes found in [response codes](https://wiki.onap.org/).
25915       parameters:
25916         - name: equipment-name
25917           in: path
25918           required: true
25919           type: string
25920           example: __EQUIPMENT-NAME__
25921         - name: interface-name
25922           in: path
25923           description: Name that identifies the physical interface
25924           required: true
25925           type: string
25926           example: __INTERFACE-NAME__
25927         - name: interface-name
25928           in: path
25929           description: Name given to the interface
25930           required: true
25931           type: string
25932           example: __INTERFACE-NAME__
25933         - name: vlan-interface
25934           in: path
25935           description: String that identifies the interface
25936           required: true
25937           type: string
25938           example: __VLAN-INTERFACE__
25939         - name: l3-interface-ipv4-address
25940           in: path
25941           description: IP address
25942           required: true
25943           type: string
25944           example: __L3-INTERFACE-IPV4-ADDRESS__
25945         - name: resource-version
25946           in: query
25947           description: resource-version for concurrency
25948           required: true
25949           type: string
25950   /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:
25951     put:
25952       tags:
25953         - Network
25954       summary: see node definition for valid relationships
25955       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25956       consumes:
25957         - application/json
25958         - application/xml
25959       produces:
25960         - application/json
25961         - application/xml
25962       responses:
25963         "default":
25964           description: Response codes found in [response codes](https://wiki.onap.org/).
25965       parameters:
25966         - name: equipment-name
25967           in: path
25968           required: true
25969           type: string
25970           example: __EQUIPMENT-NAME__
25971         - name: interface-name
25972           in: path
25973           description: Name that identifies the physical interface
25974           required: true
25975           type: string
25976           example: __INTERFACE-NAME__
25977         - name: interface-name
25978           in: path
25979           description: Name given to the interface
25980           required: true
25981           type: string
25982           example: __INTERFACE-NAME__
25983         - name: vlan-interface
25984           in: path
25985           description: String that identifies the interface
25986           required: true
25987           type: string
25988           example: __VLAN-INTERFACE__
25989         - name: l3-interface-ipv6-address
25990           in: path
25991           description: IP address
25992           required: true
25993           type: string
25994           example: __L3-INTERFACE-IPV6-ADDRESS__
25995         - name: body
25996           in: body
25997           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25998           required: true
25999           schema:
26000             $ref: "#/definitions/relationship"
26001     delete:
26002       tags:
26003         - Network
26004       summary: delete an existing relationship
26005       description: delete an existing relationship
26006       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
26007       consumes:
26008         - application/json
26009         - application/xml
26010       produces:
26011         - application/json
26012         - application/xml
26013       responses:
26014         "default":
26015           description: Response codes found in [response codes](https://wiki.onap.org/).
26016       parameters:
26017         - name: equipment-name
26018           in: path
26019           required: true
26020           type: string
26021           example: __EQUIPMENT-NAME__
26022         - name: interface-name
26023           in: path
26024           description: Name that identifies the physical interface
26025           required: true
26026           type: string
26027           example: __INTERFACE-NAME__
26028         - name: interface-name
26029           in: path
26030           description: Name given to the interface
26031           required: true
26032           type: string
26033           example: __INTERFACE-NAME__
26034         - name: vlan-interface
26035           in: path
26036           description: String that identifies the interface
26037           required: true
26038           type: string
26039           example: __VLAN-INTERFACE__
26040         - name: l3-interface-ipv6-address
26041           in: path
26042           description: IP address
26043           required: true
26044           type: string
26045           example: __L3-INTERFACE-IPV6-ADDRESS__
26046   /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}:
26047     get:
26048       tags:
26049         - Network
26050       summary: returns l3-interface-ipv6-address-list
26051       description: returns l3-interface-ipv6-address-list
26052       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26053       produces:
26054         - application/json
26055         - application/xml
26056       responses:
26057         "200":
26058           description: successful operation
26059           schema:
26060               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26061         "default":
26062           description: Response codes found in [response codes](https://wiki.onap.org/).
26063       parameters:
26064         - name: equipment-name
26065           in: path
26066           required: true
26067           type: string
26068           example: __EQUIPMENT-NAME__
26069         - name: interface-name
26070           in: path
26071           description: Name that identifies the physical interface
26072           required: true
26073           type: string
26074           example: __INTERFACE-NAME__
26075         - name: interface-name
26076           in: path
26077           description: Name given to the interface
26078           required: true
26079           type: string
26080           example: __INTERFACE-NAME__
26081         - name: vlan-interface
26082           in: path
26083           description: String that identifies the interface
26084           required: true
26085           type: string
26086           example: __VLAN-INTERFACE__
26087         - name: l3-interface-ipv6-address
26088           in: path
26089           description: IP address
26090           required: true
26091           type: string
26092           example: __L3-INTERFACE-IPV6-ADDRESS__
26093         - name: prov-status
26094           in: query
26095           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26096           required: false
26097           type: string
26098         - name: prov-status
26099           in: query
26100           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26101           required: false
26102           type: string
26103         - name: interface-id
26104           in: query
26105           description: ID of interface
26106           required: false
26107           type: string
26108         - name: macaddr
26109           in: query
26110           description: MAC address for the interface
26111           required: false
26112           type: string
26113         - name: network-name
26114           in: query
26115           description: Name of the network
26116           required: false
26117           type: string
26118         - name: vlan-id-inner
26119           in: query
26120           description: Inner VLAN tag
26121           required: false
26122           type: integer
26123           format: int64
26124         - name: vpn-key
26125           in: query
26126           description: This indicates the customers VPN ID associated with this vlan
26127           required: false
26128           type: string
26129         - name: vlan-id-inner
26130           in: query
26131           description: Inner VLAN tag
26132           required: false
26133           type: integer
26134           format: int64
26135         - name: neutron-network-id
26136           in: query
26137           description: Neutron network id of the interface that address belongs to
26138           required: false
26139           type: string
26140         - name: neutron-subnet-id
26141           in: query
26142           description: Neutron id of subnet that address belongs to
26143           required: false
26144           type: string
26145     put:
26146       tags:
26147         - Network
26148       summary: create or update an existing l3-interface-ipv6-address-list
26149       description: |
26150         Create or update an existing l3-interface-ipv6-address-list.
26151         #
26152         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26153       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26154       consumes:
26155         - application/json
26156         - application/xml
26157       produces:
26158         - application/json
26159         - application/xml
26160       responses:
26161         "default":
26162           description: Response codes found in [response codes](https://wiki.onap.org/).
26163       parameters:
26164         - name: equipment-name
26165           in: path
26166           required: true
26167           type: string
26168           example: __EQUIPMENT-NAME__
26169         - name: interface-name
26170           in: path
26171           description: Name that identifies the physical interface
26172           required: true
26173           type: string
26174           example: __INTERFACE-NAME__
26175         - name: interface-name
26176           in: path
26177           description: Name given to the interface
26178           required: true
26179           type: string
26180           example: __INTERFACE-NAME__
26181         - name: vlan-interface
26182           in: path
26183           description: String that identifies the interface
26184           required: true
26185           type: string
26186           example: __VLAN-INTERFACE__
26187         - name: l3-interface-ipv6-address
26188           in: path
26189           description: IP address
26190           required: true
26191           type: string
26192           example: __L3-INTERFACE-IPV6-ADDRESS__
26193         - name: body
26194           in: body
26195           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
26196           required: true
26197           schema:
26198             $ref: "#/definitions/l3-interface-ipv6-address-list"
26199     patch:
26200       tags:
26201         - Network
26202       summary: update an existing l3-interface-ipv6-address-list
26203       description: |
26204         Update an existing l3-interface-ipv6-address-list
26205         #
26206         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26207         The PUT operation will entirely replace an existing object.
26208         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26209         #
26210         Other differences between PUT and PATCH are:
26211         #
26212         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26213         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26214         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26215       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26216       consumes:
26217         - application/json
26218         - application/xml
26219       produces:
26220         - application/json
26221         - application/xml
26222       responses:
26223         "default":
26224           description: Response codes found in [response codes](https://wiki.onap.org/).
26225       parameters:
26226         - name: equipment-name
26227           in: path
26228           required: true
26229           type: string
26230           example: __EQUIPMENT-NAME__
26231         - name: interface-name
26232           in: path
26233           description: Name that identifies the physical interface
26234           required: true
26235           type: string
26236           example: __INTERFACE-NAME__
26237         - name: interface-name
26238           in: path
26239           description: Name given to the interface
26240           required: true
26241           type: string
26242           example: __INTERFACE-NAME__
26243         - name: vlan-interface
26244           in: path
26245           description: String that identifies the interface
26246           required: true
26247           type: string
26248           example: __VLAN-INTERFACE__
26249         - name: l3-interface-ipv6-address
26250           in: path
26251           description: IP address
26252           required: true
26253           type: string
26254           example: __L3-INTERFACE-IPV6-ADDRESS__
26255         - name: body
26256           in: body
26257           description: l3-interface-ipv6-address-list object that needs to be created or updated.
26258           required: true
26259           schema:
26260             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26261     delete:
26262       tags:
26263         - Network
26264       summary: delete an existing l3-interface-ipv6-address-list
26265       description: delete an existing l3-interface-ipv6-address-list
26266       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26267       consumes:
26268         - application/json
26269         - application/xml
26270       produces:
26271         - application/json
26272         - application/xml
26273       responses:
26274         "default":
26275           description: Response codes found in [response codes](https://wiki.onap.org/).
26276       parameters:
26277         - name: equipment-name
26278           in: path
26279           required: true
26280           type: string
26281           example: __EQUIPMENT-NAME__
26282         - name: interface-name
26283           in: path
26284           description: Name that identifies the physical interface
26285           required: true
26286           type: string
26287           example: __INTERFACE-NAME__
26288         - name: interface-name
26289           in: path
26290           description: Name given to the interface
26291           required: true
26292           type: string
26293           example: __INTERFACE-NAME__
26294         - name: vlan-interface
26295           in: path
26296           description: String that identifies the interface
26297           required: true
26298           type: string
26299           example: __VLAN-INTERFACE__
26300         - name: l3-interface-ipv6-address
26301           in: path
26302           description: IP address
26303           required: true
26304           type: string
26305           example: __L3-INTERFACE-IPV6-ADDRESS__
26306         - name: resource-version
26307           in: query
26308           description: resource-version for concurrency
26309           required: true
26310           type: string
26311   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
26312     get:
26313       tags:
26314         - Network
26315       summary: returns vlan
26316       description: returns vlan
26317       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26318       produces:
26319         - application/json
26320         - application/xml
26321       responses:
26322         "200":
26323           description: successful operation
26324           schema:
26325               $ref: "#/getDefinitions/vlan"
26326         "default":
26327           description: Response codes found in [response codes](https://wiki.onap.org/).
26328       parameters:
26329         - name: equipment-name
26330           in: path
26331           required: true
26332           type: string
26333           example: __EQUIPMENT-NAME__
26334         - name: interface-name
26335           in: path
26336           description: Name that identifies the physical interface
26337           required: true
26338           type: string
26339           example: __INTERFACE-NAME__
26340         - name: interface-name
26341           in: path
26342           description: Name given to the interface
26343           required: true
26344           type: string
26345           example: __INTERFACE-NAME__
26346         - name: vlan-interface
26347           in: path
26348           description: String that identifies the interface
26349           required: true
26350           type: string
26351           example: __VLAN-INTERFACE__
26352         - name: prov-status
26353           in: query
26354           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26355           required: false
26356           type: string
26357         - name: prov-status
26358           in: query
26359           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26360           required: false
26361           type: string
26362         - name: interface-id
26363           in: query
26364           description: ID of interface
26365           required: false
26366           type: string
26367         - name: macaddr
26368           in: query
26369           description: MAC address for the interface
26370           required: false
26371           type: string
26372         - name: network-name
26373           in: query
26374           description: Name of the network
26375           required: false
26376           type: string
26377         - name: vlan-id-inner
26378           in: query
26379           description: Inner VLAN tag
26380           required: false
26381           type: integer
26382           format: int64
26383         - name: vpn-key
26384           in: query
26385           description: This indicates the customers VPN ID associated with this vlan
26386           required: false
26387           type: string
26388     put:
26389       tags:
26390         - Network
26391       summary: create or update an existing vlan
26392       description: |
26393         Create or update an existing vlan.
26394         #
26395         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26396       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26397       consumes:
26398         - application/json
26399         - application/xml
26400       produces:
26401         - application/json
26402         - application/xml
26403       responses:
26404         "default":
26405           description: Response codes found in [response codes](https://wiki.onap.org/).
26406       parameters:
26407         - name: equipment-name
26408           in: path
26409           required: true
26410           type: string
26411           example: __EQUIPMENT-NAME__
26412         - name: interface-name
26413           in: path
26414           description: Name that identifies the physical interface
26415           required: true
26416           type: string
26417           example: __INTERFACE-NAME__
26418         - name: interface-name
26419           in: path
26420           description: Name given to the interface
26421           required: true
26422           type: string
26423           example: __INTERFACE-NAME__
26424         - name: vlan-interface
26425           in: path
26426           description: String that identifies the interface
26427           required: true
26428           type: string
26429           example: __VLAN-INTERFACE__
26430         - name: body
26431           in: body
26432           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
26433           required: true
26434           schema:
26435             $ref: "#/definitions/vlan"
26436     patch:
26437       tags:
26438         - Network
26439       summary: update an existing vlan
26440       description: |
26441         Update an existing vlan
26442         #
26443         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26444         The PUT operation will entirely replace an existing object.
26445         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26446         #
26447         Other differences between PUT and PATCH are:
26448         #
26449         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26450         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26451         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26452       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26453       consumes:
26454         - application/json
26455         - application/xml
26456       produces:
26457         - application/json
26458         - application/xml
26459       responses:
26460         "default":
26461           description: Response codes found in [response codes](https://wiki.onap.org/).
26462       parameters:
26463         - name: equipment-name
26464           in: path
26465           required: true
26466           type: string
26467           example: __EQUIPMENT-NAME__
26468         - name: interface-name
26469           in: path
26470           description: Name that identifies the physical interface
26471           required: true
26472           type: string
26473           example: __INTERFACE-NAME__
26474         - name: interface-name
26475           in: path
26476           description: Name given to the interface
26477           required: true
26478           type: string
26479           example: __INTERFACE-NAME__
26480         - name: vlan-interface
26481           in: path
26482           description: String that identifies the interface
26483           required: true
26484           type: string
26485           example: __VLAN-INTERFACE__
26486         - name: body
26487           in: body
26488           description: vlan object that needs to be created or updated.
26489           required: true
26490           schema:
26491             $ref: "#/patchDefinitions/vlan"
26492     delete:
26493       tags:
26494         - Network
26495       summary: delete an existing vlan
26496       description: delete an existing vlan
26497       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26498       consumes:
26499         - application/json
26500         - application/xml
26501       produces:
26502         - application/json
26503         - application/xml
26504       responses:
26505         "default":
26506           description: Response codes found in [response codes](https://wiki.onap.org/).
26507       parameters:
26508         - name: equipment-name
26509           in: path
26510           required: true
26511           type: string
26512           example: __EQUIPMENT-NAME__
26513         - name: interface-name
26514           in: path
26515           description: Name that identifies the physical interface
26516           required: true
26517           type: string
26518           example: __INTERFACE-NAME__
26519         - name: interface-name
26520           in: path
26521           description: Name given to the interface
26522           required: true
26523           type: string
26524           example: __INTERFACE-NAME__
26525         - name: vlan-interface
26526           in: path
26527           description: String that identifies the interface
26528           required: true
26529           type: string
26530           example: __VLAN-INTERFACE__
26531         - name: resource-version
26532           in: query
26533           description: resource-version for concurrency
26534           required: true
26535           type: string
26536   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
26537     get:
26538       tags:
26539         - Network
26540       summary: returns vlans
26541       description: returns vlans
26542       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
26543       produces:
26544         - application/json
26545         - application/xml
26546       responses:
26547         "200":
26548           description: successful operation
26549           schema:
26550               $ref: "#/getDefinitions/vlans"
26551         "default":
26552           description: Response codes found in [response codes](https://wiki.onap.org/).
26553       parameters:
26554         - name: equipment-name
26555           in: path
26556           required: true
26557           type: string
26558           example: __EQUIPMENT-NAME__
26559         - name: interface-name
26560           in: path
26561           description: Name that identifies the physical interface
26562           required: true
26563           type: string
26564           example: __INTERFACE-NAME__
26565         - name: interface-name
26566           in: path
26567           description: Name given to the interface
26568           required: true
26569           type: string
26570           example: __INTERFACE-NAME__
26571         - name: prov-status
26572           in: query
26573           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26574           required: false
26575           type: string
26576         - name: prov-status
26577           in: query
26578           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26579           required: false
26580           type: string
26581         - name: interface-id
26582           in: query
26583           description: ID of interface
26584           required: false
26585           type: string
26586         - name: macaddr
26587           in: query
26588           description: MAC address for the interface
26589           required: false
26590           type: string
26591         - name: network-name
26592           in: query
26593           description: Name of the network
26594           required: false
26595           type: string
26596   /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:
26597     put:
26598       tags:
26599         - Network
26600       summary: see node definition for valid relationships
26601       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26602       consumes:
26603         - application/json
26604         - application/xml
26605       produces:
26606         - application/json
26607         - application/xml
26608       responses:
26609         "default":
26610           description: Response codes found in [response codes](https://wiki.onap.org/).
26611       parameters:
26612         - name: equipment-name
26613           in: path
26614           required: true
26615           type: string
26616           example: __EQUIPMENT-NAME__
26617         - name: interface-name
26618           in: path
26619           description: Name that identifies the physical interface
26620           required: true
26621           type: string
26622           example: __INTERFACE-NAME__
26623         - name: interface-name
26624           in: path
26625           description: Name given to the interface
26626           required: true
26627           type: string
26628           example: __INTERFACE-NAME__
26629         - name: pci-id
26630           in: path
26631           description: PCI ID used to identify the sriov-vf
26632           required: true
26633           type: string
26634           example: __PCI-ID__
26635         - name: body
26636           in: body
26637           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26638           required: true
26639           schema:
26640             $ref: "#/definitions/relationship"
26641     delete:
26642       tags:
26643         - Network
26644       summary: delete an existing relationship
26645       description: delete an existing relationship
26646       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26647       consumes:
26648         - application/json
26649         - application/xml
26650       produces:
26651         - application/json
26652         - application/xml
26653       responses:
26654         "default":
26655           description: Response codes found in [response codes](https://wiki.onap.org/).
26656       parameters:
26657         - name: equipment-name
26658           in: path
26659           required: true
26660           type: string
26661           example: __EQUIPMENT-NAME__
26662         - name: interface-name
26663           in: path
26664           description: Name that identifies the physical interface
26665           required: true
26666           type: string
26667           example: __INTERFACE-NAME__
26668         - name: interface-name
26669           in: path
26670           description: Name given to the interface
26671           required: true
26672           type: string
26673           example: __INTERFACE-NAME__
26674         - name: pci-id
26675           in: path
26676           description: PCI ID used to identify the sriov-vf
26677           required: true
26678           type: string
26679           example: __PCI-ID__
26680   /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}:
26681     get:
26682       tags:
26683         - Network
26684       summary: returns sriov-vf
26685       description: returns sriov-vf
26686       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26687       produces:
26688         - application/json
26689         - application/xml
26690       responses:
26691         "200":
26692           description: successful operation
26693           schema:
26694               $ref: "#/getDefinitions/sriov-vf"
26695         "default":
26696           description: Response codes found in [response codes](https://wiki.onap.org/).
26697       parameters:
26698         - name: equipment-name
26699           in: path
26700           required: true
26701           type: string
26702           example: __EQUIPMENT-NAME__
26703         - name: interface-name
26704           in: path
26705           description: Name that identifies the physical interface
26706           required: true
26707           type: string
26708           example: __INTERFACE-NAME__
26709         - name: interface-name
26710           in: path
26711           description: Name given to the interface
26712           required: true
26713           type: string
26714           example: __INTERFACE-NAME__
26715         - name: pci-id
26716           in: path
26717           description: PCI ID used to identify the sriov-vf
26718           required: true
26719           type: string
26720           example: __PCI-ID__
26721         - name: prov-status
26722           in: query
26723           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26724           required: false
26725           type: string
26726         - name: prov-status
26727           in: query
26728           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26729           required: false
26730           type: string
26731         - name: interface-id
26732           in: query
26733           description: ID of interface
26734           required: false
26735           type: string
26736         - name: macaddr
26737           in: query
26738           description: MAC address for the interface
26739           required: false
26740           type: string
26741         - name: network-name
26742           in: query
26743           description: Name of the network
26744           required: false
26745           type: string
26746         - name: vf-vlan-filter
26747           in: query
26748           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
26749           required: false
26750           type: string
26751         - name: vf-mac-filter
26752           in: query
26753           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
26754           required: false
26755           type: string
26756         - name: vf-vlan-strip
26757           in: query
26758           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
26759           required: false
26760           type: boolean
26761         - name: neutron-network-id
26762           in: query
26763           description: Neutron network id of the interface
26764           required: false
26765           type: string
26766     put:
26767       tags:
26768         - Network
26769       summary: create or update an existing sriov-vf
26770       description: |
26771         Create or update an existing sriov-vf.
26772         #
26773         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26774       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26775       consumes:
26776         - application/json
26777         - application/xml
26778       produces:
26779         - application/json
26780         - application/xml
26781       responses:
26782         "default":
26783           description: Response codes found in [response codes](https://wiki.onap.org/).
26784       parameters:
26785         - name: equipment-name
26786           in: path
26787           required: true
26788           type: string
26789           example: __EQUIPMENT-NAME__
26790         - name: interface-name
26791           in: path
26792           description: Name that identifies the physical interface
26793           required: true
26794           type: string
26795           example: __INTERFACE-NAME__
26796         - name: interface-name
26797           in: path
26798           description: Name given to the interface
26799           required: true
26800           type: string
26801           example: __INTERFACE-NAME__
26802         - name: pci-id
26803           in: path
26804           description: PCI ID used to identify the sriov-vf
26805           required: true
26806           type: string
26807           example: __PCI-ID__
26808         - name: body
26809           in: body
26810           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26811           required: true
26812           schema:
26813             $ref: "#/definitions/sriov-vf"
26814     patch:
26815       tags:
26816         - Network
26817       summary: update an existing sriov-vf
26818       description: |
26819         Update an existing sriov-vf
26820         #
26821         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26822         The PUT operation will entirely replace an existing object.
26823         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26824         #
26825         Other differences between PUT and PATCH are:
26826         #
26827         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26828         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26829         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26830       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26831       consumes:
26832         - application/json
26833         - application/xml
26834       produces:
26835         - application/json
26836         - application/xml
26837       responses:
26838         "default":
26839           description: Response codes found in [response codes](https://wiki.onap.org/).
26840       parameters:
26841         - name: equipment-name
26842           in: path
26843           required: true
26844           type: string
26845           example: __EQUIPMENT-NAME__
26846         - name: interface-name
26847           in: path
26848           description: Name that identifies the physical interface
26849           required: true
26850           type: string
26851           example: __INTERFACE-NAME__
26852         - name: interface-name
26853           in: path
26854           description: Name given to the interface
26855           required: true
26856           type: string
26857           example: __INTERFACE-NAME__
26858         - name: pci-id
26859           in: path
26860           description: PCI ID used to identify the sriov-vf
26861           required: true
26862           type: string
26863           example: __PCI-ID__
26864         - name: body
26865           in: body
26866           description: sriov-vf object that needs to be created or updated.
26867           required: true
26868           schema:
26869             $ref: "#/patchDefinitions/sriov-vf"
26870     delete:
26871       tags:
26872         - Network
26873       summary: delete an existing sriov-vf
26874       description: delete an existing sriov-vf
26875       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26876       consumes:
26877         - application/json
26878         - application/xml
26879       produces:
26880         - application/json
26881         - application/xml
26882       responses:
26883         "default":
26884           description: Response codes found in [response codes](https://wiki.onap.org/).
26885       parameters:
26886         - name: equipment-name
26887           in: path
26888           required: true
26889           type: string
26890           example: __EQUIPMENT-NAME__
26891         - name: interface-name
26892           in: path
26893           description: Name that identifies the physical interface
26894           required: true
26895           type: string
26896           example: __INTERFACE-NAME__
26897         - name: interface-name
26898           in: path
26899           description: Name given to the interface
26900           required: true
26901           type: string
26902           example: __INTERFACE-NAME__
26903         - name: pci-id
26904           in: path
26905           description: PCI ID used to identify the sriov-vf
26906           required: true
26907           type: string
26908           example: __PCI-ID__
26909         - name: resource-version
26910           in: query
26911           description: resource-version for concurrency
26912           required: true
26913           type: string
26914   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26915     get:
26916       tags:
26917         - Network
26918       summary: returns sriov-vfs
26919       description: returns sriov-vfs
26920       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
26921       produces:
26922         - application/json
26923         - application/xml
26924       responses:
26925         "200":
26926           description: successful operation
26927           schema:
26928               $ref: "#/getDefinitions/sriov-vfs"
26929         "default":
26930           description: Response codes found in [response codes](https://wiki.onap.org/).
26931       parameters:
26932         - name: equipment-name
26933           in: path
26934           required: true
26935           type: string
26936           example: __EQUIPMENT-NAME__
26937         - name: interface-name
26938           in: path
26939           description: Name that identifies the physical interface
26940           required: true
26941           type: string
26942           example: __INTERFACE-NAME__
26943         - name: interface-name
26944           in: path
26945           description: Name given to the interface
26946           required: true
26947           type: string
26948           example: __INTERFACE-NAME__
26949         - name: prov-status
26950           in: query
26951           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26952           required: false
26953           type: string
26954         - name: prov-status
26955           in: query
26956           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26957           required: false
26958           type: string
26959         - name: interface-id
26960           in: query
26961           description: ID of interface
26962           required: false
26963           type: string
26964         - name: macaddr
26965           in: query
26966           description: MAC address for the interface
26967           required: false
26968           type: string
26969         - name: network-name
26970           in: query
26971           description: Name of the network
26972           required: false
26973           type: string
26974   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26975     put:
26976       tags:
26977         - Network
26978       summary: see node definition for valid relationships
26979       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
26980       consumes:
26981         - application/json
26982         - application/xml
26983       produces:
26984         - application/json
26985         - application/xml
26986       responses:
26987         "default":
26988           description: Response codes found in [response codes](https://wiki.onap.org/).
26989       parameters:
26990         - name: equipment-name
26991           in: path
26992           required: true
26993           type: string
26994           example: __EQUIPMENT-NAME__
26995         - name: interface-name
26996           in: path
26997           description: Name that identifies the physical interface
26998           required: true
26999           type: string
27000           example: __INTERFACE-NAME__
27001         - name: interface-name
27002           in: path
27003           description: Name given to the interface
27004           required: true
27005           type: string
27006           example: __INTERFACE-NAME__
27007         - name: body
27008           in: body
27009           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
27010           required: true
27011           schema:
27012             $ref: "#/definitions/relationship"
27013     delete:
27014       tags:
27015         - Network
27016       summary: delete an existing relationship
27017       description: delete an existing relationship
27018       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
27019       consumes:
27020         - application/json
27021         - application/xml
27022       produces:
27023         - application/json
27024         - application/xml
27025       responses:
27026         "default":
27027           description: Response codes found in [response codes](https://wiki.onap.org/).
27028       parameters:
27029         - name: equipment-name
27030           in: path
27031           required: true
27032           type: string
27033           example: __EQUIPMENT-NAME__
27034         - name: interface-name
27035           in: path
27036           description: Name that identifies the physical interface
27037           required: true
27038           type: string
27039           example: __INTERFACE-NAME__
27040         - name: interface-name
27041           in: path
27042           description: Name given to the interface
27043           required: true
27044           type: string
27045           example: __INTERFACE-NAME__
27046   /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:
27047     put:
27048       tags:
27049         - Network
27050       summary: see node definition for valid relationships
27051       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
27052       consumes:
27053         - application/json
27054         - application/xml
27055       produces:
27056         - application/json
27057         - application/xml
27058       responses:
27059         "default":
27060           description: Response codes found in [response codes](https://wiki.onap.org/).
27061       parameters:
27062         - name: equipment-name
27063           in: path
27064           required: true
27065           type: string
27066           example: __EQUIPMENT-NAME__
27067         - name: interface-name
27068           in: path
27069           description: Name that identifies the physical interface
27070           required: true
27071           type: string
27072           example: __INTERFACE-NAME__
27073         - name: interface-name
27074           in: path
27075           description: Name given to the interface
27076           required: true
27077           type: string
27078           example: __INTERFACE-NAME__
27079         - name: l3-interface-ipv4-address
27080           in: path
27081           description: IP address
27082           required: true
27083           type: string
27084           example: __L3-INTERFACE-IPV4-ADDRESS__
27085         - name: body
27086           in: body
27087           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
27088           required: true
27089           schema:
27090             $ref: "#/definitions/relationship"
27091     delete:
27092       tags:
27093         - Network
27094       summary: delete an existing relationship
27095       description: delete an existing relationship
27096       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
27097       consumes:
27098         - application/json
27099         - application/xml
27100       produces:
27101         - application/json
27102         - application/xml
27103       responses:
27104         "default":
27105           description: Response codes found in [response codes](https://wiki.onap.org/).
27106       parameters:
27107         - name: equipment-name
27108           in: path
27109           required: true
27110           type: string
27111           example: __EQUIPMENT-NAME__
27112         - name: interface-name
27113           in: path
27114           description: Name that identifies the physical interface
27115           required: true
27116           type: string
27117           example: __INTERFACE-NAME__
27118         - name: interface-name
27119           in: path
27120           description: Name given to the interface
27121           required: true
27122           type: string
27123           example: __INTERFACE-NAME__
27124         - name: l3-interface-ipv4-address
27125           in: path
27126           description: IP address
27127           required: true
27128           type: string
27129           example: __L3-INTERFACE-IPV4-ADDRESS__
27130   /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}:
27131     get:
27132       tags:
27133         - Network
27134       summary: returns l3-interface-ipv4-address-list
27135       description: returns l3-interface-ipv4-address-list
27136       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27137       produces:
27138         - application/json
27139         - application/xml
27140       responses:
27141         "200":
27142           description: successful operation
27143           schema:
27144               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27145         "default":
27146           description: Response codes found in [response codes](https://wiki.onap.org/).
27147       parameters:
27148         - name: equipment-name
27149           in: path
27150           required: true
27151           type: string
27152           example: __EQUIPMENT-NAME__
27153         - name: interface-name
27154           in: path
27155           description: Name that identifies the physical interface
27156           required: true
27157           type: string
27158           example: __INTERFACE-NAME__
27159         - name: interface-name
27160           in: path
27161           description: Name given to the interface
27162           required: true
27163           type: string
27164           example: __INTERFACE-NAME__
27165         - name: l3-interface-ipv4-address
27166           in: path
27167           description: IP address
27168           required: true
27169           type: string
27170           example: __L3-INTERFACE-IPV4-ADDRESS__
27171         - name: prov-status
27172           in: query
27173           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27174           required: false
27175           type: string
27176         - name: prov-status
27177           in: query
27178           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27179           required: false
27180           type: string
27181         - name: interface-id
27182           in: query
27183           description: ID of interface
27184           required: false
27185           type: string
27186         - name: macaddr
27187           in: query
27188           description: MAC address for the interface
27189           required: false
27190           type: string
27191         - name: network-name
27192           in: query
27193           description: Name of the network
27194           required: false
27195           type: string
27196         - name: vlan-id-inner
27197           in: query
27198           description: Inner VLAN tag
27199           required: false
27200           type: integer
27201           format: int64
27202         - name: neutron-network-id
27203           in: query
27204           description: Neutron network id of the interface that address belongs to
27205           required: false
27206           type: string
27207         - name: neutron-subnet-id
27208           in: query
27209           description: Neutron id of subnet that address belongs to
27210           required: false
27211           type: string
27212     put:
27213       tags:
27214         - Network
27215       summary: create or update an existing l3-interface-ipv4-address-list
27216       description: |
27217         Create or update an existing l3-interface-ipv4-address-list.
27218         #
27219         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27220       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27221       consumes:
27222         - application/json
27223         - application/xml
27224       produces:
27225         - application/json
27226         - application/xml
27227       responses:
27228         "default":
27229           description: Response codes found in [response codes](https://wiki.onap.org/).
27230       parameters:
27231         - name: equipment-name
27232           in: path
27233           required: true
27234           type: string
27235           example: __EQUIPMENT-NAME__
27236         - name: interface-name
27237           in: path
27238           description: Name that identifies the physical interface
27239           required: true
27240           type: string
27241           example: __INTERFACE-NAME__
27242         - name: interface-name
27243           in: path
27244           description: Name given to the interface
27245           required: true
27246           type: string
27247           example: __INTERFACE-NAME__
27248         - name: l3-interface-ipv4-address
27249           in: path
27250           description: IP address
27251           required: true
27252           type: string
27253           example: __L3-INTERFACE-IPV4-ADDRESS__
27254         - name: body
27255           in: body
27256           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
27257           required: true
27258           schema:
27259             $ref: "#/definitions/l3-interface-ipv4-address-list"
27260     patch:
27261       tags:
27262         - Network
27263       summary: update an existing l3-interface-ipv4-address-list
27264       description: |
27265         Update an existing l3-interface-ipv4-address-list
27266         #
27267         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27268         The PUT operation will entirely replace an existing object.
27269         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27270         #
27271         Other differences between PUT and PATCH are:
27272         #
27273         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27274         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27275         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27276       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27277       consumes:
27278         - application/json
27279         - application/xml
27280       produces:
27281         - application/json
27282         - application/xml
27283       responses:
27284         "default":
27285           description: Response codes found in [response codes](https://wiki.onap.org/).
27286       parameters:
27287         - name: equipment-name
27288           in: path
27289           required: true
27290           type: string
27291           example: __EQUIPMENT-NAME__
27292         - name: interface-name
27293           in: path
27294           description: Name that identifies the physical interface
27295           required: true
27296           type: string
27297           example: __INTERFACE-NAME__
27298         - name: interface-name
27299           in: path
27300           description: Name given to the interface
27301           required: true
27302           type: string
27303           example: __INTERFACE-NAME__
27304         - name: l3-interface-ipv4-address
27305           in: path
27306           description: IP address
27307           required: true
27308           type: string
27309           example: __L3-INTERFACE-IPV4-ADDRESS__
27310         - name: body
27311           in: body
27312           description: l3-interface-ipv4-address-list object that needs to be created or updated.
27313           required: true
27314           schema:
27315             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27316     delete:
27317       tags:
27318         - Network
27319       summary: delete an existing l3-interface-ipv4-address-list
27320       description: delete an existing l3-interface-ipv4-address-list
27321       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27322       consumes:
27323         - application/json
27324         - application/xml
27325       produces:
27326         - application/json
27327         - application/xml
27328       responses:
27329         "default":
27330           description: Response codes found in [response codes](https://wiki.onap.org/).
27331       parameters:
27332         - name: equipment-name
27333           in: path
27334           required: true
27335           type: string
27336           example: __EQUIPMENT-NAME__
27337         - name: interface-name
27338           in: path
27339           description: Name that identifies the physical interface
27340           required: true
27341           type: string
27342           example: __INTERFACE-NAME__
27343         - name: interface-name
27344           in: path
27345           description: Name given to the interface
27346           required: true
27347           type: string
27348           example: __INTERFACE-NAME__
27349         - name: l3-interface-ipv4-address
27350           in: path
27351           description: IP address
27352           required: true
27353           type: string
27354           example: __L3-INTERFACE-IPV4-ADDRESS__
27355         - name: resource-version
27356           in: query
27357           description: resource-version for concurrency
27358           required: true
27359           type: string
27360   /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:
27361     put:
27362       tags:
27363         - Network
27364       summary: see node definition for valid relationships
27365       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27366       consumes:
27367         - application/json
27368         - application/xml
27369       produces:
27370         - application/json
27371         - application/xml
27372       responses:
27373         "default":
27374           description: Response codes found in [response codes](https://wiki.onap.org/).
27375       parameters:
27376         - name: equipment-name
27377           in: path
27378           required: true
27379           type: string
27380           example: __EQUIPMENT-NAME__
27381         - name: interface-name
27382           in: path
27383           description: Name that identifies the physical interface
27384           required: true
27385           type: string
27386           example: __INTERFACE-NAME__
27387         - name: interface-name
27388           in: path
27389           description: Name given to the interface
27390           required: true
27391           type: string
27392           example: __INTERFACE-NAME__
27393         - name: l3-interface-ipv6-address
27394           in: path
27395           description: IP address
27396           required: true
27397           type: string
27398           example: __L3-INTERFACE-IPV6-ADDRESS__
27399         - name: body
27400           in: body
27401           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27402           required: true
27403           schema:
27404             $ref: "#/definitions/relationship"
27405     delete:
27406       tags:
27407         - Network
27408       summary: delete an existing relationship
27409       description: delete an existing relationship
27410       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27411       consumes:
27412         - application/json
27413         - application/xml
27414       produces:
27415         - application/json
27416         - application/xml
27417       responses:
27418         "default":
27419           description: Response codes found in [response codes](https://wiki.onap.org/).
27420       parameters:
27421         - name: equipment-name
27422           in: path
27423           required: true
27424           type: string
27425           example: __EQUIPMENT-NAME__
27426         - name: interface-name
27427           in: path
27428           description: Name that identifies the physical interface
27429           required: true
27430           type: string
27431           example: __INTERFACE-NAME__
27432         - name: interface-name
27433           in: path
27434           description: Name given to the interface
27435           required: true
27436           type: string
27437           example: __INTERFACE-NAME__
27438         - name: l3-interface-ipv6-address
27439           in: path
27440           description: IP address
27441           required: true
27442           type: string
27443           example: __L3-INTERFACE-IPV6-ADDRESS__
27444   /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}:
27445     get:
27446       tags:
27447         - Network
27448       summary: returns l3-interface-ipv6-address-list
27449       description: returns l3-interface-ipv6-address-list
27450       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27451       produces:
27452         - application/json
27453         - application/xml
27454       responses:
27455         "200":
27456           description: successful operation
27457           schema:
27458               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27459         "default":
27460           description: Response codes found in [response codes](https://wiki.onap.org/).
27461       parameters:
27462         - name: equipment-name
27463           in: path
27464           required: true
27465           type: string
27466           example: __EQUIPMENT-NAME__
27467         - name: interface-name
27468           in: path
27469           description: Name that identifies the physical interface
27470           required: true
27471           type: string
27472           example: __INTERFACE-NAME__
27473         - name: interface-name
27474           in: path
27475           description: Name given to the interface
27476           required: true
27477           type: string
27478           example: __INTERFACE-NAME__
27479         - name: l3-interface-ipv6-address
27480           in: path
27481           description: IP address
27482           required: true
27483           type: string
27484           example: __L3-INTERFACE-IPV6-ADDRESS__
27485         - name: prov-status
27486           in: query
27487           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27488           required: false
27489           type: string
27490         - name: prov-status
27491           in: query
27492           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27493           required: false
27494           type: string
27495         - name: interface-id
27496           in: query
27497           description: ID of interface
27498           required: false
27499           type: string
27500         - name: macaddr
27501           in: query
27502           description: MAC address for the interface
27503           required: false
27504           type: string
27505         - name: network-name
27506           in: query
27507           description: Name of the network
27508           required: false
27509           type: string
27510         - name: vlan-id-inner
27511           in: query
27512           description: Inner VLAN tag
27513           required: false
27514           type: integer
27515           format: int64
27516         - name: neutron-network-id
27517           in: query
27518           description: Neutron network id of the interface that address belongs to
27519           required: false
27520           type: string
27521         - name: neutron-subnet-id
27522           in: query
27523           description: Neutron id of subnet that address belongs to
27524           required: false
27525           type: string
27526     put:
27527       tags:
27528         - Network
27529       summary: create or update an existing l3-interface-ipv6-address-list
27530       description: |
27531         Create or update an existing l3-interface-ipv6-address-list.
27532         #
27533         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27534       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27535       consumes:
27536         - application/json
27537         - application/xml
27538       produces:
27539         - application/json
27540         - application/xml
27541       responses:
27542         "default":
27543           description: Response codes found in [response codes](https://wiki.onap.org/).
27544       parameters:
27545         - name: equipment-name
27546           in: path
27547           required: true
27548           type: string
27549           example: __EQUIPMENT-NAME__
27550         - name: interface-name
27551           in: path
27552           description: Name that identifies the physical interface
27553           required: true
27554           type: string
27555           example: __INTERFACE-NAME__
27556         - name: interface-name
27557           in: path
27558           description: Name given to the interface
27559           required: true
27560           type: string
27561           example: __INTERFACE-NAME__
27562         - name: l3-interface-ipv6-address
27563           in: path
27564           description: IP address
27565           required: true
27566           type: string
27567           example: __L3-INTERFACE-IPV6-ADDRESS__
27568         - name: body
27569           in: body
27570           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27571           required: true
27572           schema:
27573             $ref: "#/definitions/l3-interface-ipv6-address-list"
27574     patch:
27575       tags:
27576         - Network
27577       summary: update an existing l3-interface-ipv6-address-list
27578       description: |
27579         Update an existing l3-interface-ipv6-address-list
27580         #
27581         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27582         The PUT operation will entirely replace an existing object.
27583         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27584         #
27585         Other differences between PUT and PATCH are:
27586         #
27587         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27588         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27589         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27590       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27591       consumes:
27592         - application/json
27593         - application/xml
27594       produces:
27595         - application/json
27596         - application/xml
27597       responses:
27598         "default":
27599           description: Response codes found in [response codes](https://wiki.onap.org/).
27600       parameters:
27601         - name: equipment-name
27602           in: path
27603           required: true
27604           type: string
27605           example: __EQUIPMENT-NAME__
27606         - name: interface-name
27607           in: path
27608           description: Name that identifies the physical interface
27609           required: true
27610           type: string
27611           example: __INTERFACE-NAME__
27612         - name: interface-name
27613           in: path
27614           description: Name given to the interface
27615           required: true
27616           type: string
27617           example: __INTERFACE-NAME__
27618         - name: l3-interface-ipv6-address
27619           in: path
27620           description: IP address
27621           required: true
27622           type: string
27623           example: __L3-INTERFACE-IPV6-ADDRESS__
27624         - name: body
27625           in: body
27626           description: l3-interface-ipv6-address-list object that needs to be created or updated.
27627           required: true
27628           schema:
27629             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27630     delete:
27631       tags:
27632         - Network
27633       summary: delete an existing l3-interface-ipv6-address-list
27634       description: delete an existing l3-interface-ipv6-address-list
27635       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27636       consumes:
27637         - application/json
27638         - application/xml
27639       produces:
27640         - application/json
27641         - application/xml
27642       responses:
27643         "default":
27644           description: Response codes found in [response codes](https://wiki.onap.org/).
27645       parameters:
27646         - name: equipment-name
27647           in: path
27648           required: true
27649           type: string
27650           example: __EQUIPMENT-NAME__
27651         - name: interface-name
27652           in: path
27653           description: Name that identifies the physical interface
27654           required: true
27655           type: string
27656           example: __INTERFACE-NAME__
27657         - name: interface-name
27658           in: path
27659           description: Name given to the interface
27660           required: true
27661           type: string
27662           example: __INTERFACE-NAME__
27663         - name: l3-interface-ipv6-address
27664           in: path
27665           description: IP address
27666           required: true
27667           type: string
27668           example: __L3-INTERFACE-IPV6-ADDRESS__
27669         - name: resource-version
27670           in: query
27671           description: resource-version for concurrency
27672           required: true
27673           type: string
27674   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
27675     get:
27676       tags:
27677         - Network
27678       summary: returns l-interface
27679       description: returns l-interface
27680       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27681       produces:
27682         - application/json
27683         - application/xml
27684       responses:
27685         "200":
27686           description: successful operation
27687           schema:
27688               $ref: "#/getDefinitions/l-interface"
27689         "default":
27690           description: Response codes found in [response codes](https://wiki.onap.org/).
27691       parameters:
27692         - name: equipment-name
27693           in: path
27694           required: true
27695           type: string
27696           example: __EQUIPMENT-NAME__
27697         - name: interface-name
27698           in: path
27699           description: Name that identifies the physical interface
27700           required: true
27701           type: string
27702           example: __INTERFACE-NAME__
27703         - name: interface-name
27704           in: path
27705           description: Name given to the interface
27706           required: true
27707           type: string
27708           example: __INTERFACE-NAME__
27709         - name: prov-status
27710           in: query
27711           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27712           required: false
27713           type: string
27714         - name: prov-status
27715           in: query
27716           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27717           required: false
27718           type: string
27719         - name: interface-id
27720           in: query
27721           description: ID of interface
27722           required: false
27723           type: string
27724         - name: macaddr
27725           in: query
27726           description: MAC address for the interface
27727           required: false
27728           type: string
27729         - name: network-name
27730           in: query
27731           description: Name of the network
27732           required: false
27733           type: string
27734     put:
27735       tags:
27736         - Network
27737       summary: create or update an existing l-interface
27738       description: |
27739         Create or update an existing l-interface.
27740         #
27741         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27742       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27743       consumes:
27744         - application/json
27745         - application/xml
27746       produces:
27747         - application/json
27748         - application/xml
27749       responses:
27750         "default":
27751           description: Response codes found in [response codes](https://wiki.onap.org/).
27752       parameters:
27753         - name: equipment-name
27754           in: path
27755           required: true
27756           type: string
27757           example: __EQUIPMENT-NAME__
27758         - name: interface-name
27759           in: path
27760           description: Name that identifies the physical interface
27761           required: true
27762           type: string
27763           example: __INTERFACE-NAME__
27764         - name: interface-name
27765           in: path
27766           description: Name given to the interface
27767           required: true
27768           type: string
27769           example: __INTERFACE-NAME__
27770         - name: body
27771           in: body
27772           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
27773           required: true
27774           schema:
27775             $ref: "#/definitions/l-interface"
27776     patch:
27777       tags:
27778         - Network
27779       summary: update an existing l-interface
27780       description: |
27781         Update an existing l-interface
27782         #
27783         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27784         The PUT operation will entirely replace an existing object.
27785         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27786         #
27787         Other differences between PUT and PATCH are:
27788         #
27789         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27790         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27791         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27792       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27793       consumes:
27794         - application/json
27795         - application/xml
27796       produces:
27797         - application/json
27798         - application/xml
27799       responses:
27800         "default":
27801           description: Response codes found in [response codes](https://wiki.onap.org/).
27802       parameters:
27803         - name: equipment-name
27804           in: path
27805           required: true
27806           type: string
27807           example: __EQUIPMENT-NAME__
27808         - name: interface-name
27809           in: path
27810           description: Name that identifies the physical interface
27811           required: true
27812           type: string
27813           example: __INTERFACE-NAME__
27814         - name: interface-name
27815           in: path
27816           description: Name given to the interface
27817           required: true
27818           type: string
27819           example: __INTERFACE-NAME__
27820         - name: body
27821           in: body
27822           description: l-interface object that needs to be created or updated.
27823           required: true
27824           schema:
27825             $ref: "#/patchDefinitions/l-interface"
27826     delete:
27827       tags:
27828         - Network
27829       summary: delete an existing l-interface
27830       description: delete an existing l-interface
27831       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27832       consumes:
27833         - application/json
27834         - application/xml
27835       produces:
27836         - application/json
27837         - application/xml
27838       responses:
27839         "default":
27840           description: Response codes found in [response codes](https://wiki.onap.org/).
27841       parameters:
27842         - name: equipment-name
27843           in: path
27844           required: true
27845           type: string
27846           example: __EQUIPMENT-NAME__
27847         - name: interface-name
27848           in: path
27849           description: Name that identifies the physical interface
27850           required: true
27851           type: string
27852           example: __INTERFACE-NAME__
27853         - name: interface-name
27854           in: path
27855           description: Name given to the interface
27856           required: true
27857           type: string
27858           example: __INTERFACE-NAME__
27859         - name: resource-version
27860           in: query
27861           description: resource-version for concurrency
27862           required: true
27863           type: string
27864   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
27865     get:
27866       tags:
27867         - Network
27868       summary: returns l-interfaces
27869       description: returns l-interfaces
27870       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
27871       produces:
27872         - application/json
27873         - application/xml
27874       responses:
27875         "200":
27876           description: successful operation
27877           schema:
27878               $ref: "#/getDefinitions/l-interfaces"
27879         "default":
27880           description: Response codes found in [response codes](https://wiki.onap.org/).
27881       parameters:
27882         - name: equipment-name
27883           in: path
27884           required: true
27885           type: string
27886           example: __EQUIPMENT-NAME__
27887         - name: interface-name
27888           in: path
27889           description: Name that identifies the physical interface
27890           required: true
27891           type: string
27892           example: __INTERFACE-NAME__
27893         - name: prov-status
27894           in: query
27895           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27896           required: false
27897           type: string
27898         - name: prov-status
27899           in: query
27900           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27901           required: false
27902           type: string
27903   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
27904     get:
27905       tags:
27906         - Network
27907       summary: returns p-interface
27908       description: returns p-interface
27909       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
27910       produces:
27911         - application/json
27912         - application/xml
27913       responses:
27914         "200":
27915           description: successful operation
27916           schema:
27917               $ref: "#/getDefinitions/p-interface"
27918         "default":
27919           description: Response codes found in [response codes](https://wiki.onap.org/).
27920       parameters:
27921         - name: equipment-name
27922           in: path
27923           required: true
27924           type: string
27925           example: __EQUIPMENT-NAME__
27926         - name: interface-name
27927           in: path
27928           description: Name that identifies the physical interface
27929           required: true
27930           type: string
27931           example: __INTERFACE-NAME__
27932         - name: prov-status
27933           in: query
27934           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27935           required: false
27936           type: string
27937         - name: prov-status
27938           in: query
27939           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27940           required: false
27941           type: string
27942     put:
27943       tags:
27944         - Network
27945       summary: create or update an existing p-interface
27946       description: |
27947         Create or update an existing p-interface.
27948         #
27949         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27950       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
27951       consumes:
27952         - application/json
27953         - application/xml
27954       produces:
27955         - application/json
27956         - application/xml
27957       responses:
27958         "default":
27959           description: Response codes found in [response codes](https://wiki.onap.org/).
27960       parameters:
27961         - name: equipment-name
27962           in: path
27963           required: true
27964           type: string
27965           example: __EQUIPMENT-NAME__
27966         - name: interface-name
27967           in: path
27968           description: Name that identifies the physical interface
27969           required: true
27970           type: string
27971           example: __INTERFACE-NAME__
27972         - name: body
27973           in: body
27974           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
27975           required: true
27976           schema:
27977             $ref: "#/definitions/p-interface"
27978     patch:
27979       tags:
27980         - Network
27981       summary: update an existing p-interface
27982       description: |
27983         Update an existing p-interface
27984         #
27985         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27986         The PUT operation will entirely replace an existing object.
27987         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27988         #
27989         Other differences between PUT and PATCH are:
27990         #
27991         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27992         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27993         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27994       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
27995       consumes:
27996         - application/json
27997         - application/xml
27998       produces:
27999         - application/json
28000         - application/xml
28001       responses:
28002         "default":
28003           description: Response codes found in [response codes](https://wiki.onap.org/).
28004       parameters:
28005         - name: equipment-name
28006           in: path
28007           required: true
28008           type: string
28009           example: __EQUIPMENT-NAME__
28010         - name: interface-name
28011           in: path
28012           description: Name that identifies the physical interface
28013           required: true
28014           type: string
28015           example: __INTERFACE-NAME__
28016         - name: body
28017           in: body
28018           description: p-interface object that needs to be created or updated.
28019           required: true
28020           schema:
28021             $ref: "#/patchDefinitions/p-interface"
28022     delete:
28023       tags:
28024         - Network
28025       summary: delete an existing p-interface
28026       description: delete an existing p-interface
28027       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
28028       consumes:
28029         - application/json
28030         - application/xml
28031       produces:
28032         - application/json
28033         - application/xml
28034       responses:
28035         "default":
28036           description: Response codes found in [response codes](https://wiki.onap.org/).
28037       parameters:
28038         - name: equipment-name
28039           in: path
28040           required: true
28041           type: string
28042           example: __EQUIPMENT-NAME__
28043         - name: interface-name
28044           in: path
28045           description: Name that identifies the physical interface
28046           required: true
28047           type: string
28048           example: __INTERFACE-NAME__
28049         - name: resource-version
28050           in: query
28051           description: resource-version for concurrency
28052           required: true
28053           type: string
28054   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
28055     get:
28056       tags:
28057         - Network
28058       summary: returns p-interfaces
28059       description: returns p-interfaces
28060       operationId: getNetworkVplsPesVplsPePInterfaces
28061       produces:
28062         - application/json
28063         - application/xml
28064       responses:
28065         "200":
28066           description: successful operation
28067           schema:
28068               $ref: "#/getDefinitions/p-interfaces"
28069         "default":
28070           description: Response codes found in [response codes](https://wiki.onap.org/).
28071       parameters:
28072         - name: equipment-name
28073           in: path
28074           required: true
28075           type: string
28076           example: __EQUIPMENT-NAME__
28077         - name: prov-status
28078           in: query
28079           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28080           required: false
28081           type: string
28082   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
28083     put:
28084       tags:
28085         - Network
28086       summary: see node definition for valid relationships
28087       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
28088       consumes:
28089         - application/json
28090         - application/xml
28091       produces:
28092         - application/json
28093         - application/xml
28094       responses:
28095         "default":
28096           description: Response codes found in [response codes](https://wiki.onap.org/).
28097       parameters:
28098         - name: equipment-name
28099           in: path
28100           required: true
28101           type: string
28102           example: __EQUIPMENT-NAME__
28103         - name: interface-name
28104           in: path
28105           description: Name that identifies the link aggregate interface
28106           required: true
28107           type: string
28108           example: __INTERFACE-NAME__
28109         - name: body
28110           in: body
28111           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
28112           required: true
28113           schema:
28114             $ref: "#/definitions/relationship"
28115     delete:
28116       tags:
28117         - Network
28118       summary: delete an existing relationship
28119       description: delete an existing relationship
28120       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
28121       consumes:
28122         - application/json
28123         - application/xml
28124       produces:
28125         - application/json
28126         - application/xml
28127       responses:
28128         "default":
28129           description: Response codes found in [response codes](https://wiki.onap.org/).
28130       parameters:
28131         - name: equipment-name
28132           in: path
28133           required: true
28134           type: string
28135           example: __EQUIPMENT-NAME__
28136         - name: interface-name
28137           in: path
28138           description: Name that identifies the link aggregate interface
28139           required: true
28140           type: string
28141           example: __INTERFACE-NAME__
28142   /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:
28143     put:
28144       tags:
28145         - Network
28146       summary: see node definition for valid relationships
28147       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
28148       consumes:
28149         - application/json
28150         - application/xml
28151       produces:
28152         - application/json
28153         - application/xml
28154       responses:
28155         "default":
28156           description: Response codes found in [response codes](https://wiki.onap.org/).
28157       parameters:
28158         - name: equipment-name
28159           in: path
28160           required: true
28161           type: string
28162           example: __EQUIPMENT-NAME__
28163         - name: interface-name
28164           in: path
28165           description: Name that identifies the link aggregate interface
28166           required: true
28167           type: string
28168           example: __INTERFACE-NAME__
28169         - name: interface-name
28170           in: path
28171           description: Name given to the interface
28172           required: true
28173           type: string
28174           example: __INTERFACE-NAME__
28175         - name: vlan-interface
28176           in: path
28177           description: String that identifies the interface
28178           required: true
28179           type: string
28180           example: __VLAN-INTERFACE__
28181         - name: body
28182           in: body
28183           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
28184           required: true
28185           schema:
28186             $ref: "#/definitions/relationship"
28187     delete:
28188       tags:
28189         - Network
28190       summary: delete an existing relationship
28191       description: delete an existing relationship
28192       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
28193       consumes:
28194         - application/json
28195         - application/xml
28196       produces:
28197         - application/json
28198         - application/xml
28199       responses:
28200         "default":
28201           description: Response codes found in [response codes](https://wiki.onap.org/).
28202       parameters:
28203         - name: equipment-name
28204           in: path
28205           required: true
28206           type: string
28207           example: __EQUIPMENT-NAME__
28208         - name: interface-name
28209           in: path
28210           description: Name that identifies the link aggregate interface
28211           required: true
28212           type: string
28213           example: __INTERFACE-NAME__
28214         - name: interface-name
28215           in: path
28216           description: Name given to the interface
28217           required: true
28218           type: string
28219           example: __INTERFACE-NAME__
28220         - name: vlan-interface
28221           in: path
28222           description: String that identifies the interface
28223           required: true
28224           type: string
28225           example: __VLAN-INTERFACE__
28226   /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:
28227     put:
28228       tags:
28229         - Network
28230       summary: see node definition for valid relationships
28231       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
28232       consumes:
28233         - application/json
28234         - application/xml
28235       produces:
28236         - application/json
28237         - application/xml
28238       responses:
28239         "default":
28240           description: Response codes found in [response codes](https://wiki.onap.org/).
28241       parameters:
28242         - name: equipment-name
28243           in: path
28244           required: true
28245           type: string
28246           example: __EQUIPMENT-NAME__
28247         - name: interface-name
28248           in: path
28249           description: Name that identifies the link aggregate interface
28250           required: true
28251           type: string
28252           example: __INTERFACE-NAME__
28253         - name: interface-name
28254           in: path
28255           description: Name given to the interface
28256           required: true
28257           type: string
28258           example: __INTERFACE-NAME__
28259         - name: vlan-interface
28260           in: path
28261           description: String that identifies the interface
28262           required: true
28263           type: string
28264           example: __VLAN-INTERFACE__
28265         - name: l3-interface-ipv4-address
28266           in: path
28267           description: IP address
28268           required: true
28269           type: string
28270           example: __L3-INTERFACE-IPV4-ADDRESS__
28271         - name: body
28272           in: body
28273           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28274           required: true
28275           schema:
28276             $ref: "#/definitions/relationship"
28277     delete:
28278       tags:
28279         - Network
28280       summary: delete an existing relationship
28281       description: delete an existing relationship
28282       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
28283       consumes:
28284         - application/json
28285         - application/xml
28286       produces:
28287         - application/json
28288         - application/xml
28289       responses:
28290         "default":
28291           description: Response codes found in [response codes](https://wiki.onap.org/).
28292       parameters:
28293         - name: equipment-name
28294           in: path
28295           required: true
28296           type: string
28297           example: __EQUIPMENT-NAME__
28298         - name: interface-name
28299           in: path
28300           description: Name that identifies the link aggregate interface
28301           required: true
28302           type: string
28303           example: __INTERFACE-NAME__
28304         - name: interface-name
28305           in: path
28306           description: Name given to the interface
28307           required: true
28308           type: string
28309           example: __INTERFACE-NAME__
28310         - name: vlan-interface
28311           in: path
28312           description: String that identifies the interface
28313           required: true
28314           type: string
28315           example: __VLAN-INTERFACE__
28316         - name: l3-interface-ipv4-address
28317           in: path
28318           description: IP address
28319           required: true
28320           type: string
28321           example: __L3-INTERFACE-IPV4-ADDRESS__
28322   /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}:
28323     get:
28324       tags:
28325         - Network
28326       summary: returns l3-interface-ipv4-address-list
28327       description: returns l3-interface-ipv4-address-list
28328       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28329       produces:
28330         - application/json
28331         - application/xml
28332       responses:
28333         "200":
28334           description: successful operation
28335           schema:
28336               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28337         "default":
28338           description: Response codes found in [response codes](https://wiki.onap.org/).
28339       parameters:
28340         - name: equipment-name
28341           in: path
28342           required: true
28343           type: string
28344           example: __EQUIPMENT-NAME__
28345         - name: interface-name
28346           in: path
28347           description: Name that identifies the link aggregate interface
28348           required: true
28349           type: string
28350           example: __INTERFACE-NAME__
28351         - name: interface-name
28352           in: path
28353           description: Name given to the interface
28354           required: true
28355           type: string
28356           example: __INTERFACE-NAME__
28357         - name: vlan-interface
28358           in: path
28359           description: String that identifies the interface
28360           required: true
28361           type: string
28362           example: __VLAN-INTERFACE__
28363         - name: l3-interface-ipv4-address
28364           in: path
28365           description: IP address
28366           required: true
28367           type: string
28368           example: __L3-INTERFACE-IPV4-ADDRESS__
28369         - name: prov-status
28370           in: query
28371           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28372           required: false
28373           type: string
28374         - name: interface-id
28375           in: query
28376           description: ID of interface
28377           required: false
28378           type: string
28379         - name: interface-role
28380           in: query
28381           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
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: macaddr
28390           in: query
28391           description: MAC address for the interface
28392           required: false
28393           type: string
28394         - name: network-name
28395           in: query
28396           description: Name of the network
28397           required: false
28398           type: string
28399         - name: vlan-id-inner
28400           in: query
28401           description: Inner VLAN tag
28402           required: false
28403           type: integer
28404           format: int64
28405         - name: vpn-key
28406           in: query
28407           description: This indicates the customers VPN ID associated with this vlan
28408           required: false
28409           type: string
28410         - name: vlan-id-inner
28411           in: query
28412           description: Inner VLAN tag
28413           required: false
28414           type: integer
28415           format: int64
28416         - name: neutron-network-id
28417           in: query
28418           description: Neutron network id of the interface that address belongs to
28419           required: false
28420           type: string
28421         - name: neutron-subnet-id
28422           in: query
28423           description: Neutron id of subnet that address belongs to
28424           required: false
28425           type: string
28426     put:
28427       tags:
28428         - Network
28429       summary: create or update an existing l3-interface-ipv4-address-list
28430       description: |
28431         Create or update an existing l3-interface-ipv4-address-list.
28432         #
28433         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28434       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28435       consumes:
28436         - application/json
28437         - application/xml
28438       produces:
28439         - application/json
28440         - application/xml
28441       responses:
28442         "default":
28443           description: Response codes found in [response codes](https://wiki.onap.org/).
28444       parameters:
28445         - name: equipment-name
28446           in: path
28447           required: true
28448           type: string
28449           example: __EQUIPMENT-NAME__
28450         - name: interface-name
28451           in: path
28452           description: Name that identifies the link aggregate interface
28453           required: true
28454           type: string
28455           example: __INTERFACE-NAME__
28456         - name: interface-name
28457           in: path
28458           description: Name given to the interface
28459           required: true
28460           type: string
28461           example: __INTERFACE-NAME__
28462         - name: vlan-interface
28463           in: path
28464           description: String that identifies the interface
28465           required: true
28466           type: string
28467           example: __VLAN-INTERFACE__
28468         - name: l3-interface-ipv4-address
28469           in: path
28470           description: IP address
28471           required: true
28472           type: string
28473           example: __L3-INTERFACE-IPV4-ADDRESS__
28474         - name: body
28475           in: body
28476           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28477           required: true
28478           schema:
28479             $ref: "#/definitions/l3-interface-ipv4-address-list"
28480     patch:
28481       tags:
28482         - Network
28483       summary: update an existing l3-interface-ipv4-address-list
28484       description: |
28485         Update an existing l3-interface-ipv4-address-list
28486         #
28487         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28488         The PUT operation will entirely replace an existing object.
28489         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28490         #
28491         Other differences between PUT and PATCH are:
28492         #
28493         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28494         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28495         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28496       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28497       consumes:
28498         - application/json
28499         - application/xml
28500       produces:
28501         - application/json
28502         - application/xml
28503       responses:
28504         "default":
28505           description: Response codes found in [response codes](https://wiki.onap.org/).
28506       parameters:
28507         - name: equipment-name
28508           in: path
28509           required: true
28510           type: string
28511           example: __EQUIPMENT-NAME__
28512         - name: interface-name
28513           in: path
28514           description: Name that identifies the link aggregate interface
28515           required: true
28516           type: string
28517           example: __INTERFACE-NAME__
28518         - name: interface-name
28519           in: path
28520           description: Name given to the interface
28521           required: true
28522           type: string
28523           example: __INTERFACE-NAME__
28524         - name: vlan-interface
28525           in: path
28526           description: String that identifies the interface
28527           required: true
28528           type: string
28529           example: __VLAN-INTERFACE__
28530         - name: l3-interface-ipv4-address
28531           in: path
28532           description: IP address
28533           required: true
28534           type: string
28535           example: __L3-INTERFACE-IPV4-ADDRESS__
28536         - name: body
28537           in: body
28538           description: l3-interface-ipv4-address-list object that needs to be created or updated.
28539           required: true
28540           schema:
28541             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28542     delete:
28543       tags:
28544         - Network
28545       summary: delete an existing l3-interface-ipv4-address-list
28546       description: delete an existing l3-interface-ipv4-address-list
28547       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28548       consumes:
28549         - application/json
28550         - application/xml
28551       produces:
28552         - application/json
28553         - application/xml
28554       responses:
28555         "default":
28556           description: Response codes found in [response codes](https://wiki.onap.org/).
28557       parameters:
28558         - name: equipment-name
28559           in: path
28560           required: true
28561           type: string
28562           example: __EQUIPMENT-NAME__
28563         - name: interface-name
28564           in: path
28565           description: Name that identifies the link aggregate interface
28566           required: true
28567           type: string
28568           example: __INTERFACE-NAME__
28569         - name: interface-name
28570           in: path
28571           description: Name given to the interface
28572           required: true
28573           type: string
28574           example: __INTERFACE-NAME__
28575         - name: vlan-interface
28576           in: path
28577           description: String that identifies the interface
28578           required: true
28579           type: string
28580           example: __VLAN-INTERFACE__
28581         - name: l3-interface-ipv4-address
28582           in: path
28583           description: IP address
28584           required: true
28585           type: string
28586           example: __L3-INTERFACE-IPV4-ADDRESS__
28587         - name: resource-version
28588           in: query
28589           description: resource-version for concurrency
28590           required: true
28591           type: string
28592   /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:
28593     put:
28594       tags:
28595         - Network
28596       summary: see node definition for valid relationships
28597       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28598       consumes:
28599         - application/json
28600         - application/xml
28601       produces:
28602         - application/json
28603         - application/xml
28604       responses:
28605         "default":
28606           description: Response codes found in [response codes](https://wiki.onap.org/).
28607       parameters:
28608         - name: equipment-name
28609           in: path
28610           required: true
28611           type: string
28612           example: __EQUIPMENT-NAME__
28613         - name: interface-name
28614           in: path
28615           description: Name that identifies the link aggregate interface
28616           required: true
28617           type: string
28618           example: __INTERFACE-NAME__
28619         - name: interface-name
28620           in: path
28621           description: Name given to the interface
28622           required: true
28623           type: string
28624           example: __INTERFACE-NAME__
28625         - name: vlan-interface
28626           in: path
28627           description: String that identifies the interface
28628           required: true
28629           type: string
28630           example: __VLAN-INTERFACE__
28631         - name: l3-interface-ipv6-address
28632           in: path
28633           description: IP address
28634           required: true
28635           type: string
28636           example: __L3-INTERFACE-IPV6-ADDRESS__
28637         - name: body
28638           in: body
28639           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28640           required: true
28641           schema:
28642             $ref: "#/definitions/relationship"
28643     delete:
28644       tags:
28645         - Network
28646       summary: delete an existing relationship
28647       description: delete an existing relationship
28648       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28649       consumes:
28650         - application/json
28651         - application/xml
28652       produces:
28653         - application/json
28654         - application/xml
28655       responses:
28656         "default":
28657           description: Response codes found in [response codes](https://wiki.onap.org/).
28658       parameters:
28659         - name: equipment-name
28660           in: path
28661           required: true
28662           type: string
28663           example: __EQUIPMENT-NAME__
28664         - name: interface-name
28665           in: path
28666           description: Name that identifies the link aggregate interface
28667           required: true
28668           type: string
28669           example: __INTERFACE-NAME__
28670         - name: interface-name
28671           in: path
28672           description: Name given to the interface
28673           required: true
28674           type: string
28675           example: __INTERFACE-NAME__
28676         - name: vlan-interface
28677           in: path
28678           description: String that identifies the interface
28679           required: true
28680           type: string
28681           example: __VLAN-INTERFACE__
28682         - name: l3-interface-ipv6-address
28683           in: path
28684           description: IP address
28685           required: true
28686           type: string
28687           example: __L3-INTERFACE-IPV6-ADDRESS__
28688   /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}:
28689     get:
28690       tags:
28691         - Network
28692       summary: returns l3-interface-ipv6-address-list
28693       description: returns l3-interface-ipv6-address-list
28694       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28695       produces:
28696         - application/json
28697         - application/xml
28698       responses:
28699         "200":
28700           description: successful operation
28701           schema:
28702               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28703         "default":
28704           description: Response codes found in [response codes](https://wiki.onap.org/).
28705       parameters:
28706         - name: equipment-name
28707           in: path
28708           required: true
28709           type: string
28710           example: __EQUIPMENT-NAME__
28711         - name: interface-name
28712           in: path
28713           description: Name that identifies the link aggregate interface
28714           required: true
28715           type: string
28716           example: __INTERFACE-NAME__
28717         - name: interface-name
28718           in: path
28719           description: Name given to the interface
28720           required: true
28721           type: string
28722           example: __INTERFACE-NAME__
28723         - name: vlan-interface
28724           in: path
28725           description: String that identifies the interface
28726           required: true
28727           type: string
28728           example: __VLAN-INTERFACE__
28729         - name: l3-interface-ipv6-address
28730           in: path
28731           description: IP address
28732           required: true
28733           type: string
28734           example: __L3-INTERFACE-IPV6-ADDRESS__
28735         - name: prov-status
28736           in: query
28737           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28738           required: false
28739           type: string
28740         - name: interface-id
28741           in: query
28742           description: ID of interface
28743           required: false
28744           type: string
28745         - name: interface-role
28746           in: query
28747           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28748           required: false
28749           type: string
28750         - name: interface-id
28751           in: query
28752           description: ID of interface
28753           required: false
28754           type: string
28755         - name: macaddr
28756           in: query
28757           description: MAC address for the interface
28758           required: false
28759           type: string
28760         - name: network-name
28761           in: query
28762           description: Name of the network
28763           required: false
28764           type: string
28765         - name: vlan-id-inner
28766           in: query
28767           description: Inner VLAN tag
28768           required: false
28769           type: integer
28770           format: int64
28771         - name: vpn-key
28772           in: query
28773           description: This indicates the customers VPN ID associated with this vlan
28774           required: false
28775           type: string
28776         - name: vlan-id-inner
28777           in: query
28778           description: Inner VLAN tag
28779           required: false
28780           type: integer
28781           format: int64
28782         - name: neutron-network-id
28783           in: query
28784           description: Neutron network id of the interface that address belongs to
28785           required: false
28786           type: string
28787         - name: neutron-subnet-id
28788           in: query
28789           description: Neutron id of subnet that address belongs to
28790           required: false
28791           type: string
28792     put:
28793       tags:
28794         - Network
28795       summary: create or update an existing l3-interface-ipv6-address-list
28796       description: |
28797         Create or update an existing l3-interface-ipv6-address-list.
28798         #
28799         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28800       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28801       consumes:
28802         - application/json
28803         - application/xml
28804       produces:
28805         - application/json
28806         - application/xml
28807       responses:
28808         "default":
28809           description: Response codes found in [response codes](https://wiki.onap.org/).
28810       parameters:
28811         - name: equipment-name
28812           in: path
28813           required: true
28814           type: string
28815           example: __EQUIPMENT-NAME__
28816         - name: interface-name
28817           in: path
28818           description: Name that identifies the link aggregate interface
28819           required: true
28820           type: string
28821           example: __INTERFACE-NAME__
28822         - name: interface-name
28823           in: path
28824           description: Name given to the interface
28825           required: true
28826           type: string
28827           example: __INTERFACE-NAME__
28828         - name: vlan-interface
28829           in: path
28830           description: String that identifies the interface
28831           required: true
28832           type: string
28833           example: __VLAN-INTERFACE__
28834         - name: l3-interface-ipv6-address
28835           in: path
28836           description: IP address
28837           required: true
28838           type: string
28839           example: __L3-INTERFACE-IPV6-ADDRESS__
28840         - name: body
28841           in: body
28842           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28843           required: true
28844           schema:
28845             $ref: "#/definitions/l3-interface-ipv6-address-list"
28846     patch:
28847       tags:
28848         - Network
28849       summary: update an existing l3-interface-ipv6-address-list
28850       description: |
28851         Update an existing l3-interface-ipv6-address-list
28852         #
28853         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28854         The PUT operation will entirely replace an existing object.
28855         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28856         #
28857         Other differences between PUT and PATCH are:
28858         #
28859         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28860         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28861         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28862       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28863       consumes:
28864         - application/json
28865         - application/xml
28866       produces:
28867         - application/json
28868         - application/xml
28869       responses:
28870         "default":
28871           description: Response codes found in [response codes](https://wiki.onap.org/).
28872       parameters:
28873         - name: equipment-name
28874           in: path
28875           required: true
28876           type: string
28877           example: __EQUIPMENT-NAME__
28878         - name: interface-name
28879           in: path
28880           description: Name that identifies the link aggregate interface
28881           required: true
28882           type: string
28883           example: __INTERFACE-NAME__
28884         - name: interface-name
28885           in: path
28886           description: Name given to the interface
28887           required: true
28888           type: string
28889           example: __INTERFACE-NAME__
28890         - name: vlan-interface
28891           in: path
28892           description: String that identifies the interface
28893           required: true
28894           type: string
28895           example: __VLAN-INTERFACE__
28896         - name: l3-interface-ipv6-address
28897           in: path
28898           description: IP address
28899           required: true
28900           type: string
28901           example: __L3-INTERFACE-IPV6-ADDRESS__
28902         - name: body
28903           in: body
28904           description: l3-interface-ipv6-address-list object that needs to be created or updated.
28905           required: true
28906           schema:
28907             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28908     delete:
28909       tags:
28910         - Network
28911       summary: delete an existing l3-interface-ipv6-address-list
28912       description: delete an existing l3-interface-ipv6-address-list
28913       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28914       consumes:
28915         - application/json
28916         - application/xml
28917       produces:
28918         - application/json
28919         - application/xml
28920       responses:
28921         "default":
28922           description: Response codes found in [response codes](https://wiki.onap.org/).
28923       parameters:
28924         - name: equipment-name
28925           in: path
28926           required: true
28927           type: string
28928           example: __EQUIPMENT-NAME__
28929         - name: interface-name
28930           in: path
28931           description: Name that identifies the link aggregate interface
28932           required: true
28933           type: string
28934           example: __INTERFACE-NAME__
28935         - name: interface-name
28936           in: path
28937           description: Name given to the interface
28938           required: true
28939           type: string
28940           example: __INTERFACE-NAME__
28941         - name: vlan-interface
28942           in: path
28943           description: String that identifies the interface
28944           required: true
28945           type: string
28946           example: __VLAN-INTERFACE__
28947         - name: l3-interface-ipv6-address
28948           in: path
28949           description: IP address
28950           required: true
28951           type: string
28952           example: __L3-INTERFACE-IPV6-ADDRESS__
28953         - name: resource-version
28954           in: query
28955           description: resource-version for concurrency
28956           required: true
28957           type: string
28958   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28959     get:
28960       tags:
28961         - Network
28962       summary: returns vlan
28963       description: returns vlan
28964       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28965       produces:
28966         - application/json
28967         - application/xml
28968       responses:
28969         "200":
28970           description: successful operation
28971           schema:
28972               $ref: "#/getDefinitions/vlan"
28973         "default":
28974           description: Response codes found in [response codes](https://wiki.onap.org/).
28975       parameters:
28976         - name: equipment-name
28977           in: path
28978           required: true
28979           type: string
28980           example: __EQUIPMENT-NAME__
28981         - name: interface-name
28982           in: path
28983           description: Name that identifies the link aggregate interface
28984           required: true
28985           type: string
28986           example: __INTERFACE-NAME__
28987         - name: interface-name
28988           in: path
28989           description: Name given to the interface
28990           required: true
28991           type: string
28992           example: __INTERFACE-NAME__
28993         - name: vlan-interface
28994           in: path
28995           description: String that identifies the interface
28996           required: true
28997           type: string
28998           example: __VLAN-INTERFACE__
28999         - name: prov-status
29000           in: query
29001           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29002           required: false
29003           type: string
29004         - name: interface-id
29005           in: query
29006           description: ID of interface
29007           required: false
29008           type: string
29009         - name: interface-role
29010           in: query
29011           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29012           required: false
29013           type: string
29014         - name: interface-id
29015           in: query
29016           description: ID of interface
29017           required: false
29018           type: string
29019         - name: macaddr
29020           in: query
29021           description: MAC address for the interface
29022           required: false
29023           type: string
29024         - name: network-name
29025           in: query
29026           description: Name of the network
29027           required: false
29028           type: string
29029         - name: vlan-id-inner
29030           in: query
29031           description: Inner VLAN tag
29032           required: false
29033           type: integer
29034           format: int64
29035         - name: vpn-key
29036           in: query
29037           description: This indicates the customers VPN ID associated with this vlan
29038           required: false
29039           type: string
29040     put:
29041       tags:
29042         - Network
29043       summary: create or update an existing vlan
29044       description: |
29045         Create or update an existing vlan.
29046         #
29047         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29048       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29049       consumes:
29050         - application/json
29051         - application/xml
29052       produces:
29053         - application/json
29054         - application/xml
29055       responses:
29056         "default":
29057           description: Response codes found in [response codes](https://wiki.onap.org/).
29058       parameters:
29059         - name: equipment-name
29060           in: path
29061           required: true
29062           type: string
29063           example: __EQUIPMENT-NAME__
29064         - name: interface-name
29065           in: path
29066           description: Name that identifies the link aggregate interface
29067           required: true
29068           type: string
29069           example: __INTERFACE-NAME__
29070         - name: interface-name
29071           in: path
29072           description: Name given to the interface
29073           required: true
29074           type: string
29075           example: __INTERFACE-NAME__
29076         - name: vlan-interface
29077           in: path
29078           description: String that identifies the interface
29079           required: true
29080           type: string
29081           example: __VLAN-INTERFACE__
29082         - name: body
29083           in: body
29084           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29085           required: true
29086           schema:
29087             $ref: "#/definitions/vlan"
29088     patch:
29089       tags:
29090         - Network
29091       summary: update an existing vlan
29092       description: |
29093         Update an existing vlan
29094         #
29095         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29096         The PUT operation will entirely replace an existing object.
29097         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29098         #
29099         Other differences between PUT and PATCH are:
29100         #
29101         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29102         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29103         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29104       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29105       consumes:
29106         - application/json
29107         - application/xml
29108       produces:
29109         - application/json
29110         - application/xml
29111       responses:
29112         "default":
29113           description: Response codes found in [response codes](https://wiki.onap.org/).
29114       parameters:
29115         - name: equipment-name
29116           in: path
29117           required: true
29118           type: string
29119           example: __EQUIPMENT-NAME__
29120         - name: interface-name
29121           in: path
29122           description: Name that identifies the link aggregate interface
29123           required: true
29124           type: string
29125           example: __INTERFACE-NAME__
29126         - name: interface-name
29127           in: path
29128           description: Name given to the interface
29129           required: true
29130           type: string
29131           example: __INTERFACE-NAME__
29132         - name: vlan-interface
29133           in: path
29134           description: String that identifies the interface
29135           required: true
29136           type: string
29137           example: __VLAN-INTERFACE__
29138         - name: body
29139           in: body
29140           description: vlan object that needs to be created or updated.
29141           required: true
29142           schema:
29143             $ref: "#/patchDefinitions/vlan"
29144     delete:
29145       tags:
29146         - Network
29147       summary: delete an existing vlan
29148       description: delete an existing vlan
29149       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29150       consumes:
29151         - application/json
29152         - application/xml
29153       produces:
29154         - application/json
29155         - application/xml
29156       responses:
29157         "default":
29158           description: Response codes found in [response codes](https://wiki.onap.org/).
29159       parameters:
29160         - name: equipment-name
29161           in: path
29162           required: true
29163           type: string
29164           example: __EQUIPMENT-NAME__
29165         - name: interface-name
29166           in: path
29167           description: Name that identifies the link aggregate interface
29168           required: true
29169           type: string
29170           example: __INTERFACE-NAME__
29171         - name: interface-name
29172           in: path
29173           description: Name given to the interface
29174           required: true
29175           type: string
29176           example: __INTERFACE-NAME__
29177         - name: vlan-interface
29178           in: path
29179           description: String that identifies the interface
29180           required: true
29181           type: string
29182           example: __VLAN-INTERFACE__
29183         - name: resource-version
29184           in: query
29185           description: resource-version for concurrency
29186           required: true
29187           type: string
29188   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
29189     get:
29190       tags:
29191         - Network
29192       summary: returns vlans
29193       description: returns vlans
29194       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
29195       produces:
29196         - application/json
29197         - application/xml
29198       responses:
29199         "200":
29200           description: successful operation
29201           schema:
29202               $ref: "#/getDefinitions/vlans"
29203         "default":
29204           description: Response codes found in [response codes](https://wiki.onap.org/).
29205       parameters:
29206         - name: equipment-name
29207           in: path
29208           required: true
29209           type: string
29210           example: __EQUIPMENT-NAME__
29211         - name: interface-name
29212           in: path
29213           description: Name that identifies the link aggregate interface
29214           required: true
29215           type: string
29216           example: __INTERFACE-NAME__
29217         - name: interface-name
29218           in: path
29219           description: Name given to the interface
29220           required: true
29221           type: string
29222           example: __INTERFACE-NAME__
29223         - name: prov-status
29224           in: query
29225           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29226           required: false
29227           type: string
29228         - name: interface-id
29229           in: query
29230           description: ID of interface
29231           required: false
29232           type: string
29233         - name: interface-role
29234           in: query
29235           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29236           required: false
29237           type: string
29238         - name: interface-id
29239           in: query
29240           description: ID of interface
29241           required: false
29242           type: string
29243         - name: macaddr
29244           in: query
29245           description: MAC address for the interface
29246           required: false
29247           type: string
29248         - name: network-name
29249           in: query
29250           description: Name of the network
29251           required: false
29252           type: string
29253   /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:
29254     put:
29255       tags:
29256         - Network
29257       summary: see node definition for valid relationships
29258       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
29259       consumes:
29260         - application/json
29261         - application/xml
29262       produces:
29263         - application/json
29264         - application/xml
29265       responses:
29266         "default":
29267           description: Response codes found in [response codes](https://wiki.onap.org/).
29268       parameters:
29269         - name: equipment-name
29270           in: path
29271           required: true
29272           type: string
29273           example: __EQUIPMENT-NAME__
29274         - name: interface-name
29275           in: path
29276           description: Name that identifies the link aggregate interface
29277           required: true
29278           type: string
29279           example: __INTERFACE-NAME__
29280         - name: interface-name
29281           in: path
29282           description: Name given to the interface
29283           required: true
29284           type: string
29285           example: __INTERFACE-NAME__
29286         - name: pci-id
29287           in: path
29288           description: PCI ID used to identify the sriov-vf
29289           required: true
29290           type: string
29291           example: __PCI-ID__
29292         - name: body
29293           in: body
29294           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
29295           required: true
29296           schema:
29297             $ref: "#/definitions/relationship"
29298     delete:
29299       tags:
29300         - Network
29301       summary: delete an existing relationship
29302       description: delete an existing relationship
29303       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
29304       consumes:
29305         - application/json
29306         - application/xml
29307       produces:
29308         - application/json
29309         - application/xml
29310       responses:
29311         "default":
29312           description: Response codes found in [response codes](https://wiki.onap.org/).
29313       parameters:
29314         - name: equipment-name
29315           in: path
29316           required: true
29317           type: string
29318           example: __EQUIPMENT-NAME__
29319         - name: interface-name
29320           in: path
29321           description: Name that identifies the link aggregate interface
29322           required: true
29323           type: string
29324           example: __INTERFACE-NAME__
29325         - name: interface-name
29326           in: path
29327           description: Name given to the interface
29328           required: true
29329           type: string
29330           example: __INTERFACE-NAME__
29331         - name: pci-id
29332           in: path
29333           description: PCI ID used to identify the sriov-vf
29334           required: true
29335           type: string
29336           example: __PCI-ID__
29337   /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}:
29338     get:
29339       tags:
29340         - Network
29341       summary: returns sriov-vf
29342       description: returns sriov-vf
29343       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29344       produces:
29345         - application/json
29346         - application/xml
29347       responses:
29348         "200":
29349           description: successful operation
29350           schema:
29351               $ref: "#/getDefinitions/sriov-vf"
29352         "default":
29353           description: Response codes found in [response codes](https://wiki.onap.org/).
29354       parameters:
29355         - name: equipment-name
29356           in: path
29357           required: true
29358           type: string
29359           example: __EQUIPMENT-NAME__
29360         - name: interface-name
29361           in: path
29362           description: Name that identifies the link aggregate interface
29363           required: true
29364           type: string
29365           example: __INTERFACE-NAME__
29366         - name: interface-name
29367           in: path
29368           description: Name given to the interface
29369           required: true
29370           type: string
29371           example: __INTERFACE-NAME__
29372         - name: pci-id
29373           in: path
29374           description: PCI ID used to identify the sriov-vf
29375           required: true
29376           type: string
29377           example: __PCI-ID__
29378         - name: prov-status
29379           in: query
29380           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29381           required: false
29382           type: string
29383         - name: interface-id
29384           in: query
29385           description: ID of interface
29386           required: false
29387           type: string
29388         - name: interface-role
29389           in: query
29390           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29391           required: false
29392           type: string
29393         - name: interface-id
29394           in: query
29395           description: ID of interface
29396           required: false
29397           type: string
29398         - name: macaddr
29399           in: query
29400           description: MAC address for the interface
29401           required: false
29402           type: string
29403         - name: network-name
29404           in: query
29405           description: Name of the network
29406           required: false
29407           type: string
29408         - name: vf-vlan-filter
29409           in: query
29410           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
29411           required: false
29412           type: string
29413         - name: vf-mac-filter
29414           in: query
29415           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
29416           required: false
29417           type: string
29418         - name: vf-vlan-strip
29419           in: query
29420           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
29421           required: false
29422           type: boolean
29423         - name: neutron-network-id
29424           in: query
29425           description: Neutron network id of the interface
29426           required: false
29427           type: string
29428     put:
29429       tags:
29430         - Network
29431       summary: create or update an existing sriov-vf
29432       description: |
29433         Create or update an existing sriov-vf.
29434         #
29435         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29436       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29437       consumes:
29438         - application/json
29439         - application/xml
29440       produces:
29441         - application/json
29442         - application/xml
29443       responses:
29444         "default":
29445           description: Response codes found in [response codes](https://wiki.onap.org/).
29446       parameters:
29447         - name: equipment-name
29448           in: path
29449           required: true
29450           type: string
29451           example: __EQUIPMENT-NAME__
29452         - name: interface-name
29453           in: path
29454           description: Name that identifies the link aggregate interface
29455           required: true
29456           type: string
29457           example: __INTERFACE-NAME__
29458         - name: interface-name
29459           in: path
29460           description: Name given to the interface
29461           required: true
29462           type: string
29463           example: __INTERFACE-NAME__
29464         - name: pci-id
29465           in: path
29466           description: PCI ID used to identify the sriov-vf
29467           required: true
29468           type: string
29469           example: __PCI-ID__
29470         - name: body
29471           in: body
29472           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
29473           required: true
29474           schema:
29475             $ref: "#/definitions/sriov-vf"
29476     patch:
29477       tags:
29478         - Network
29479       summary: update an existing sriov-vf
29480       description: |
29481         Update an existing sriov-vf
29482         #
29483         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29484         The PUT operation will entirely replace an existing object.
29485         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29486         #
29487         Other differences between PUT and PATCH are:
29488         #
29489         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29490         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29491         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29492       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29493       consumes:
29494         - application/json
29495         - application/xml
29496       produces:
29497         - application/json
29498         - application/xml
29499       responses:
29500         "default":
29501           description: Response codes found in [response codes](https://wiki.onap.org/).
29502       parameters:
29503         - name: equipment-name
29504           in: path
29505           required: true
29506           type: string
29507           example: __EQUIPMENT-NAME__
29508         - name: interface-name
29509           in: path
29510           description: Name that identifies the link aggregate interface
29511           required: true
29512           type: string
29513           example: __INTERFACE-NAME__
29514         - name: interface-name
29515           in: path
29516           description: Name given to the interface
29517           required: true
29518           type: string
29519           example: __INTERFACE-NAME__
29520         - name: pci-id
29521           in: path
29522           description: PCI ID used to identify the sriov-vf
29523           required: true
29524           type: string
29525           example: __PCI-ID__
29526         - name: body
29527           in: body
29528           description: sriov-vf object that needs to be created or updated.
29529           required: true
29530           schema:
29531             $ref: "#/patchDefinitions/sriov-vf"
29532     delete:
29533       tags:
29534         - Network
29535       summary: delete an existing sriov-vf
29536       description: delete an existing sriov-vf
29537       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29538       consumes:
29539         - application/json
29540         - application/xml
29541       produces:
29542         - application/json
29543         - application/xml
29544       responses:
29545         "default":
29546           description: Response codes found in [response codes](https://wiki.onap.org/).
29547       parameters:
29548         - name: equipment-name
29549           in: path
29550           required: true
29551           type: string
29552           example: __EQUIPMENT-NAME__
29553         - name: interface-name
29554           in: path
29555           description: Name that identifies the link aggregate interface
29556           required: true
29557           type: string
29558           example: __INTERFACE-NAME__
29559         - name: interface-name
29560           in: path
29561           description: Name given to the interface
29562           required: true
29563           type: string
29564           example: __INTERFACE-NAME__
29565         - name: pci-id
29566           in: path
29567           description: PCI ID used to identify the sriov-vf
29568           required: true
29569           type: string
29570           example: __PCI-ID__
29571         - name: resource-version
29572           in: query
29573           description: resource-version for concurrency
29574           required: true
29575           type: string
29576   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
29577     get:
29578       tags:
29579         - Network
29580       summary: returns sriov-vfs
29581       description: returns sriov-vfs
29582       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
29583       produces:
29584         - application/json
29585         - application/xml
29586       responses:
29587         "200":
29588           description: successful operation
29589           schema:
29590               $ref: "#/getDefinitions/sriov-vfs"
29591         "default":
29592           description: Response codes found in [response codes](https://wiki.onap.org/).
29593       parameters:
29594         - name: equipment-name
29595           in: path
29596           required: true
29597           type: string
29598           example: __EQUIPMENT-NAME__
29599         - name: interface-name
29600           in: path
29601           description: Name that identifies the link aggregate interface
29602           required: true
29603           type: string
29604           example: __INTERFACE-NAME__
29605         - name: interface-name
29606           in: path
29607           description: Name given to the interface
29608           required: true
29609           type: string
29610           example: __INTERFACE-NAME__
29611         - name: prov-status
29612           in: query
29613           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29614           required: false
29615           type: string
29616         - name: interface-id
29617           in: query
29618           description: ID of interface
29619           required: false
29620           type: string
29621         - name: interface-role
29622           in: query
29623           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29624           required: false
29625           type: string
29626         - name: interface-id
29627           in: query
29628           description: ID of interface
29629           required: false
29630           type: string
29631         - name: macaddr
29632           in: query
29633           description: MAC address for the interface
29634           required: false
29635           type: string
29636         - name: network-name
29637           in: query
29638           description: Name of the network
29639           required: false
29640           type: string
29641   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
29642     put:
29643       tags:
29644         - Network
29645       summary: see node definition for valid relationships
29646       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
29647       consumes:
29648         - application/json
29649         - application/xml
29650       produces:
29651         - application/json
29652         - application/xml
29653       responses:
29654         "default":
29655           description: Response codes found in [response codes](https://wiki.onap.org/).
29656       parameters:
29657         - name: equipment-name
29658           in: path
29659           required: true
29660           type: string
29661           example: __EQUIPMENT-NAME__
29662         - name: interface-name
29663           in: path
29664           description: Name that identifies the link aggregate interface
29665           required: true
29666           type: string
29667           example: __INTERFACE-NAME__
29668         - name: interface-name
29669           in: path
29670           description: Name given to the interface
29671           required: true
29672           type: string
29673           example: __INTERFACE-NAME__
29674         - name: body
29675           in: body
29676           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
29677           required: true
29678           schema:
29679             $ref: "#/definitions/relationship"
29680     delete:
29681       tags:
29682         - Network
29683       summary: delete an existing relationship
29684       description: delete an existing relationship
29685       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
29686       consumes:
29687         - application/json
29688         - application/xml
29689       produces:
29690         - application/json
29691         - application/xml
29692       responses:
29693         "default":
29694           description: Response codes found in [response codes](https://wiki.onap.org/).
29695       parameters:
29696         - name: equipment-name
29697           in: path
29698           required: true
29699           type: string
29700           example: __EQUIPMENT-NAME__
29701         - name: interface-name
29702           in: path
29703           description: Name that identifies the link aggregate interface
29704           required: true
29705           type: string
29706           example: __INTERFACE-NAME__
29707         - name: interface-name
29708           in: path
29709           description: Name given to the interface
29710           required: true
29711           type: string
29712           example: __INTERFACE-NAME__
29713   /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:
29714     put:
29715       tags:
29716         - Network
29717       summary: see node definition for valid relationships
29718       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29719       consumes:
29720         - application/json
29721         - application/xml
29722       produces:
29723         - application/json
29724         - application/xml
29725       responses:
29726         "default":
29727           description: Response codes found in [response codes](https://wiki.onap.org/).
29728       parameters:
29729         - name: equipment-name
29730           in: path
29731           required: true
29732           type: string
29733           example: __EQUIPMENT-NAME__
29734         - name: interface-name
29735           in: path
29736           description: Name that identifies the link aggregate interface
29737           required: true
29738           type: string
29739           example: __INTERFACE-NAME__
29740         - name: interface-name
29741           in: path
29742           description: Name given to the interface
29743           required: true
29744           type: string
29745           example: __INTERFACE-NAME__
29746         - name: l3-interface-ipv4-address
29747           in: path
29748           description: IP address
29749           required: true
29750           type: string
29751           example: __L3-INTERFACE-IPV4-ADDRESS__
29752         - name: body
29753           in: body
29754           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
29755           required: true
29756           schema:
29757             $ref: "#/definitions/relationship"
29758     delete:
29759       tags:
29760         - Network
29761       summary: delete an existing relationship
29762       description: delete an existing relationship
29763       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29764       consumes:
29765         - application/json
29766         - application/xml
29767       produces:
29768         - application/json
29769         - application/xml
29770       responses:
29771         "default":
29772           description: Response codes found in [response codes](https://wiki.onap.org/).
29773       parameters:
29774         - name: equipment-name
29775           in: path
29776           required: true
29777           type: string
29778           example: __EQUIPMENT-NAME__
29779         - name: interface-name
29780           in: path
29781           description: Name that identifies the link aggregate interface
29782           required: true
29783           type: string
29784           example: __INTERFACE-NAME__
29785         - name: interface-name
29786           in: path
29787           description: Name given to the interface
29788           required: true
29789           type: string
29790           example: __INTERFACE-NAME__
29791         - name: l3-interface-ipv4-address
29792           in: path
29793           description: IP address
29794           required: true
29795           type: string
29796           example: __L3-INTERFACE-IPV4-ADDRESS__
29797   /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}:
29798     get:
29799       tags:
29800         - Network
29801       summary: returns l3-interface-ipv4-address-list
29802       description: returns l3-interface-ipv4-address-list
29803       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29804       produces:
29805         - application/json
29806         - application/xml
29807       responses:
29808         "200":
29809           description: successful operation
29810           schema:
29811               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29812         "default":
29813           description: Response codes found in [response codes](https://wiki.onap.org/).
29814       parameters:
29815         - name: equipment-name
29816           in: path
29817           required: true
29818           type: string
29819           example: __EQUIPMENT-NAME__
29820         - name: interface-name
29821           in: path
29822           description: Name that identifies the link aggregate interface
29823           required: true
29824           type: string
29825           example: __INTERFACE-NAME__
29826         - name: interface-name
29827           in: path
29828           description: Name given to the interface
29829           required: true
29830           type: string
29831           example: __INTERFACE-NAME__
29832         - name: l3-interface-ipv4-address
29833           in: path
29834           description: IP address
29835           required: true
29836           type: string
29837           example: __L3-INTERFACE-IPV4-ADDRESS__
29838         - name: prov-status
29839           in: query
29840           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29841           required: false
29842           type: string
29843         - name: interface-id
29844           in: query
29845           description: ID of interface
29846           required: false
29847           type: string
29848         - name: interface-role
29849           in: query
29850           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29851           required: false
29852           type: string
29853         - name: interface-id
29854           in: query
29855           description: ID of interface
29856           required: false
29857           type: string
29858         - name: macaddr
29859           in: query
29860           description: MAC address for the interface
29861           required: false
29862           type: string
29863         - name: network-name
29864           in: query
29865           description: Name of the network
29866           required: false
29867           type: string
29868         - name: vlan-id-inner
29869           in: query
29870           description: Inner VLAN tag
29871           required: false
29872           type: integer
29873           format: int64
29874         - name: neutron-network-id
29875           in: query
29876           description: Neutron network id of the interface that address belongs to
29877           required: false
29878           type: string
29879         - name: neutron-subnet-id
29880           in: query
29881           description: Neutron id of subnet that address belongs to
29882           required: false
29883           type: string
29884     put:
29885       tags:
29886         - Network
29887       summary: create or update an existing l3-interface-ipv4-address-list
29888       description: |
29889         Create or update an existing l3-interface-ipv4-address-list.
29890         #
29891         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29892       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29893       consumes:
29894         - application/json
29895         - application/xml
29896       produces:
29897         - application/json
29898         - application/xml
29899       responses:
29900         "default":
29901           description: Response codes found in [response codes](https://wiki.onap.org/).
29902       parameters:
29903         - name: equipment-name
29904           in: path
29905           required: true
29906           type: string
29907           example: __EQUIPMENT-NAME__
29908         - name: interface-name
29909           in: path
29910           description: Name that identifies the link aggregate interface
29911           required: true
29912           type: string
29913           example: __INTERFACE-NAME__
29914         - name: interface-name
29915           in: path
29916           description: Name given to the interface
29917           required: true
29918           type: string
29919           example: __INTERFACE-NAME__
29920         - name: l3-interface-ipv4-address
29921           in: path
29922           description: IP address
29923           required: true
29924           type: string
29925           example: __L3-INTERFACE-IPV4-ADDRESS__
29926         - name: body
29927           in: body
29928           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
29929           required: true
29930           schema:
29931             $ref: "#/definitions/l3-interface-ipv4-address-list"
29932     patch:
29933       tags:
29934         - Network
29935       summary: update an existing l3-interface-ipv4-address-list
29936       description: |
29937         Update an existing l3-interface-ipv4-address-list
29938         #
29939         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29940         The PUT operation will entirely replace an existing object.
29941         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29942         #
29943         Other differences between PUT and PATCH are:
29944         #
29945         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29946         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29947         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29948       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29949       consumes:
29950         - application/json
29951         - application/xml
29952       produces:
29953         - application/json
29954         - application/xml
29955       responses:
29956         "default":
29957           description: Response codes found in [response codes](https://wiki.onap.org/).
29958       parameters:
29959         - name: equipment-name
29960           in: path
29961           required: true
29962           type: string
29963           example: __EQUIPMENT-NAME__
29964         - name: interface-name
29965           in: path
29966           description: Name that identifies the link aggregate interface
29967           required: true
29968           type: string
29969           example: __INTERFACE-NAME__
29970         - name: interface-name
29971           in: path
29972           description: Name given to the interface
29973           required: true
29974           type: string
29975           example: __INTERFACE-NAME__
29976         - name: l3-interface-ipv4-address
29977           in: path
29978           description: IP address
29979           required: true
29980           type: string
29981           example: __L3-INTERFACE-IPV4-ADDRESS__
29982         - name: body
29983           in: body
29984           description: l3-interface-ipv4-address-list object that needs to be created or updated.
29985           required: true
29986           schema:
29987             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29988     delete:
29989       tags:
29990         - Network
29991       summary: delete an existing l3-interface-ipv4-address-list
29992       description: delete an existing l3-interface-ipv4-address-list
29993       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29994       consumes:
29995         - application/json
29996         - application/xml
29997       produces:
29998         - application/json
29999         - application/xml
30000       responses:
30001         "default":
30002           description: Response codes found in [response codes](https://wiki.onap.org/).
30003       parameters:
30004         - name: equipment-name
30005           in: path
30006           required: true
30007           type: string
30008           example: __EQUIPMENT-NAME__
30009         - name: interface-name
30010           in: path
30011           description: Name that identifies the link aggregate interface
30012           required: true
30013           type: string
30014           example: __INTERFACE-NAME__
30015         - name: interface-name
30016           in: path
30017           description: Name given to the interface
30018           required: true
30019           type: string
30020           example: __INTERFACE-NAME__
30021         - name: l3-interface-ipv4-address
30022           in: path
30023           description: IP address
30024           required: true
30025           type: string
30026           example: __L3-INTERFACE-IPV4-ADDRESS__
30027         - name: resource-version
30028           in: query
30029           description: resource-version for concurrency
30030           required: true
30031           type: string
30032   /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:
30033     put:
30034       tags:
30035         - Network
30036       summary: see node definition for valid relationships
30037       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30038       consumes:
30039         - application/json
30040         - application/xml
30041       produces:
30042         - application/json
30043         - application/xml
30044       responses:
30045         "default":
30046           description: Response codes found in [response codes](https://wiki.onap.org/).
30047       parameters:
30048         - name: equipment-name
30049           in: path
30050           required: true
30051           type: string
30052           example: __EQUIPMENT-NAME__
30053         - name: interface-name
30054           in: path
30055           description: Name that identifies the link aggregate interface
30056           required: true
30057           type: string
30058           example: __INTERFACE-NAME__
30059         - name: interface-name
30060           in: path
30061           description: Name given to the interface
30062           required: true
30063           type: string
30064           example: __INTERFACE-NAME__
30065         - name: l3-interface-ipv6-address
30066           in: path
30067           description: IP address
30068           required: true
30069           type: string
30070           example: __L3-INTERFACE-IPV6-ADDRESS__
30071         - name: body
30072           in: body
30073           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30074           required: true
30075           schema:
30076             $ref: "#/definitions/relationship"
30077     delete:
30078       tags:
30079         - Network
30080       summary: delete an existing relationship
30081       description: delete an existing relationship
30082       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30083       consumes:
30084         - application/json
30085         - application/xml
30086       produces:
30087         - application/json
30088         - application/xml
30089       responses:
30090         "default":
30091           description: Response codes found in [response codes](https://wiki.onap.org/).
30092       parameters:
30093         - name: equipment-name
30094           in: path
30095           required: true
30096           type: string
30097           example: __EQUIPMENT-NAME__
30098         - name: interface-name
30099           in: path
30100           description: Name that identifies the link aggregate interface
30101           required: true
30102           type: string
30103           example: __INTERFACE-NAME__
30104         - name: interface-name
30105           in: path
30106           description: Name given to the interface
30107           required: true
30108           type: string
30109           example: __INTERFACE-NAME__
30110         - name: l3-interface-ipv6-address
30111           in: path
30112           description: IP address
30113           required: true
30114           type: string
30115           example: __L3-INTERFACE-IPV6-ADDRESS__
30116   /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}:
30117     get:
30118       tags:
30119         - Network
30120       summary: returns l3-interface-ipv6-address-list
30121       description: returns l3-interface-ipv6-address-list
30122       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30123       produces:
30124         - application/json
30125         - application/xml
30126       responses:
30127         "200":
30128           description: successful operation
30129           schema:
30130               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30131         "default":
30132           description: Response codes found in [response codes](https://wiki.onap.org/).
30133       parameters:
30134         - name: equipment-name
30135           in: path
30136           required: true
30137           type: string
30138           example: __EQUIPMENT-NAME__
30139         - name: interface-name
30140           in: path
30141           description: Name that identifies the link aggregate interface
30142           required: true
30143           type: string
30144           example: __INTERFACE-NAME__
30145         - name: interface-name
30146           in: path
30147           description: Name given to the interface
30148           required: true
30149           type: string
30150           example: __INTERFACE-NAME__
30151         - name: l3-interface-ipv6-address
30152           in: path
30153           description: IP address
30154           required: true
30155           type: string
30156           example: __L3-INTERFACE-IPV6-ADDRESS__
30157         - name: prov-status
30158           in: query
30159           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30160           required: false
30161           type: string
30162         - name: interface-id
30163           in: query
30164           description: ID of interface
30165           required: false
30166           type: string
30167         - name: interface-role
30168           in: query
30169           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30170           required: false
30171           type: string
30172         - name: interface-id
30173           in: query
30174           description: ID of interface
30175           required: false
30176           type: string
30177         - name: macaddr
30178           in: query
30179           description: MAC address for the interface
30180           required: false
30181           type: string
30182         - name: network-name
30183           in: query
30184           description: Name of the network
30185           required: false
30186           type: string
30187         - name: vlan-id-inner
30188           in: query
30189           description: Inner VLAN tag
30190           required: false
30191           type: integer
30192           format: int64
30193         - name: neutron-network-id
30194           in: query
30195           description: Neutron network id of the interface that address belongs to
30196           required: false
30197           type: string
30198         - name: neutron-subnet-id
30199           in: query
30200           description: Neutron id of subnet that address belongs to
30201           required: false
30202           type: string
30203     put:
30204       tags:
30205         - Network
30206       summary: create or update an existing l3-interface-ipv6-address-list
30207       description: |
30208         Create or update an existing l3-interface-ipv6-address-list.
30209         #
30210         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30211       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30212       consumes:
30213         - application/json
30214         - application/xml
30215       produces:
30216         - application/json
30217         - application/xml
30218       responses:
30219         "default":
30220           description: Response codes found in [response codes](https://wiki.onap.org/).
30221       parameters:
30222         - name: equipment-name
30223           in: path
30224           required: true
30225           type: string
30226           example: __EQUIPMENT-NAME__
30227         - name: interface-name
30228           in: path
30229           description: Name that identifies the link aggregate interface
30230           required: true
30231           type: string
30232           example: __INTERFACE-NAME__
30233         - name: interface-name
30234           in: path
30235           description: Name given to the interface
30236           required: true
30237           type: string
30238           example: __INTERFACE-NAME__
30239         - name: l3-interface-ipv6-address
30240           in: path
30241           description: IP address
30242           required: true
30243           type: string
30244           example: __L3-INTERFACE-IPV6-ADDRESS__
30245         - name: body
30246           in: body
30247           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30248           required: true
30249           schema:
30250             $ref: "#/definitions/l3-interface-ipv6-address-list"
30251     patch:
30252       tags:
30253         - Network
30254       summary: update an existing l3-interface-ipv6-address-list
30255       description: |
30256         Update an existing l3-interface-ipv6-address-list
30257         #
30258         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30259         The PUT operation will entirely replace an existing object.
30260         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30261         #
30262         Other differences between PUT and PATCH are:
30263         #
30264         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30265         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30266         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30267       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30268       consumes:
30269         - application/json
30270         - application/xml
30271       produces:
30272         - application/json
30273         - application/xml
30274       responses:
30275         "default":
30276           description: Response codes found in [response codes](https://wiki.onap.org/).
30277       parameters:
30278         - name: equipment-name
30279           in: path
30280           required: true
30281           type: string
30282           example: __EQUIPMENT-NAME__
30283         - name: interface-name
30284           in: path
30285           description: Name that identifies the link aggregate interface
30286           required: true
30287           type: string
30288           example: __INTERFACE-NAME__
30289         - name: interface-name
30290           in: path
30291           description: Name given to the interface
30292           required: true
30293           type: string
30294           example: __INTERFACE-NAME__
30295         - name: l3-interface-ipv6-address
30296           in: path
30297           description: IP address
30298           required: true
30299           type: string
30300           example: __L3-INTERFACE-IPV6-ADDRESS__
30301         - name: body
30302           in: body
30303           description: l3-interface-ipv6-address-list object that needs to be created or updated.
30304           required: true
30305           schema:
30306             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30307     delete:
30308       tags:
30309         - Network
30310       summary: delete an existing l3-interface-ipv6-address-list
30311       description: delete an existing l3-interface-ipv6-address-list
30312       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30313       consumes:
30314         - application/json
30315         - application/xml
30316       produces:
30317         - application/json
30318         - application/xml
30319       responses:
30320         "default":
30321           description: Response codes found in [response codes](https://wiki.onap.org/).
30322       parameters:
30323         - name: equipment-name
30324           in: path
30325           required: true
30326           type: string
30327           example: __EQUIPMENT-NAME__
30328         - name: interface-name
30329           in: path
30330           description: Name that identifies the link aggregate interface
30331           required: true
30332           type: string
30333           example: __INTERFACE-NAME__
30334         - name: interface-name
30335           in: path
30336           description: Name given to the interface
30337           required: true
30338           type: string
30339           example: __INTERFACE-NAME__
30340         - name: l3-interface-ipv6-address
30341           in: path
30342           description: IP address
30343           required: true
30344           type: string
30345           example: __L3-INTERFACE-IPV6-ADDRESS__
30346         - name: resource-version
30347           in: query
30348           description: resource-version for concurrency
30349           required: true
30350           type: string
30351   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
30352     get:
30353       tags:
30354         - Network
30355       summary: returns l-interface
30356       description: returns l-interface
30357       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30358       produces:
30359         - application/json
30360         - application/xml
30361       responses:
30362         "200":
30363           description: successful operation
30364           schema:
30365               $ref: "#/getDefinitions/l-interface"
30366         "default":
30367           description: Response codes found in [response codes](https://wiki.onap.org/).
30368       parameters:
30369         - name: equipment-name
30370           in: path
30371           required: true
30372           type: string
30373           example: __EQUIPMENT-NAME__
30374         - name: interface-name
30375           in: path
30376           description: Name that identifies the link aggregate interface
30377           required: true
30378           type: string
30379           example: __INTERFACE-NAME__
30380         - name: interface-name
30381           in: path
30382           description: Name given to the interface
30383           required: true
30384           type: string
30385           example: __INTERFACE-NAME__
30386         - name: prov-status
30387           in: query
30388           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30389           required: false
30390           type: string
30391         - name: interface-id
30392           in: query
30393           description: ID of interface
30394           required: false
30395           type: string
30396         - name: interface-role
30397           in: query
30398           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30399           required: false
30400           type: string
30401         - name: interface-id
30402           in: query
30403           description: ID of interface
30404           required: false
30405           type: string
30406         - name: macaddr
30407           in: query
30408           description: MAC address for the interface
30409           required: false
30410           type: string
30411         - name: network-name
30412           in: query
30413           description: Name of the network
30414           required: false
30415           type: string
30416     put:
30417       tags:
30418         - Network
30419       summary: create or update an existing l-interface
30420       description: |
30421         Create or update an existing l-interface.
30422         #
30423         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30424       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30425       consumes:
30426         - application/json
30427         - application/xml
30428       produces:
30429         - application/json
30430         - application/xml
30431       responses:
30432         "default":
30433           description: Response codes found in [response codes](https://wiki.onap.org/).
30434       parameters:
30435         - name: equipment-name
30436           in: path
30437           required: true
30438           type: string
30439           example: __EQUIPMENT-NAME__
30440         - name: interface-name
30441           in: path
30442           description: Name that identifies the link aggregate interface
30443           required: true
30444           type: string
30445           example: __INTERFACE-NAME__
30446         - name: interface-name
30447           in: path
30448           description: Name given to the interface
30449           required: true
30450           type: string
30451           example: __INTERFACE-NAME__
30452         - name: body
30453           in: body
30454           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
30455           required: true
30456           schema:
30457             $ref: "#/definitions/l-interface"
30458     patch:
30459       tags:
30460         - Network
30461       summary: update an existing l-interface
30462       description: |
30463         Update an existing l-interface
30464         #
30465         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30466         The PUT operation will entirely replace an existing object.
30467         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30468         #
30469         Other differences between PUT and PATCH are:
30470         #
30471         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30472         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30473         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30474       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30475       consumes:
30476         - application/json
30477         - application/xml
30478       produces:
30479         - application/json
30480         - application/xml
30481       responses:
30482         "default":
30483           description: Response codes found in [response codes](https://wiki.onap.org/).
30484       parameters:
30485         - name: equipment-name
30486           in: path
30487           required: true
30488           type: string
30489           example: __EQUIPMENT-NAME__
30490         - name: interface-name
30491           in: path
30492           description: Name that identifies the link aggregate interface
30493           required: true
30494           type: string
30495           example: __INTERFACE-NAME__
30496         - name: interface-name
30497           in: path
30498           description: Name given to the interface
30499           required: true
30500           type: string
30501           example: __INTERFACE-NAME__
30502         - name: body
30503           in: body
30504           description: l-interface object that needs to be created or updated.
30505           required: true
30506           schema:
30507             $ref: "#/patchDefinitions/l-interface"
30508     delete:
30509       tags:
30510         - Network
30511       summary: delete an existing l-interface
30512       description: delete an existing l-interface
30513       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30514       consumes:
30515         - application/json
30516         - application/xml
30517       produces:
30518         - application/json
30519         - application/xml
30520       responses:
30521         "default":
30522           description: Response codes found in [response codes](https://wiki.onap.org/).
30523       parameters:
30524         - name: equipment-name
30525           in: path
30526           required: true
30527           type: string
30528           example: __EQUIPMENT-NAME__
30529         - name: interface-name
30530           in: path
30531           description: Name that identifies the link aggregate interface
30532           required: true
30533           type: string
30534           example: __INTERFACE-NAME__
30535         - name: interface-name
30536           in: path
30537           description: Name given to the interface
30538           required: true
30539           type: string
30540           example: __INTERFACE-NAME__
30541         - name: resource-version
30542           in: query
30543           description: resource-version for concurrency
30544           required: true
30545           type: string
30546   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
30547     get:
30548       tags:
30549         - Network
30550       summary: returns l-interfaces
30551       description: returns l-interfaces
30552       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
30553       produces:
30554         - application/json
30555         - application/xml
30556       responses:
30557         "200":
30558           description: successful operation
30559           schema:
30560               $ref: "#/getDefinitions/l-interfaces"
30561         "default":
30562           description: Response codes found in [response codes](https://wiki.onap.org/).
30563       parameters:
30564         - name: equipment-name
30565           in: path
30566           required: true
30567           type: string
30568           example: __EQUIPMENT-NAME__
30569         - name: interface-name
30570           in: path
30571           description: Name that identifies the link aggregate interface
30572           required: true
30573           type: string
30574           example: __INTERFACE-NAME__
30575         - name: prov-status
30576           in: query
30577           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30578           required: false
30579           type: string
30580         - name: interface-id
30581           in: query
30582           description: ID of interface
30583           required: false
30584           type: string
30585         - name: interface-role
30586           in: query
30587           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30588           required: false
30589           type: string
30590   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
30591     get:
30592       tags:
30593         - Network
30594       summary: returns lag-interface
30595       description: returns lag-interface
30596       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
30597       produces:
30598         - application/json
30599         - application/xml
30600       responses:
30601         "200":
30602           description: successful operation
30603           schema:
30604               $ref: "#/getDefinitions/lag-interface"
30605         "default":
30606           description: Response codes found in [response codes](https://wiki.onap.org/).
30607       parameters:
30608         - name: equipment-name
30609           in: path
30610           required: true
30611           type: string
30612           example: __EQUIPMENT-NAME__
30613         - name: interface-name
30614           in: path
30615           description: Name that identifies the link aggregate interface
30616           required: true
30617           type: string
30618           example: __INTERFACE-NAME__
30619         - name: prov-status
30620           in: query
30621           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30622           required: false
30623           type: string
30624         - name: interface-id
30625           in: query
30626           description: ID of interface
30627           required: false
30628           type: string
30629         - name: interface-role
30630           in: query
30631           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30632           required: false
30633           type: string
30634     put:
30635       tags:
30636         - Network
30637       summary: create or update an existing lag-interface
30638       description: |
30639         Create or update an existing lag-interface.
30640         #
30641         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30642       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
30643       consumes:
30644         - application/json
30645         - application/xml
30646       produces:
30647         - application/json
30648         - application/xml
30649       responses:
30650         "default":
30651           description: Response codes found in [response codes](https://wiki.onap.org/).
30652       parameters:
30653         - name: equipment-name
30654           in: path
30655           required: true
30656           type: string
30657           example: __EQUIPMENT-NAME__
30658         - name: interface-name
30659           in: path
30660           description: Name that identifies the link aggregate interface
30661           required: true
30662           type: string
30663           example: __INTERFACE-NAME__
30664         - name: body
30665           in: body
30666           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
30667           required: true
30668           schema:
30669             $ref: "#/definitions/lag-interface"
30670     patch:
30671       tags:
30672         - Network
30673       summary: update an existing lag-interface
30674       description: |
30675         Update an existing lag-interface
30676         #
30677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30678         The PUT operation will entirely replace an existing object.
30679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30680         #
30681         Other differences between PUT and PATCH are:
30682         #
30683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30686       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
30687       consumes:
30688         - application/json
30689         - application/xml
30690       produces:
30691         - application/json
30692         - application/xml
30693       responses:
30694         "default":
30695           description: Response codes found in [response codes](https://wiki.onap.org/).
30696       parameters:
30697         - name: equipment-name
30698           in: path
30699           required: true
30700           type: string
30701           example: __EQUIPMENT-NAME__
30702         - name: interface-name
30703           in: path
30704           description: Name that identifies the link aggregate interface
30705           required: true
30706           type: string
30707           example: __INTERFACE-NAME__
30708         - name: body
30709           in: body
30710           description: lag-interface object that needs to be created or updated.
30711           required: true
30712           schema:
30713             $ref: "#/patchDefinitions/lag-interface"
30714     delete:
30715       tags:
30716         - Network
30717       summary: delete an existing lag-interface
30718       description: delete an existing lag-interface
30719       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
30720       consumes:
30721         - application/json
30722         - application/xml
30723       produces:
30724         - application/json
30725         - application/xml
30726       responses:
30727         "default":
30728           description: Response codes found in [response codes](https://wiki.onap.org/).
30729       parameters:
30730         - name: equipment-name
30731           in: path
30732           required: true
30733           type: string
30734           example: __EQUIPMENT-NAME__
30735         - name: interface-name
30736           in: path
30737           description: Name that identifies the link aggregate interface
30738           required: true
30739           type: string
30740           example: __INTERFACE-NAME__
30741         - name: resource-version
30742           in: query
30743           description: resource-version for concurrency
30744           required: true
30745           type: string
30746   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
30747     get:
30748       tags:
30749         - Network
30750       summary: returns lag-interfaces
30751       description: returns lag-interfaces
30752       operationId: getNetworkVplsPesVplsPeLagInterfaces
30753       produces:
30754         - application/json
30755         - application/xml
30756       responses:
30757         "200":
30758           description: successful operation
30759           schema:
30760               $ref: "#/getDefinitions/lag-interfaces"
30761         "default":
30762           description: Response codes found in [response codes](https://wiki.onap.org/).
30763       parameters:
30764         - name: equipment-name
30765           in: path
30766           required: true
30767           type: string
30768           example: __EQUIPMENT-NAME__
30769         - name: prov-status
30770           in: query
30771           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30772           required: false
30773           type: string
30774   /network/vpls-pes/vpls-pe/{equipment-name}:
30775     get:
30776       tags:
30777         - Network
30778       summary: returns vpls-pe
30779       description: returns vpls-pe
30780       operationId: getNetworkVplsPesVplsPe
30781       produces:
30782         - application/json
30783         - application/xml
30784       responses:
30785         "200":
30786           description: successful operation
30787           schema:
30788               $ref: "#/getDefinitions/vpls-pe"
30789         "default":
30790           description: Response codes found in [response codes](https://wiki.onap.org/).
30791       parameters:
30792         - name: equipment-name
30793           in: path
30794           required: true
30795           type: string
30796           example: __EQUIPMENT-NAME__
30797         - name: prov-status
30798           in: query
30799           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30800           required: false
30801           type: string
30802     put:
30803       tags:
30804         - Network
30805       summary: create or update an existing vpls-pe
30806       description: |
30807         Create or update an existing vpls-pe.
30808         #
30809         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30810       operationId: createOrUpdateNetworkVplsPesVplsPe
30811       consumes:
30812         - application/json
30813         - application/xml
30814       produces:
30815         - application/json
30816         - application/xml
30817       responses:
30818         "default":
30819           description: Response codes found in [response codes](https://wiki.onap.org/).
30820       parameters:
30821         - name: equipment-name
30822           in: path
30823           required: true
30824           type: string
30825           example: __EQUIPMENT-NAME__
30826         - name: body
30827           in: body
30828           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
30829           required: true
30830           schema:
30831             $ref: "#/definitions/vpls-pe"
30832     patch:
30833       tags:
30834         - Network
30835       summary: update an existing vpls-pe
30836       description: |
30837         Update an existing vpls-pe
30838         #
30839         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30840         The PUT operation will entirely replace an existing object.
30841         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30842         #
30843         Other differences between PUT and PATCH are:
30844         #
30845         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30846         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30847         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30848       operationId: UpdateNetworkVplsPesVplsPe
30849       consumes:
30850         - application/json
30851         - application/xml
30852       produces:
30853         - application/json
30854         - application/xml
30855       responses:
30856         "default":
30857           description: Response codes found in [response codes](https://wiki.onap.org/).
30858       parameters:
30859         - name: equipment-name
30860           in: path
30861           required: true
30862           type: string
30863           example: __EQUIPMENT-NAME__
30864         - name: body
30865           in: body
30866           description: vpls-pe object that needs to be created or updated.
30867           required: true
30868           schema:
30869             $ref: "#/patchDefinitions/vpls-pe"
30870     delete:
30871       tags:
30872         - Network
30873       summary: delete an existing vpls-pe
30874       description: delete an existing vpls-pe
30875       operationId: deleteNetworkVplsPesVplsPe
30876       consumes:
30877         - application/json
30878         - application/xml
30879       produces:
30880         - application/json
30881         - application/xml
30882       responses:
30883         "default":
30884           description: Response codes found in [response codes](https://wiki.onap.org/).
30885       parameters:
30886         - name: equipment-name
30887           in: path
30888           required: true
30889           type: string
30890           example: __EQUIPMENT-NAME__
30891         - name: resource-version
30892           in: query
30893           description: resource-version for concurrency
30894           required: true
30895           type: string
30896   /network/vpls-pes:
30897     get:
30898       tags:
30899         - Network
30900       summary: returns vpls-pes
30901       description: returns vpls-pes
30902       operationId: getNetworkVplsPes
30903       produces:
30904         - application/json
30905         - application/xml
30906       responses:
30907         "200":
30908           description: successful operation
30909           schema:
30910               $ref: "#/getDefinitions/vpls-pes"
30911         "default":
30912           description: Response codes found in [response codes](https://wiki.onap.org/).
30913   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
30914     put:
30915       tags:
30916         - Network
30917       summary: see node definition for valid relationships
30918       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
30919       consumes:
30920         - application/json
30921         - application/xml
30922       produces:
30923         - application/json
30924         - application/xml
30925       responses:
30926         "default":
30927           description: Response codes found in [response codes](https://wiki.onap.org/).
30928       parameters:
30929         - name: multicast-configuration-id
30930           in: path
30931           description: Unique id of multicast configuration.
30932           required: true
30933           type: string
30934           example: __MULTICAST-CONFIGURATION-ID__
30935         - name: body
30936           in: body
30937           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
30938           required: true
30939           schema:
30940             $ref: "#/definitions/relationship"
30941     delete:
30942       tags:
30943         - Network
30944       summary: delete an existing relationship
30945       description: delete an existing relationship
30946       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
30947       consumes:
30948         - application/json
30949         - application/xml
30950       produces:
30951         - application/json
30952         - application/xml
30953       responses:
30954         "default":
30955           description: Response codes found in [response codes](https://wiki.onap.org/).
30956       parameters:
30957         - name: multicast-configuration-id
30958           in: path
30959           description: Unique id of multicast configuration.
30960           required: true
30961           type: string
30962           example: __MULTICAST-CONFIGURATION-ID__
30963   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
30964     get:
30965       tags:
30966         - Network
30967       summary: returns multicast-configuration
30968       description: returns multicast-configuration
30969       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
30970       produces:
30971         - application/json
30972         - application/xml
30973       responses:
30974         "200":
30975           description: successful operation
30976           schema:
30977               $ref: "#/getDefinitions/multicast-configuration"
30978         "default":
30979           description: Response codes found in [response codes](https://wiki.onap.org/).
30980       parameters:
30981         - name: multicast-configuration-id
30982           in: path
30983           description: Unique id of multicast configuration.
30984           required: true
30985           type: string
30986           example: __MULTICAST-CONFIGURATION-ID__
30987     put:
30988       tags:
30989         - Network
30990       summary: create or update an existing multicast-configuration
30991       description: |
30992         Create or update an existing multicast-configuration.
30993         #
30994         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30995       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
30996       consumes:
30997         - application/json
30998         - application/xml
30999       produces:
31000         - application/json
31001         - application/xml
31002       responses:
31003         "default":
31004           description: Response codes found in [response codes](https://wiki.onap.org/).
31005       parameters:
31006         - name: multicast-configuration-id
31007           in: path
31008           description: Unique id of multicast configuration.
31009           required: true
31010           type: string
31011           example: __MULTICAST-CONFIGURATION-ID__
31012         - name: body
31013           in: body
31014           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
31015           required: true
31016           schema:
31017             $ref: "#/definitions/multicast-configuration"
31018     patch:
31019       tags:
31020         - Network
31021       summary: update an existing multicast-configuration
31022       description: |
31023         Update an existing multicast-configuration
31024         #
31025         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31026         The PUT operation will entirely replace an existing object.
31027         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31028         #
31029         Other differences between PUT and PATCH are:
31030         #
31031         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31032         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31033         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31034       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
31035       consumes:
31036         - application/json
31037         - application/xml
31038       produces:
31039         - application/json
31040         - application/xml
31041       responses:
31042         "default":
31043           description: Response codes found in [response codes](https://wiki.onap.org/).
31044       parameters:
31045         - name: multicast-configuration-id
31046           in: path
31047           description: Unique id of multicast configuration.
31048           required: true
31049           type: string
31050           example: __MULTICAST-CONFIGURATION-ID__
31051         - name: body
31052           in: body
31053           description: multicast-configuration object that needs to be created or updated.
31054           required: true
31055           schema:
31056             $ref: "#/patchDefinitions/multicast-configuration"
31057     delete:
31058       tags:
31059         - Network
31060       summary: delete an existing multicast-configuration
31061       description: delete an existing multicast-configuration
31062       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
31063       consumes:
31064         - application/json
31065         - application/xml
31066       produces:
31067         - application/json
31068         - application/xml
31069       responses:
31070         "default":
31071           description: Response codes found in [response codes](https://wiki.onap.org/).
31072       parameters:
31073         - name: multicast-configuration-id
31074           in: path
31075           description: Unique id of multicast configuration.
31076           required: true
31077           type: string
31078           example: __MULTICAST-CONFIGURATION-ID__
31079         - name: resource-version
31080           in: query
31081           description: resource-version for concurrency
31082           required: true
31083           type: string
31084   /network/multicast-configurations:
31085     get:
31086       tags:
31087         - Network
31088       summary: returns multicast-configurations
31089       description: returns multicast-configurations
31090       operationId: getNetworkMulticastConfigurations
31091       produces:
31092         - application/json
31093         - application/xml
31094       responses:
31095         "200":
31096           description: successful operation
31097           schema:
31098               $ref: "#/getDefinitions/multicast-configurations"
31099         "default":
31100           description: Response codes found in [response codes](https://wiki.onap.org/).
31101   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
31102     put:
31103       tags:
31104         - Network
31105       summary: see node definition for valid relationships
31106       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
31107       consumes:
31108         - application/json
31109         - application/xml
31110       produces:
31111         - application/json
31112         - application/xml
31113       responses:
31114         "default":
31115           description: Response codes found in [response codes](https://wiki.onap.org/).
31116       parameters:
31117         - name: vnf-id
31118           in: path
31119           description: Unique id of VNF.  This is unique across the graph.
31120           required: true
31121           type: string
31122           example: __VNF-ID__
31123         - name: interface-id
31124           in: path
31125           description: Unique ID of the interface
31126           required: true
31127           type: string
31128           example: __INTERFACE-ID__
31129         - name: cvlan-tag
31130           in: path
31131           description: See mis-na-virtualization-platform.yang
31132           required: true
31133           type: integer
31134           format: int64
31135           example: __CVLAN-TAG__
31136         - name: body
31137           in: body
31138           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
31139           required: true
31140           schema:
31141             $ref: "#/definitions/relationship"
31142     delete:
31143       tags:
31144         - Network
31145       summary: delete an existing relationship
31146       description: delete an existing relationship
31147       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
31148       consumes:
31149         - application/json
31150         - application/xml
31151       produces:
31152         - application/json
31153         - application/xml
31154       responses:
31155         "default":
31156           description: Response codes found in [response codes](https://wiki.onap.org/).
31157       parameters:
31158         - name: vnf-id
31159           in: path
31160           description: Unique id of VNF.  This is unique across the graph.
31161           required: true
31162           type: string
31163           example: __VNF-ID__
31164         - name: interface-id
31165           in: path
31166           description: Unique ID of the interface
31167           required: true
31168           type: string
31169           example: __INTERFACE-ID__
31170         - name: cvlan-tag
31171           in: path
31172           description: See mis-na-virtualization-platform.yang
31173           required: true
31174           type: integer
31175           format: int64
31176           example: __CVLAN-TAG__
31177   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
31178     get:
31179       tags:
31180         - Network
31181       summary: returns cvlan-tag-entry
31182       description: returns cvlan-tag-entry
31183       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
31184       produces:
31185         - application/json
31186         - application/xml
31187       responses:
31188         "200":
31189           description: successful operation
31190           schema:
31191               $ref: "#/getDefinitions/cvlan-tag-entry"
31192         "default":
31193           description: Response codes found in [response codes](https://wiki.onap.org/).
31194       parameters:
31195         - name: vnf-id
31196           in: path
31197           description: Unique id of VNF.  This is unique across the graph.
31198           required: true
31199           type: string
31200           example: __VNF-ID__
31201         - name: interface-id
31202           in: path
31203           description: Unique ID of the interface
31204           required: true
31205           type: string
31206           example: __INTERFACE-ID__
31207         - name: cvlan-tag
31208           in: path
31209           description: See mis-na-virtualization-platform.yang
31210           required: true
31211           type: integer
31212           format: int64
31213           example: __CVLAN-TAG__
31214         - name: vnf-name
31215           in: query
31216           description: Name of VNF.
31217           required: false
31218           type: string
31219         - name: vnf-name2
31220           in: query
31221           description: Alternate name of VNF.
31222           required: false
31223           type: string
31224         - name: vnf-type
31225           in: query
31226           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.
31227           required: false
31228           type: string
31229         - name: service-id
31230           in: query
31231           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31232           required: false
31233           type: string
31234         - name: regional-resource-zone
31235           in: query
31236           description: Regional way of organizing pservers, source of truth should define values
31237           required: false
31238           type: string
31239         - name: prov-status
31240           in: query
31241           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31242           required: false
31243           type: string
31244         - name: heat-stack-id
31245           in: query
31246           description: Heat stack id corresponding to this instance, managed by MSO
31247           required: false
31248           type: string
31249         - name: vpe-id
31250           in: query
31251           description: Unique ID of VPE connected to this VCE.
31252           required: false
31253           type: string
31254         - name: port-group-id
31255           in: query
31256           description: Unique ID for port group in vmware
31257           required: false
31258           type: string
31259         - name: switch-name
31260           in: query
31261           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
31262           required: false
31263           type: string
31264         - name: heat-stack-id
31265           in: query
31266           description: Heat stack id corresponding to this instance, managed by MSO
31267           required: false
31268           type: string
31269     put:
31270       tags:
31271         - Network
31272       summary: create or update an existing cvlan-tag-entry
31273       description: |
31274         Create or update an existing cvlan-tag-entry.
31275         #
31276         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31277       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
31278       consumes:
31279         - application/json
31280         - application/xml
31281       produces:
31282         - application/json
31283         - application/xml
31284       responses:
31285         "default":
31286           description: Response codes found in [response codes](https://wiki.onap.org/).
31287       parameters:
31288         - name: vnf-id
31289           in: path
31290           description: Unique id of VNF.  This is unique across the graph.
31291           required: true
31292           type: string
31293           example: __VNF-ID__
31294         - name: interface-id
31295           in: path
31296           description: Unique ID of the interface
31297           required: true
31298           type: string
31299           example: __INTERFACE-ID__
31300         - name: cvlan-tag
31301           in: path
31302           description: See mis-na-virtualization-platform.yang
31303           required: true
31304           type: integer
31305           format: int64
31306           example: __CVLAN-TAG__
31307         - name: body
31308           in: body
31309           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
31310           required: true
31311           schema:
31312             $ref: "#/definitions/cvlan-tag-entry"
31313     patch:
31314       tags:
31315         - Network
31316       summary: update an existing cvlan-tag-entry
31317       description: |
31318         Update an existing cvlan-tag-entry
31319         #
31320         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31321         The PUT operation will entirely replace an existing object.
31322         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31323         #
31324         Other differences between PUT and PATCH are:
31325         #
31326         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31327         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31328         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31329       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
31330       consumes:
31331         - application/json
31332         - application/xml
31333       produces:
31334         - application/json
31335         - application/xml
31336       responses:
31337         "default":
31338           description: Response codes found in [response codes](https://wiki.onap.org/).
31339       parameters:
31340         - name: vnf-id
31341           in: path
31342           description: Unique id of VNF.  This is unique across the graph.
31343           required: true
31344           type: string
31345           example: __VNF-ID__
31346         - name: interface-id
31347           in: path
31348           description: Unique ID of the interface
31349           required: true
31350           type: string
31351           example: __INTERFACE-ID__
31352         - name: cvlan-tag
31353           in: path
31354           description: See mis-na-virtualization-platform.yang
31355           required: true
31356           type: integer
31357           format: int64
31358           example: __CVLAN-TAG__
31359         - name: body
31360           in: body
31361           description: cvlan-tag-entry object that needs to be created or updated.
31362           required: true
31363           schema:
31364             $ref: "#/patchDefinitions/cvlan-tag-entry"
31365     delete:
31366       tags:
31367         - Network
31368       summary: delete an existing cvlan-tag-entry
31369       description: delete an existing cvlan-tag-entry
31370       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
31371       consumes:
31372         - application/json
31373         - application/xml
31374       produces:
31375         - application/json
31376         - application/xml
31377       responses:
31378         "default":
31379           description: Response codes found in [response codes](https://wiki.onap.org/).
31380       parameters:
31381         - name: vnf-id
31382           in: path
31383           description: Unique id of VNF.  This is unique across the graph.
31384           required: true
31385           type: string
31386           example: __VNF-ID__
31387         - name: interface-id
31388           in: path
31389           description: Unique ID of the interface
31390           required: true
31391           type: string
31392           example: __INTERFACE-ID__
31393         - name: cvlan-tag
31394           in: path
31395           description: See mis-na-virtualization-platform.yang
31396           required: true
31397           type: integer
31398           format: int64
31399           example: __CVLAN-TAG__
31400         - name: resource-version
31401           in: query
31402           description: resource-version for concurrency
31403           required: true
31404           type: string
31405   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
31406     get:
31407       tags:
31408         - Network
31409       summary: returns cvlan-tags
31410       description: returns cvlan-tags
31411       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
31412       produces:
31413         - application/json
31414         - application/xml
31415       responses:
31416         "200":
31417           description: successful operation
31418           schema:
31419               $ref: "#/getDefinitions/cvlan-tags"
31420         "default":
31421           description: Response codes found in [response codes](https://wiki.onap.org/).
31422       parameters:
31423         - name: vnf-id
31424           in: path
31425           description: Unique id of VNF.  This is unique across the graph.
31426           required: true
31427           type: string
31428           example: __VNF-ID__
31429         - name: interface-id
31430           in: path
31431           description: Unique ID of the interface
31432           required: true
31433           type: string
31434           example: __INTERFACE-ID__
31435         - name: vnf-name
31436           in: query
31437           description: Name of VNF.
31438           required: false
31439           type: string
31440         - name: vnf-name2
31441           in: query
31442           description: Alternate name of VNF.
31443           required: false
31444           type: string
31445         - name: vnf-type
31446           in: query
31447           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.
31448           required: false
31449           type: string
31450         - name: service-id
31451           in: query
31452           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31453           required: false
31454           type: string
31455         - name: regional-resource-zone
31456           in: query
31457           description: Regional way of organizing pservers, source of truth should define values
31458           required: false
31459           type: string
31460         - name: prov-status
31461           in: query
31462           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31463           required: false
31464           type: string
31465         - name: heat-stack-id
31466           in: query
31467           description: Heat stack id corresponding to this instance, managed by MSO
31468           required: false
31469           type: string
31470         - name: vpe-id
31471           in: query
31472           description: Unique ID of VPE connected to this VCE.
31473           required: false
31474           type: string
31475         - name: port-group-id
31476           in: query
31477           description: Unique ID for port group in vmware
31478           required: false
31479           type: string
31480         - name: switch-name
31481           in: query
31482           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
31483           required: false
31484           type: string
31485         - name: heat-stack-id
31486           in: query
31487           description: Heat stack id corresponding to this instance, managed by MSO
31488           required: false
31489           type: string
31490   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
31491     put:
31492       tags:
31493         - Network
31494       summary: see node definition for valid relationships
31495       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
31496       consumes:
31497         - application/json
31498         - application/xml
31499       produces:
31500         - application/json
31501         - application/xml
31502       responses:
31503         "default":
31504           description: Response codes found in [response codes](https://wiki.onap.org/).
31505       parameters:
31506         - name: vnf-id
31507           in: path
31508           description: Unique id of VNF.  This is unique across the graph.
31509           required: true
31510           type: string
31511           example: __VNF-ID__
31512         - name: interface-id
31513           in: path
31514           description: Unique ID of the interface
31515           required: true
31516           type: string
31517           example: __INTERFACE-ID__
31518         - name: body
31519           in: body
31520           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
31521           required: true
31522           schema:
31523             $ref: "#/definitions/relationship"
31524     delete:
31525       tags:
31526         - Network
31527       summary: delete an existing relationship
31528       description: delete an existing relationship
31529       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
31530       consumes:
31531         - application/json
31532         - application/xml
31533       produces:
31534         - application/json
31535         - application/xml
31536       responses:
31537         "default":
31538           description: Response codes found in [response codes](https://wiki.onap.org/).
31539       parameters:
31540         - name: vnf-id
31541           in: path
31542           description: Unique id of VNF.  This is unique across the graph.
31543           required: true
31544           type: string
31545           example: __VNF-ID__
31546         - name: interface-id
31547           in: path
31548           description: Unique ID of the interface
31549           required: true
31550           type: string
31551           example: __INTERFACE-ID__
31552   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
31553     get:
31554       tags:
31555         - Network
31556       summary: returns port-group
31557       description: returns port-group
31558       operationId: getNetworkVcesVcePortGroupsPortGroup
31559       produces:
31560         - application/json
31561         - application/xml
31562       responses:
31563         "200":
31564           description: successful operation
31565           schema:
31566               $ref: "#/getDefinitions/port-group"
31567         "default":
31568           description: Response codes found in [response codes](https://wiki.onap.org/).
31569       parameters:
31570         - name: vnf-id
31571           in: path
31572           description: Unique id of VNF.  This is unique across the graph.
31573           required: true
31574           type: string
31575           example: __VNF-ID__
31576         - name: interface-id
31577           in: path
31578           description: Unique ID of the interface
31579           required: true
31580           type: string
31581           example: __INTERFACE-ID__
31582         - name: vnf-name
31583           in: query
31584           description: Name of VNF.
31585           required: false
31586           type: string
31587         - name: vnf-name2
31588           in: query
31589           description: Alternate name of VNF.
31590           required: false
31591           type: string
31592         - name: vnf-type
31593           in: query
31594           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.
31595           required: false
31596           type: string
31597         - name: service-id
31598           in: query
31599           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31600           required: false
31601           type: string
31602         - name: regional-resource-zone
31603           in: query
31604           description: Regional way of organizing pservers, source of truth should define values
31605           required: false
31606           type: string
31607         - name: prov-status
31608           in: query
31609           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31610           required: false
31611           type: string
31612         - name: heat-stack-id
31613           in: query
31614           description: Heat stack id corresponding to this instance, managed by MSO
31615           required: false
31616           type: string
31617         - name: vpe-id
31618           in: query
31619           description: Unique ID of VPE connected to this VCE.
31620           required: false
31621           type: string
31622         - name: port-group-id
31623           in: query
31624           description: Unique ID for port group in vmware
31625           required: false
31626           type: string
31627         - name: switch-name
31628           in: query
31629           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
31630           required: false
31631           type: string
31632         - name: heat-stack-id
31633           in: query
31634           description: Heat stack id corresponding to this instance, managed by MSO
31635           required: false
31636           type: string
31637     put:
31638       tags:
31639         - Network
31640       summary: create or update an existing port-group
31641       description: |
31642         Create or update an existing port-group.
31643         #
31644         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31645       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
31646       consumes:
31647         - application/json
31648         - application/xml
31649       produces:
31650         - application/json
31651         - application/xml
31652       responses:
31653         "default":
31654           description: Response codes found in [response codes](https://wiki.onap.org/).
31655       parameters:
31656         - name: vnf-id
31657           in: path
31658           description: Unique id of VNF.  This is unique across the graph.
31659           required: true
31660           type: string
31661           example: __VNF-ID__
31662         - name: interface-id
31663           in: path
31664           description: Unique ID of the interface
31665           required: true
31666           type: string
31667           example: __INTERFACE-ID__
31668         - name: body
31669           in: body
31670           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
31671           required: true
31672           schema:
31673             $ref: "#/definitions/port-group"
31674     patch:
31675       tags:
31676         - Network
31677       summary: update an existing port-group
31678       description: |
31679         Update an existing port-group
31680         #
31681         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31682         The PUT operation will entirely replace an existing object.
31683         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31684         #
31685         Other differences between PUT and PATCH are:
31686         #
31687         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31688         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31689         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31690       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
31691       consumes:
31692         - application/json
31693         - application/xml
31694       produces:
31695         - application/json
31696         - application/xml
31697       responses:
31698         "default":
31699           description: Response codes found in [response codes](https://wiki.onap.org/).
31700       parameters:
31701         - name: vnf-id
31702           in: path
31703           description: Unique id of VNF.  This is unique across the graph.
31704           required: true
31705           type: string
31706           example: __VNF-ID__
31707         - name: interface-id
31708           in: path
31709           description: Unique ID of the interface
31710           required: true
31711           type: string
31712           example: __INTERFACE-ID__
31713         - name: body
31714           in: body
31715           description: port-group object that needs to be created or updated.
31716           required: true
31717           schema:
31718             $ref: "#/patchDefinitions/port-group"
31719     delete:
31720       tags:
31721         - Network
31722       summary: delete an existing port-group
31723       description: delete an existing port-group
31724       operationId: deleteNetworkVcesVcePortGroupsPortGroup
31725       consumes:
31726         - application/json
31727         - application/xml
31728       produces:
31729         - application/json
31730         - application/xml
31731       responses:
31732         "default":
31733           description: Response codes found in [response codes](https://wiki.onap.org/).
31734       parameters:
31735         - name: vnf-id
31736           in: path
31737           description: Unique id of VNF.  This is unique across the graph.
31738           required: true
31739           type: string
31740           example: __VNF-ID__
31741         - name: interface-id
31742           in: path
31743           description: Unique ID of the interface
31744           required: true
31745           type: string
31746           example: __INTERFACE-ID__
31747         - name: resource-version
31748           in: query
31749           description: resource-version for concurrency
31750           required: true
31751           type: string
31752   /network/vces/vce/{vnf-id}/port-groups:
31753     get:
31754       tags:
31755         - Network
31756       summary: returns port-groups
31757       description: returns port-groups
31758       operationId: getNetworkVcesVcePortGroups
31759       produces:
31760         - application/json
31761         - application/xml
31762       responses:
31763         "200":
31764           description: successful operation
31765           schema:
31766               $ref: "#/getDefinitions/port-groups"
31767         "default":
31768           description: Response codes found in [response codes](https://wiki.onap.org/).
31769       parameters:
31770         - name: vnf-id
31771           in: path
31772           description: Unique id of VNF.  This is unique across the graph.
31773           required: true
31774           type: string
31775           example: __VNF-ID__
31776         - name: vnf-name
31777           in: query
31778           description: Name of VNF.
31779           required: false
31780           type: string
31781         - name: vnf-name2
31782           in: query
31783           description: Alternate name of VNF.
31784           required: false
31785           type: string
31786         - name: vnf-type
31787           in: query
31788           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.
31789           required: false
31790           type: string
31791         - name: service-id
31792           in: query
31793           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31794           required: false
31795           type: string
31796         - name: regional-resource-zone
31797           in: query
31798           description: Regional way of organizing pservers, source of truth should define values
31799           required: false
31800           type: string
31801         - name: prov-status
31802           in: query
31803           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31804           required: false
31805           type: string
31806         - name: heat-stack-id
31807           in: query
31808           description: Heat stack id corresponding to this instance, managed by MSO
31809           required: false
31810           type: string
31811         - name: vpe-id
31812           in: query
31813           description: Unique ID of VPE connected to this VCE.
31814           required: false
31815           type: string
31816   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31817     put:
31818       tags:
31819         - Network
31820       summary: see node definition for valid relationships
31821       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
31822       consumes:
31823         - application/json
31824         - application/xml
31825       produces:
31826         - application/json
31827         - application/xml
31828       responses:
31829         "default":
31830           description: Response codes found in [response codes](https://wiki.onap.org/).
31831       parameters:
31832         - name: vnf-id
31833           in: path
31834           description: Unique id of VNF.  This is unique across the graph.
31835           required: true
31836           type: string
31837           example: __VNF-ID__
31838         - name: group-uuid
31839           in: path
31840           description: Unique ID for the license group the resource belongs to, should be uuid.
31841           required: true
31842           type: string
31843           example: __GROUP-UUID__
31844         - name: resource-uuid
31845           in: path
31846           description: Unique ID of a license resource.
31847           required: true
31848           type: string
31849           example: __RESOURCE-UUID__
31850         - name: body
31851           in: body
31852           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
31853           required: true
31854           schema:
31855             $ref: "#/definitions/relationship"
31856     delete:
31857       tags:
31858         - Network
31859       summary: delete an existing relationship
31860       description: delete an existing relationship
31861       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
31862       consumes:
31863         - application/json
31864         - application/xml
31865       produces:
31866         - application/json
31867         - application/xml
31868       responses:
31869         "default":
31870           description: Response codes found in [response codes](https://wiki.onap.org/).
31871       parameters:
31872         - name: vnf-id
31873           in: path
31874           description: Unique id of VNF.  This is unique across the graph.
31875           required: true
31876           type: string
31877           example: __VNF-ID__
31878         - name: group-uuid
31879           in: path
31880           description: Unique ID for the license group the resource belongs to, should be uuid.
31881           required: true
31882           type: string
31883           example: __GROUP-UUID__
31884         - name: resource-uuid
31885           in: path
31886           description: Unique ID of a license resource.
31887           required: true
31888           type: string
31889           example: __RESOURCE-UUID__
31890   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
31891     get:
31892       tags:
31893         - Network
31894       summary: returns license
31895       description: returns license
31896       operationId: getNetworkVcesVceLicensesLicense
31897       produces:
31898         - application/json
31899         - application/xml
31900       responses:
31901         "200":
31902           description: successful operation
31903           schema:
31904               $ref: "#/getDefinitions/license"
31905         "default":
31906           description: Response codes found in [response codes](https://wiki.onap.org/).
31907       parameters:
31908         - name: vnf-id
31909           in: path
31910           description: Unique id of VNF.  This is unique across the graph.
31911           required: true
31912           type: string
31913           example: __VNF-ID__
31914         - name: group-uuid
31915           in: path
31916           description: Unique ID for the license group the resource belongs to, should be uuid.
31917           required: true
31918           type: string
31919           example: __GROUP-UUID__
31920         - name: resource-uuid
31921           in: path
31922           description: Unique ID of a license resource.
31923           required: true
31924           type: string
31925           example: __RESOURCE-UUID__
31926         - name: vnf-name
31927           in: query
31928           description: Name of VNF.
31929           required: false
31930           type: string
31931         - name: vnf-name2
31932           in: query
31933           description: Alternate name of VNF.
31934           required: false
31935           type: string
31936         - name: vnf-type
31937           in: query
31938           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.
31939           required: false
31940           type: string
31941         - name: service-id
31942           in: query
31943           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31944           required: false
31945           type: string
31946         - name: regional-resource-zone
31947           in: query
31948           description: Regional way of organizing pservers, source of truth should define values
31949           required: false
31950           type: string
31951         - name: prov-status
31952           in: query
31953           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31954           required: false
31955           type: string
31956         - name: heat-stack-id
31957           in: query
31958           description: Heat stack id corresponding to this instance, managed by MSO
31959           required: false
31960           type: string
31961         - name: vpe-id
31962           in: query
31963           description: Unique ID of VPE connected to this VCE.
31964           required: false
31965           type: string
31966     put:
31967       tags:
31968         - Network
31969       summary: create or update an existing license
31970       description: |
31971         Create or update an existing license.
31972         #
31973         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31974       operationId: createOrUpdateNetworkVcesVceLicensesLicense
31975       consumes:
31976         - application/json
31977         - application/xml
31978       produces:
31979         - application/json
31980         - application/xml
31981       responses:
31982         "default":
31983           description: Response codes found in [response codes](https://wiki.onap.org/).
31984       parameters:
31985         - name: vnf-id
31986           in: path
31987           description: Unique id of VNF.  This is unique across the graph.
31988           required: true
31989           type: string
31990           example: __VNF-ID__
31991         - name: group-uuid
31992           in: path
31993           description: Unique ID for the license group the resource belongs to, should be uuid.
31994           required: true
31995           type: string
31996           example: __GROUP-UUID__
31997         - name: resource-uuid
31998           in: path
31999           description: Unique ID of a license resource.
32000           required: true
32001           type: string
32002           example: __RESOURCE-UUID__
32003         - name: body
32004           in: body
32005           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
32006           required: true
32007           schema:
32008             $ref: "#/definitions/license"
32009     patch:
32010       tags:
32011         - Network
32012       summary: update an existing license
32013       description: |
32014         Update an existing license
32015         #
32016         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32017         The PUT operation will entirely replace an existing object.
32018         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32019         #
32020         Other differences between PUT and PATCH are:
32021         #
32022         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32023         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32024         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32025       operationId: UpdateNetworkVcesVceLicensesLicense
32026       consumes:
32027         - application/json
32028         - application/xml
32029       produces:
32030         - application/json
32031         - application/xml
32032       responses:
32033         "default":
32034           description: Response codes found in [response codes](https://wiki.onap.org/).
32035       parameters:
32036         - name: vnf-id
32037           in: path
32038           description: Unique id of VNF.  This is unique across the graph.
32039           required: true
32040           type: string
32041           example: __VNF-ID__
32042         - name: group-uuid
32043           in: path
32044           description: Unique ID for the license group the resource belongs to, should be uuid.
32045           required: true
32046           type: string
32047           example: __GROUP-UUID__
32048         - name: resource-uuid
32049           in: path
32050           description: Unique ID of a license resource.
32051           required: true
32052           type: string
32053           example: __RESOURCE-UUID__
32054         - name: body
32055           in: body
32056           description: license object that needs to be created or updated.
32057           required: true
32058           schema:
32059             $ref: "#/patchDefinitions/license"
32060     delete:
32061       tags:
32062         - Network
32063       summary: delete an existing license
32064       description: delete an existing license
32065       operationId: deleteNetworkVcesVceLicensesLicense
32066       consumes:
32067         - application/json
32068         - application/xml
32069       produces:
32070         - application/json
32071         - application/xml
32072       responses:
32073         "default":
32074           description: Response codes found in [response codes](https://wiki.onap.org/).
32075       parameters:
32076         - name: vnf-id
32077           in: path
32078           description: Unique id of VNF.  This is unique across the graph.
32079           required: true
32080           type: string
32081           example: __VNF-ID__
32082         - name: group-uuid
32083           in: path
32084           description: Unique ID for the license group the resource belongs to, should be uuid.
32085           required: true
32086           type: string
32087           example: __GROUP-UUID__
32088         - name: resource-uuid
32089           in: path
32090           description: Unique ID of a license resource.
32091           required: true
32092           type: string
32093           example: __RESOURCE-UUID__
32094         - name: resource-version
32095           in: query
32096           description: resource-version for concurrency
32097           required: true
32098           type: string
32099   /network/vces/vce/{vnf-id}/licenses:
32100     get:
32101       tags:
32102         - Network
32103       summary: returns licenses
32104       description: returns licenses
32105       operationId: getNetworkVcesVceLicenses
32106       produces:
32107         - application/json
32108         - application/xml
32109       responses:
32110         "200":
32111           description: successful operation
32112           schema:
32113               $ref: "#/getDefinitions/licenses"
32114         "default":
32115           description: Response codes found in [response codes](https://wiki.onap.org/).
32116       parameters:
32117         - name: vnf-id
32118           in: path
32119           description: Unique id of VNF.  This is unique across the graph.
32120           required: true
32121           type: string
32122           example: __VNF-ID__
32123         - name: vnf-name
32124           in: query
32125           description: Name of VNF.
32126           required: false
32127           type: string
32128         - name: vnf-name2
32129           in: query
32130           description: Alternate name of VNF.
32131           required: false
32132           type: string
32133         - name: vnf-type
32134           in: query
32135           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.
32136           required: false
32137           type: string
32138         - name: service-id
32139           in: query
32140           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
32141           required: false
32142           type: string
32143         - name: regional-resource-zone
32144           in: query
32145           description: Regional way of organizing pservers, source of truth should define values
32146           required: false
32147           type: string
32148         - name: prov-status
32149           in: query
32150           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32151           required: false
32152           type: string
32153         - name: heat-stack-id
32154           in: query
32155           description: Heat stack id corresponding to this instance, managed by MSO
32156           required: false
32157           type: string
32158         - name: vpe-id
32159           in: query
32160           description: Unique ID of VPE connected to this VCE.
32161           required: false
32162           type: string
32163   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
32164     put:
32165       tags:
32166         - Network
32167       summary: see node definition for valid relationships
32168       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
32169       consumes:
32170         - application/json
32171         - application/xml
32172       produces:
32173         - application/json
32174         - application/xml
32175       responses:
32176         "default":
32177           description: Response codes found in [response codes](https://wiki.onap.org/).
32178       parameters:
32179         - name: vnf-id
32180           in: path
32181           description: Unique id of VNF.  This is unique across the graph.
32182           required: true
32183           type: string
32184           example: __VNF-ID__
32185         - name: group-uuid
32186           in: path
32187           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32188           required: true
32189           type: string
32190           example: __GROUP-UUID__
32191         - name: resource-uuid
32192           in: path
32193           description: Unique ID of an entitlement resource.
32194           required: true
32195           type: string
32196           example: __RESOURCE-UUID__
32197         - name: body
32198           in: body
32199           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
32200           required: true
32201           schema:
32202             $ref: "#/definitions/relationship"
32203     delete:
32204       tags:
32205         - Network
32206       summary: delete an existing relationship
32207       description: delete an existing relationship
32208       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
32209       consumes:
32210         - application/json
32211         - application/xml
32212       produces:
32213         - application/json
32214         - application/xml
32215       responses:
32216         "default":
32217           description: Response codes found in [response codes](https://wiki.onap.org/).
32218       parameters:
32219         - name: vnf-id
32220           in: path
32221           description: Unique id of VNF.  This is unique across the graph.
32222           required: true
32223           type: string
32224           example: __VNF-ID__
32225         - name: group-uuid
32226           in: path
32227           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32228           required: true
32229           type: string
32230           example: __GROUP-UUID__
32231         - name: resource-uuid
32232           in: path
32233           description: Unique ID of an entitlement resource.
32234           required: true
32235           type: string
32236           example: __RESOURCE-UUID__
32237   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
32238     get:
32239       tags:
32240         - Network
32241       summary: returns entitlement
32242       description: returns entitlement
32243       operationId: getNetworkVcesVceEntitlementsEntitlement
32244       produces:
32245         - application/json
32246         - application/xml
32247       responses:
32248         "200":
32249           description: successful operation
32250           schema:
32251               $ref: "#/getDefinitions/entitlement"
32252         "default":
32253           description: Response codes found in [response codes](https://wiki.onap.org/).
32254       parameters:
32255         - name: vnf-id
32256           in: path
32257           description: Unique id of VNF.  This is unique across the graph.
32258           required: true
32259           type: string
32260           example: __VNF-ID__
32261         - name: group-uuid
32262           in: path
32263           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32264           required: true
32265           type: string
32266           example: __GROUP-UUID__
32267         - name: resource-uuid
32268           in: path
32269           description: Unique ID of an entitlement resource.
32270           required: true
32271           type: string
32272           example: __RESOURCE-UUID__
32273         - name: vnf-name
32274           in: query
32275           description: Name of VNF.
32276           required: false
32277           type: string
32278         - name: vnf-name2
32279           in: query
32280           description: Alternate name of VNF.
32281           required: false
32282           type: string
32283         - name: vnf-type
32284           in: query
32285           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.
32286           required: false
32287           type: string
32288         - name: service-id
32289           in: query
32290           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
32291           required: false
32292           type: string
32293         - name: regional-resource-zone
32294           in: query
32295           description: Regional way of organizing pservers, source of truth should define values
32296           required: false
32297           type: string
32298         - name: prov-status
32299           in: query
32300           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32301           required: false
32302           type: string
32303         - name: heat-stack-id
32304           in: query
32305           description: Heat stack id corresponding to this instance, managed by MSO
32306           required: false
32307           type: string
32308         - name: vpe-id
32309           in: query
32310           description: Unique ID of VPE connected to this VCE.
32311           required: false
32312           type: string
32313     put:
32314       tags:
32315         - Network
32316       summary: create or update an existing entitlement
32317       description: |
32318         Create or update an existing entitlement.
32319         #
32320         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32321       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
32322       consumes:
32323         - application/json
32324         - application/xml
32325       produces:
32326         - application/json
32327         - application/xml
32328       responses:
32329         "default":
32330           description: Response codes found in [response codes](https://wiki.onap.org/).
32331       parameters:
32332         - name: vnf-id
32333           in: path
32334           description: Unique id of VNF.  This is unique across the graph.
32335           required: true
32336           type: string
32337           example: __VNF-ID__
32338         - name: group-uuid
32339           in: path
32340           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32341           required: true
32342           type: string
32343           example: __GROUP-UUID__
32344         - name: resource-uuid
32345           in: path
32346           description: Unique ID of an entitlement resource.
32347           required: true
32348           type: string
32349           example: __RESOURCE-UUID__
32350         - name: body
32351           in: body
32352           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
32353           required: true
32354           schema:
32355             $ref: "#/definitions/entitlement"
32356     patch:
32357       tags:
32358         - Network
32359       summary: update an existing entitlement
32360       description: |
32361         Update an existing entitlement
32362         #
32363         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32364         The PUT operation will entirely replace an existing object.
32365         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32366         #
32367         Other differences between PUT and PATCH are:
32368         #
32369         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32370         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32371         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32372       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
32373       consumes:
32374         - application/json
32375         - application/xml
32376       produces:
32377         - application/json
32378         - application/xml
32379       responses:
32380         "default":
32381           description: Response codes found in [response codes](https://wiki.onap.org/).
32382       parameters:
32383         - name: vnf-id
32384           in: path
32385           description: Unique id of VNF.  This is unique across the graph.
32386           required: true
32387           type: string
32388           example: __VNF-ID__
32389         - name: group-uuid
32390           in: path
32391           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32392           required: true
32393           type: string
32394           example: __GROUP-UUID__
32395         - name: resource-uuid
32396           in: path
32397           description: Unique ID of an entitlement resource.
32398           required: true
32399           type: string
32400           example: __RESOURCE-UUID__
32401         - name: body
32402           in: body
32403           description: entitlement object that needs to be created or updated.
32404           required: true
32405           schema:
32406             $ref: "#/patchDefinitions/entitlement"
32407     delete:
32408       tags:
32409         - Network
32410       summary: delete an existing entitlement
32411       description: delete an existing entitlement
32412       operationId: deleteNetworkVcesVceEntitlementsEntitlement
32413       consumes:
32414         - application/json
32415         - application/xml
32416       produces:
32417         - application/json
32418         - application/xml
32419       responses:
32420         "default":
32421           description: Response codes found in [response codes](https://wiki.onap.org/).
32422       parameters:
32423         - name: vnf-id
32424           in: path
32425           description: Unique id of VNF.  This is unique across the graph.
32426           required: true
32427           type: string
32428           example: __VNF-ID__
32429         - name: group-uuid
32430           in: path
32431           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32432           required: true
32433           type: string
32434           example: __GROUP-UUID__
32435         - name: resource-uuid
32436           in: path
32437           description: Unique ID of an entitlement resource.
32438           required: true
32439           type: string
32440           example: __RESOURCE-UUID__
32441         - name: resource-version
32442           in: query
32443           description: resource-version for concurrency
32444           required: true
32445           type: string
32446   /network/vces/vce/{vnf-id}/entitlements:
32447     get:
32448       tags:
32449         - Network
32450       summary: returns entitlements
32451       description: returns entitlements
32452       operationId: getNetworkVcesVceEntitlements
32453       produces:
32454         - application/json
32455         - application/xml
32456       responses:
32457         "200":
32458           description: successful operation
32459           schema:
32460               $ref: "#/getDefinitions/entitlements"
32461         "default":
32462           description: Response codes found in [response codes](https://wiki.onap.org/).
32463       parameters:
32464         - name: vnf-id
32465           in: path
32466           description: Unique id of VNF.  This is unique across the graph.
32467           required: true
32468           type: string
32469           example: __VNF-ID__
32470         - name: vnf-name
32471           in: query
32472           description: Name of VNF.
32473           required: false
32474           type: string
32475         - name: vnf-name2
32476           in: query
32477           description: Alternate name of VNF.
32478           required: false
32479           type: string
32480         - name: vnf-type
32481           in: query
32482           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.
32483           required: false
32484           type: string
32485         - name: service-id
32486           in: query
32487           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
32488           required: false
32489           type: string
32490         - name: regional-resource-zone
32491           in: query
32492           description: Regional way of organizing pservers, source of truth should define values
32493           required: false
32494           type: string
32495         - name: prov-status
32496           in: query
32497           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32498           required: false
32499           type: string
32500         - name: heat-stack-id
32501           in: query
32502           description: Heat stack id corresponding to this instance, managed by MSO
32503           required: false
32504           type: string
32505         - name: vpe-id
32506           in: query
32507           description: Unique ID of VPE connected to this VCE.
32508           required: false
32509           type: string
32510   /network/vces/vce/{vnf-id}/relationship-list/relationship:
32511     put:
32512       tags:
32513         - Network
32514       summary: see node definition for valid relationships
32515       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
32516       consumes:
32517         - application/json
32518         - application/xml
32519       produces:
32520         - application/json
32521         - application/xml
32522       responses:
32523         "default":
32524           description: Response codes found in [response codes](https://wiki.onap.org/).
32525       parameters:
32526         - name: vnf-id
32527           in: path
32528           description: Unique id of VNF.  This is unique across the graph.
32529           required: true
32530           type: string
32531           example: __VNF-ID__
32532         - name: body
32533           in: body
32534           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
32535           required: true
32536           schema:
32537             $ref: "#/definitions/relationship"
32538     delete:
32539       tags:
32540         - Network
32541       summary: delete an existing relationship
32542       description: delete an existing relationship
32543       operationId: deleteNetworkVcesVceRelationshipListRelationship
32544       consumes:
32545         - application/json
32546         - application/xml
32547       produces:
32548         - application/json
32549         - application/xml
32550       responses:
32551         "default":
32552           description: Response codes found in [response codes](https://wiki.onap.org/).
32553       parameters:
32554         - name: vnf-id
32555           in: path
32556           description: Unique id of VNF.  This is unique across the graph.
32557           required: true
32558           type: string
32559           example: __VNF-ID__
32560   /network/vces/vce/{vnf-id}:
32561     get:
32562       tags:
32563         - Network
32564       summary: returns vce
32565       description: returns vce
32566       operationId: getNetworkVcesVce
32567       produces:
32568         - application/json
32569         - application/xml
32570       responses:
32571         "200":
32572           description: successful operation
32573           schema:
32574               $ref: "#/getDefinitions/vce"
32575         "default":
32576           description: Response codes found in [response codes](https://wiki.onap.org/).
32577       parameters:
32578         - name: vnf-id
32579           in: path
32580           description: Unique id of VNF.  This is unique across the graph.
32581           required: true
32582           type: string
32583           example: __VNF-ID__
32584         - name: vnf-name
32585           in: query
32586           description: Name of VNF.
32587           required: false
32588           type: string
32589         - name: vnf-name2
32590           in: query
32591           description: Alternate name of VNF.
32592           required: false
32593           type: string
32594         - name: vnf-type
32595           in: query
32596           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.
32597           required: false
32598           type: string
32599         - name: service-id
32600           in: query
32601           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
32602           required: false
32603           type: string
32604         - name: regional-resource-zone
32605           in: query
32606           description: Regional way of organizing pservers, source of truth should define values
32607           required: false
32608           type: string
32609         - name: prov-status
32610           in: query
32611           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32612           required: false
32613           type: string
32614         - name: heat-stack-id
32615           in: query
32616           description: Heat stack id corresponding to this instance, managed by MSO
32617           required: false
32618           type: string
32619         - name: vpe-id
32620           in: query
32621           description: Unique ID of VPE connected to this VCE.
32622           required: false
32623           type: string
32624     put:
32625       tags:
32626         - Network
32627       summary: create or update an existing vce
32628       description: |
32629         Create or update an existing vce.
32630         #
32631         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32632       operationId: createOrUpdateNetworkVcesVce
32633       consumes:
32634         - application/json
32635         - application/xml
32636       produces:
32637         - application/json
32638         - application/xml
32639       responses:
32640         "default":
32641           description: Response codes found in [response codes](https://wiki.onap.org/).
32642       parameters:
32643         - name: vnf-id
32644           in: path
32645           description: Unique id of VNF.  This is unique across the graph.
32646           required: true
32647           type: string
32648           example: __VNF-ID__
32649         - name: body
32650           in: body
32651           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
32652           required: true
32653           schema:
32654             $ref: "#/definitions/vce"
32655     patch:
32656       tags:
32657         - Network
32658       summary: update an existing vce
32659       description: |
32660         Update an existing vce
32661         #
32662         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32663         The PUT operation will entirely replace an existing object.
32664         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32665         #
32666         Other differences between PUT and PATCH are:
32667         #
32668         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32669         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32670         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32671       operationId: UpdateNetworkVcesVce
32672       consumes:
32673         - application/json
32674         - application/xml
32675       produces:
32676         - application/json
32677         - application/xml
32678       responses:
32679         "default":
32680           description: Response codes found in [response codes](https://wiki.onap.org/).
32681       parameters:
32682         - name: vnf-id
32683           in: path
32684           description: Unique id of VNF.  This is unique across the graph.
32685           required: true
32686           type: string
32687           example: __VNF-ID__
32688         - name: body
32689           in: body
32690           description: vce object that needs to be created or updated.
32691           required: true
32692           schema:
32693             $ref: "#/patchDefinitions/vce"
32694     delete:
32695       tags:
32696         - Network
32697       summary: delete an existing vce
32698       description: delete an existing vce
32699       operationId: deleteNetworkVcesVce
32700       consumes:
32701         - application/json
32702         - application/xml
32703       produces:
32704         - application/json
32705         - application/xml
32706       responses:
32707         "default":
32708           description: Response codes found in [response codes](https://wiki.onap.org/).
32709       parameters:
32710         - name: vnf-id
32711           in: path
32712           description: Unique id of VNF.  This is unique across the graph.
32713           required: true
32714           type: string
32715           example: __VNF-ID__
32716         - name: resource-version
32717           in: query
32718           description: resource-version for concurrency
32719           required: true
32720           type: string
32721   /network/vces:
32722     get:
32723       tags:
32724         - Network
32725       summary: returns vces
32726       description: returns vces
32727       operationId: getNetworkVces
32728       produces:
32729         - application/json
32730         - application/xml
32731       responses:
32732         "200":
32733           description: successful operation
32734           schema:
32735               $ref: "#/getDefinitions/vces"
32736         "default":
32737           description: Response codes found in [response codes](https://wiki.onap.org/).
32738   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
32739     put:
32740       tags:
32741         - Network
32742       summary: see node definition for valid relationships
32743       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
32744       consumes:
32745         - application/json
32746         - application/xml
32747       produces:
32748         - application/json
32749         - application/xml
32750       responses:
32751         "default":
32752           description: Response codes found in [response codes](https://wiki.onap.org/).
32753       parameters:
32754         - name: vnfc-name
32755           in: path
32756           description: Unique ID of vnfc.
32757           required: true
32758           type: string
32759           example: __VNFC-NAME__
32760         - name: body
32761           in: body
32762           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
32763           required: true
32764           schema:
32765             $ref: "#/definitions/relationship"
32766     delete:
32767       tags:
32768         - Network
32769       summary: delete an existing relationship
32770       description: delete an existing relationship
32771       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
32772       consumes:
32773         - application/json
32774         - application/xml
32775       produces:
32776         - application/json
32777         - application/xml
32778       responses:
32779         "default":
32780           description: Response codes found in [response codes](https://wiki.onap.org/).
32781       parameters:
32782         - name: vnfc-name
32783           in: path
32784           description: Unique ID of vnfc.
32785           required: true
32786           type: string
32787           example: __VNFC-NAME__
32788   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32789     put:
32790       tags:
32791         - Network
32792       summary: see node definition for valid relationships
32793       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
32794       consumes:
32795         - application/json
32796         - application/xml
32797       produces:
32798         - application/json
32799         - application/xml
32800       responses:
32801         "default":
32802           description: Response codes found in [response codes](https://wiki.onap.org/).
32803       parameters:
32804         - name: vnfc-name
32805           in: path
32806           description: Unique ID of vnfc.
32807           required: true
32808           type: string
32809           example: __VNFC-NAME__
32810         - name: l3-interface-ipv4-address
32811           in: path
32812           description: IP address
32813           required: true
32814           type: string
32815           example: __L3-INTERFACE-IPV4-ADDRESS__
32816         - name: body
32817           in: body
32818           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
32819           required: true
32820           schema:
32821             $ref: "#/definitions/relationship"
32822     delete:
32823       tags:
32824         - Network
32825       summary: delete an existing relationship
32826       description: delete an existing relationship
32827       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
32828       consumes:
32829         - application/json
32830         - application/xml
32831       produces:
32832         - application/json
32833         - application/xml
32834       responses:
32835         "default":
32836           description: Response codes found in [response codes](https://wiki.onap.org/).
32837       parameters:
32838         - name: vnfc-name
32839           in: path
32840           description: Unique ID of vnfc.
32841           required: true
32842           type: string
32843           example: __VNFC-NAME__
32844         - name: l3-interface-ipv4-address
32845           in: path
32846           description: IP address
32847           required: true
32848           type: string
32849           example: __L3-INTERFACE-IPV4-ADDRESS__
32850   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32851     get:
32852       tags:
32853         - Network
32854       summary: returns l3-interface-ipv4-address-list
32855       description: returns l3-interface-ipv4-address-list
32856       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32857       produces:
32858         - application/json
32859         - application/xml
32860       responses:
32861         "200":
32862           description: successful operation
32863           schema:
32864               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
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-ipv4-address
32875           in: path
32876           description: IP address
32877           required: true
32878           type: string
32879           example: __L3-INTERFACE-IPV4-ADDRESS__
32880         - name: nfc-naming-code
32881           in: query
32882           description: Short code that is used in naming instances of the item being modeled
32883           required: false
32884           type: string
32885         - name: nfc-function
32886           in: query
32887           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32888           required: false
32889           type: string
32890         - name: prov-status
32891           in: query
32892           description: prov status of this vnfc
32893           required: false
32894           type: string
32895         - name: ipaddress-v4-oam-vip
32896           in: query
32897           description: Oam V4 vip address of this vnfc
32898           required: false
32899           type: string
32900         - name: in-maint
32901           in: query
32902           required: false
32903           type: boolean
32904         - name: is-closed-loop-disabled
32905           in: query
32906           required: false
32907           type: boolean
32908         - name: group-notation
32909           in: query
32910           description: Group notation of VNFC
32911           required: false
32912           type: string
32913         - name: model-invariant-id
32914           in: query
32915           description: the ASDC model id for this resource or service model.
32916           required: false
32917           type: string
32918         - name: model-version-id
32919           in: query
32920           description: the ASDC model version for this resource or service model.
32921           required: false
32922           type: string
32923         - name: vlan-id-inner
32924           in: query
32925           description: Inner VLAN tag
32926           required: false
32927           type: integer
32928           format: int64
32929         - name: neutron-network-id
32930           in: query
32931           description: Neutron network id of the interface that address belongs to
32932           required: false
32933           type: string
32934         - name: neutron-subnet-id
32935           in: query
32936           description: Neutron id of subnet that address belongs to
32937           required: false
32938           type: string
32939     put:
32940       tags:
32941         - Network
32942       summary: create or update an existing l3-interface-ipv4-address-list
32943       description: |
32944         Create or update an existing l3-interface-ipv4-address-list.
32945         #
32946         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32947       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32948       consumes:
32949         - application/json
32950         - application/xml
32951       produces:
32952         - application/json
32953         - application/xml
32954       responses:
32955         "default":
32956           description: Response codes found in [response codes](https://wiki.onap.org/).
32957       parameters:
32958         - name: vnfc-name
32959           in: path
32960           description: Unique ID of vnfc.
32961           required: true
32962           type: string
32963           example: __VNFC-NAME__
32964         - name: l3-interface-ipv4-address
32965           in: path
32966           description: IP address
32967           required: true
32968           type: string
32969           example: __L3-INTERFACE-IPV4-ADDRESS__
32970         - name: body
32971           in: body
32972           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
32973           required: true
32974           schema:
32975             $ref: "#/definitions/l3-interface-ipv4-address-list"
32976     patch:
32977       tags:
32978         - Network
32979       summary: update an existing l3-interface-ipv4-address-list
32980       description: |
32981         Update an existing l3-interface-ipv4-address-list
32982         #
32983         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32984         The PUT operation will entirely replace an existing object.
32985         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32986         #
32987         Other differences between PUT and PATCH are:
32988         #
32989         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32990         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32991         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32992       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32993       consumes:
32994         - application/json
32995         - application/xml
32996       produces:
32997         - application/json
32998         - application/xml
32999       responses:
33000         "default":
33001           description: Response codes found in [response codes](https://wiki.onap.org/).
33002       parameters:
33003         - name: vnfc-name
33004           in: path
33005           description: Unique ID of vnfc.
33006           required: true
33007           type: string
33008           example: __VNFC-NAME__
33009         - name: l3-interface-ipv4-address
33010           in: path
33011           description: IP address
33012           required: true
33013           type: string
33014           example: __L3-INTERFACE-IPV4-ADDRESS__
33015         - name: body
33016           in: body
33017           description: l3-interface-ipv4-address-list object that needs to be created or updated.
33018           required: true
33019           schema:
33020             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33021     delete:
33022       tags:
33023         - Network
33024       summary: delete an existing l3-interface-ipv4-address-list
33025       description: delete an existing l3-interface-ipv4-address-list
33026       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
33027       consumes:
33028         - application/json
33029         - application/xml
33030       produces:
33031         - application/json
33032         - application/xml
33033       responses:
33034         "default":
33035           description: Response codes found in [response codes](https://wiki.onap.org/).
33036       parameters:
33037         - name: vnfc-name
33038           in: path
33039           description: Unique ID of vnfc.
33040           required: true
33041           type: string
33042           example: __VNFC-NAME__
33043         - name: l3-interface-ipv4-address
33044           in: path
33045           description: IP address
33046           required: true
33047           type: string
33048           example: __L3-INTERFACE-IPV4-ADDRESS__
33049         - name: resource-version
33050           in: query
33051           description: resource-version for concurrency
33052           required: true
33053           type: string
33054   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33055     put:
33056       tags:
33057         - Network
33058       summary: see node definition for valid relationships
33059       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
33060       consumes:
33061         - application/json
33062         - application/xml
33063       produces:
33064         - application/json
33065         - application/xml
33066       responses:
33067         "default":
33068           description: Response codes found in [response codes](https://wiki.onap.org/).
33069       parameters:
33070         - name: vnfc-name
33071           in: path
33072           description: Unique ID of vnfc.
33073           required: true
33074           type: string
33075           example: __VNFC-NAME__
33076         - name: l3-interface-ipv6-address
33077           in: path
33078           description: IP address
33079           required: true
33080           type: string
33081           example: __L3-INTERFACE-IPV6-ADDRESS__
33082         - name: body
33083           in: body
33084           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
33085           required: true
33086           schema:
33087             $ref: "#/definitions/relationship"
33088     delete:
33089       tags:
33090         - Network
33091       summary: delete an existing relationship
33092       description: delete an existing relationship
33093       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
33094       consumes:
33095         - application/json
33096         - application/xml
33097       produces:
33098         - application/json
33099         - application/xml
33100       responses:
33101         "default":
33102           description: Response codes found in [response codes](https://wiki.onap.org/).
33103       parameters:
33104         - name: vnfc-name
33105           in: path
33106           description: Unique ID of vnfc.
33107           required: true
33108           type: string
33109           example: __VNFC-NAME__
33110         - name: l3-interface-ipv6-address
33111           in: path
33112           description: IP address
33113           required: true
33114           type: string
33115           example: __L3-INTERFACE-IPV6-ADDRESS__
33116   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33117     get:
33118       tags:
33119         - Network
33120       summary: returns l3-interface-ipv6-address-list
33121       description: returns l3-interface-ipv6-address-list
33122       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
33123       produces:
33124         - application/json
33125         - application/xml
33126       responses:
33127         "200":
33128           description: successful operation
33129           schema:
33130               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33131         "default":
33132           description: Response codes found in [response codes](https://wiki.onap.org/).
33133       parameters:
33134         - name: vnfc-name
33135           in: path
33136           description: Unique ID of vnfc.
33137           required: true
33138           type: string
33139           example: __VNFC-NAME__
33140         - name: l3-interface-ipv6-address
33141           in: path
33142           description: IP address
33143           required: true
33144           type: string
33145           example: __L3-INTERFACE-IPV6-ADDRESS__
33146         - name: nfc-naming-code
33147           in: query
33148           description: Short code that is used in naming instances of the item being modeled
33149           required: false
33150           type: string
33151         - name: nfc-function
33152           in: query
33153           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
33154           required: false
33155           type: string
33156         - name: prov-status
33157           in: query
33158           description: prov status of this vnfc
33159           required: false
33160           type: string
33161         - name: ipaddress-v4-oam-vip
33162           in: query
33163           description: Oam V4 vip address of this vnfc
33164           required: false
33165           type: string
33166         - name: in-maint
33167           in: query
33168           required: false
33169           type: boolean
33170         - name: is-closed-loop-disabled
33171           in: query
33172           required: false
33173           type: boolean
33174         - name: group-notation
33175           in: query
33176           description: Group notation of VNFC
33177           required: false
33178           type: string
33179         - name: model-invariant-id
33180           in: query
33181           description: the ASDC model id for this resource or service model.
33182           required: false
33183           type: string
33184         - name: model-version-id
33185           in: query
33186           description: the ASDC model version for this resource or service model.
33187           required: false
33188           type: string
33189         - name: vlan-id-inner
33190           in: query
33191           description: Inner VLAN tag
33192           required: false
33193           type: integer
33194           format: int64
33195         - name: neutron-network-id
33196           in: query
33197           description: Neutron network id of the interface that address belongs to
33198           required: false
33199           type: string
33200         - name: neutron-subnet-id
33201           in: query
33202           description: Neutron id of subnet that address belongs to
33203           required: false
33204           type: string
33205     put:
33206       tags:
33207         - Network
33208       summary: create or update an existing l3-interface-ipv6-address-list
33209       description: |
33210         Create or update an existing l3-interface-ipv6-address-list.
33211         #
33212         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33213       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
33214       consumes:
33215         - application/json
33216         - application/xml
33217       produces:
33218         - application/json
33219         - application/xml
33220       responses:
33221         "default":
33222           description: Response codes found in [response codes](https://wiki.onap.org/).
33223       parameters:
33224         - name: vnfc-name
33225           in: path
33226           description: Unique ID of vnfc.
33227           required: true
33228           type: string
33229           example: __VNFC-NAME__
33230         - name: l3-interface-ipv6-address
33231           in: path
33232           description: IP address
33233           required: true
33234           type: string
33235           example: __L3-INTERFACE-IPV6-ADDRESS__
33236         - name: body
33237           in: body
33238           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
33239           required: true
33240           schema:
33241             $ref: "#/definitions/l3-interface-ipv6-address-list"
33242     patch:
33243       tags:
33244         - Network
33245       summary: update an existing l3-interface-ipv6-address-list
33246       description: |
33247         Update an existing l3-interface-ipv6-address-list
33248         #
33249         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33250         The PUT operation will entirely replace an existing object.
33251         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33252         #
33253         Other differences between PUT and PATCH are:
33254         #
33255         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33256         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33257         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33258       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
33259       consumes:
33260         - application/json
33261         - application/xml
33262       produces:
33263         - application/json
33264         - application/xml
33265       responses:
33266         "default":
33267           description: Response codes found in [response codes](https://wiki.onap.org/).
33268       parameters:
33269         - name: vnfc-name
33270           in: path
33271           description: Unique ID of vnfc.
33272           required: true
33273           type: string
33274           example: __VNFC-NAME__
33275         - name: l3-interface-ipv6-address
33276           in: path
33277           description: IP address
33278           required: true
33279           type: string
33280           example: __L3-INTERFACE-IPV6-ADDRESS__
33281         - name: body
33282           in: body
33283           description: l3-interface-ipv6-address-list object that needs to be created or updated.
33284           required: true
33285           schema:
33286             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33287     delete:
33288       tags:
33289         - Network
33290       summary: delete an existing l3-interface-ipv6-address-list
33291       description: delete an existing l3-interface-ipv6-address-list
33292       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
33293       consumes:
33294         - application/json
33295         - application/xml
33296       produces:
33297         - application/json
33298         - application/xml
33299       responses:
33300         "default":
33301           description: Response codes found in [response codes](https://wiki.onap.org/).
33302       parameters:
33303         - name: vnfc-name
33304           in: path
33305           description: Unique ID of vnfc.
33306           required: true
33307           type: string
33308           example: __VNFC-NAME__
33309         - name: l3-interface-ipv6-address
33310           in: path
33311           description: IP address
33312           required: true
33313           type: string
33314           example: __L3-INTERFACE-IPV6-ADDRESS__
33315         - name: resource-version
33316           in: query
33317           description: resource-version for concurrency
33318           required: true
33319           type: string
33320   /network/vnfcs/vnfc/{vnfc-name}:
33321     get:
33322       tags:
33323         - Network
33324       summary: returns vnfc
33325       description: returns vnfc
33326       operationId: getNetworkVnfcsVnfc
33327       produces:
33328         - application/json
33329         - application/xml
33330       responses:
33331         "200":
33332           description: successful operation
33333           schema:
33334               $ref: "#/getDefinitions/vnfc"
33335         "default":
33336           description: Response codes found in [response codes](https://wiki.onap.org/).
33337       parameters:
33338         - name: vnfc-name
33339           in: path
33340           description: Unique ID of vnfc.
33341           required: true
33342           type: string
33343           example: __VNFC-NAME__
33344         - name: nfc-naming-code
33345           in: query
33346           description: Short code that is used in naming instances of the item being modeled
33347           required: false
33348           type: string
33349         - name: nfc-function
33350           in: query
33351           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
33352           required: false
33353           type: string
33354         - name: prov-status
33355           in: query
33356           description: prov status of this vnfc
33357           required: false
33358           type: string
33359         - name: ipaddress-v4-oam-vip
33360           in: query
33361           description: Oam V4 vip address of this vnfc
33362           required: false
33363           type: string
33364         - name: in-maint
33365           in: query
33366           required: false
33367           type: boolean
33368         - name: is-closed-loop-disabled
33369           in: query
33370           required: false
33371           type: boolean
33372         - name: group-notation
33373           in: query
33374           description: Group notation of VNFC
33375           required: false
33376           type: string
33377         - name: model-invariant-id
33378           in: query
33379           description: the ASDC model id for this resource or service model.
33380           required: false
33381           type: string
33382         - name: model-version-id
33383           in: query
33384           description: the ASDC model version for this resource or service model.
33385           required: false
33386           type: string
33387     put:
33388       tags:
33389         - Network
33390       summary: create or update an existing vnfc
33391       description: |
33392         Create or update an existing vnfc.
33393         #
33394         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33395       operationId: createOrUpdateNetworkVnfcsVnfc
33396       consumes:
33397         - application/json
33398         - application/xml
33399       produces:
33400         - application/json
33401         - application/xml
33402       responses:
33403         "default":
33404           description: Response codes found in [response codes](https://wiki.onap.org/).
33405       parameters:
33406         - name: vnfc-name
33407           in: path
33408           description: Unique ID of vnfc.
33409           required: true
33410           type: string
33411           example: __VNFC-NAME__
33412         - name: body
33413           in: body
33414           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
33415           required: true
33416           schema:
33417             $ref: "#/definitions/vnfc"
33418     patch:
33419       tags:
33420         - Network
33421       summary: update an existing vnfc
33422       description: |
33423         Update an existing vnfc
33424         #
33425         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33426         The PUT operation will entirely replace an existing object.
33427         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33428         #
33429         Other differences between PUT and PATCH are:
33430         #
33431         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33432         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33433         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33434       operationId: UpdateNetworkVnfcsVnfc
33435       consumes:
33436         - application/json
33437         - application/xml
33438       produces:
33439         - application/json
33440         - application/xml
33441       responses:
33442         "default":
33443           description: Response codes found in [response codes](https://wiki.onap.org/).
33444       parameters:
33445         - name: vnfc-name
33446           in: path
33447           description: Unique ID of vnfc.
33448           required: true
33449           type: string
33450           example: __VNFC-NAME__
33451         - name: body
33452           in: body
33453           description: vnfc object that needs to be created or updated.
33454           required: true
33455           schema:
33456             $ref: "#/patchDefinitions/vnfc"
33457     delete:
33458       tags:
33459         - Network
33460       summary: delete an existing vnfc
33461       description: delete an existing vnfc
33462       operationId: deleteNetworkVnfcsVnfc
33463       consumes:
33464         - application/json
33465         - application/xml
33466       produces:
33467         - application/json
33468         - application/xml
33469       responses:
33470         "default":
33471           description: Response codes found in [response codes](https://wiki.onap.org/).
33472       parameters:
33473         - name: vnfc-name
33474           in: path
33475           description: Unique ID of vnfc.
33476           required: true
33477           type: string
33478           example: __VNFC-NAME__
33479         - name: resource-version
33480           in: query
33481           description: resource-version for concurrency
33482           required: true
33483           type: string
33484   /network/vnfcs:
33485     get:
33486       tags:
33487         - Network
33488       summary: returns vnfcs
33489       description: returns vnfcs
33490       operationId: getNetworkVnfcs
33491       produces:
33492         - application/json
33493         - application/xml
33494       responses:
33495         "200":
33496           description: successful operation
33497           schema:
33498               $ref: "#/getDefinitions/vnfcs"
33499         "default":
33500           description: Response codes found in [response codes](https://wiki.onap.org/).
33501   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
33502     put:
33503       tags:
33504         - Network
33505       summary: see node definition for valid relationships
33506       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
33507       consumes:
33508         - application/json
33509         - application/xml
33510       produces:
33511         - application/json
33512         - application/xml
33513       responses:
33514         "default":
33515           description: Response codes found in [response codes](https://wiki.onap.org/).
33516       parameters:
33517         - name: network-id
33518           in: path
33519           description: Network ID, should be uuid. Unique across A&AI.
33520           required: true
33521           type: string
33522           example: __NETWORK-ID__
33523         - name: subnet-id
33524           in: path
33525           description: Subnet ID, should be UUID.
33526           required: true
33527           type: string
33528           example: __SUBNET-ID__
33529         - name: host-route-id
33530           in: path
33531           description: host-route id
33532           required: true
33533           type: string
33534           example: __HOST-ROUTE-ID__
33535         - name: body
33536           in: body
33537           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
33538           required: true
33539           schema:
33540             $ref: "#/definitions/relationship"
33541     delete:
33542       tags:
33543         - Network
33544       summary: delete an existing relationship
33545       description: delete an existing relationship
33546       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
33547       consumes:
33548         - application/json
33549         - application/xml
33550       produces:
33551         - application/json
33552         - application/xml
33553       responses:
33554         "default":
33555           description: Response codes found in [response codes](https://wiki.onap.org/).
33556       parameters:
33557         - name: network-id
33558           in: path
33559           description: Network ID, should be uuid. Unique across A&AI.
33560           required: true
33561           type: string
33562           example: __NETWORK-ID__
33563         - name: subnet-id
33564           in: path
33565           description: Subnet ID, should be UUID.
33566           required: true
33567           type: string
33568           example: __SUBNET-ID__
33569         - name: host-route-id
33570           in: path
33571           description: host-route id
33572           required: true
33573           type: string
33574           example: __HOST-ROUTE-ID__
33575   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
33576     get:
33577       tags:
33578         - Network
33579       summary: returns host-route
33580       description: returns host-route
33581       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33582       produces:
33583         - application/json
33584         - application/xml
33585       responses:
33586         "200":
33587           description: successful operation
33588           schema:
33589               $ref: "#/getDefinitions/host-route"
33590         "default":
33591           description: Response codes found in [response codes](https://wiki.onap.org/).
33592       parameters:
33593         - name: network-id
33594           in: path
33595           description: Network ID, should be uuid. Unique across A&AI.
33596           required: true
33597           type: string
33598           example: __NETWORK-ID__
33599         - name: subnet-id
33600           in: path
33601           description: Subnet ID, should be UUID.
33602           required: true
33603           type: string
33604           example: __SUBNET-ID__
33605         - name: host-route-id
33606           in: path
33607           description: host-route id
33608           required: true
33609           type: string
33610           example: __HOST-ROUTE-ID__
33611         - name: network-name
33612           in: query
33613           description: Name of the network, governed by some naming convention..
33614           required: false
33615           type: string
33616         - name: network-role
33617           in: query
33618           description: Role the network plans - who defines these values?
33619           required: false
33620           type: string
33621         - name: service-id
33622           in: query
33623           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33624           required: false
33625           type: string
33626         - name: heat-stack-id
33627           in: query
33628           description: Heat stack id corresponding to this instance, managed by MSO
33629           required: false
33630           type: string
33631         - name: contrail-network-fqdn
33632           in: query
33633           description: Contrail FQDN for the network
33634           required: false
33635           type: string
33636         - name: model-invariant-id
33637           in: query
33638           description: the ASDC model id for this resource or service model.
33639           required: false
33640           type: string
33641         - name: model-version-id
33642           in: query
33643           description: the ASDC model version for this resource or service model.
33644           required: false
33645           type: string
33646         - name: widget-model-id
33647           in: query
33648           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33649           required: false
33650           type: string
33651         - name: widget-model-version
33652           in: query
33653           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33654           required: false
33655           type: string
33656         - name: subnet-name
33657           in: query
33658           description: Name associated with the subnet.
33659           required: false
33660           type: string
33661     put:
33662       tags:
33663         - Network
33664       summary: create or update an existing host-route
33665       description: |
33666         Create or update an existing host-route.
33667         #
33668         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33669       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33670       consumes:
33671         - application/json
33672         - application/xml
33673       produces:
33674         - application/json
33675         - application/xml
33676       responses:
33677         "default":
33678           description: Response codes found in [response codes](https://wiki.onap.org/).
33679       parameters:
33680         - name: network-id
33681           in: path
33682           description: Network ID, should be uuid. Unique across A&AI.
33683           required: true
33684           type: string
33685           example: __NETWORK-ID__
33686         - name: subnet-id
33687           in: path
33688           description: Subnet ID, should be UUID.
33689           required: true
33690           type: string
33691           example: __SUBNET-ID__
33692         - name: host-route-id
33693           in: path
33694           description: host-route id
33695           required: true
33696           type: string
33697           example: __HOST-ROUTE-ID__
33698         - name: body
33699           in: body
33700           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
33701           required: true
33702           schema:
33703             $ref: "#/definitions/host-route"
33704     patch:
33705       tags:
33706         - Network
33707       summary: update an existing host-route
33708       description: |
33709         Update an existing host-route
33710         #
33711         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33712         The PUT operation will entirely replace an existing object.
33713         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33714         #
33715         Other differences between PUT and PATCH are:
33716         #
33717         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33718         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33719         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33720       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33721       consumes:
33722         - application/json
33723         - application/xml
33724       produces:
33725         - application/json
33726         - application/xml
33727       responses:
33728         "default":
33729           description: Response codes found in [response codes](https://wiki.onap.org/).
33730       parameters:
33731         - name: network-id
33732           in: path
33733           description: Network ID, should be uuid. Unique across A&AI.
33734           required: true
33735           type: string
33736           example: __NETWORK-ID__
33737         - name: subnet-id
33738           in: path
33739           description: Subnet ID, should be UUID.
33740           required: true
33741           type: string
33742           example: __SUBNET-ID__
33743         - name: host-route-id
33744           in: path
33745           description: host-route id
33746           required: true
33747           type: string
33748           example: __HOST-ROUTE-ID__
33749         - name: body
33750           in: body
33751           description: host-route object that needs to be created or updated.
33752           required: true
33753           schema:
33754             $ref: "#/patchDefinitions/host-route"
33755     delete:
33756       tags:
33757         - Network
33758       summary: delete an existing host-route
33759       description: delete an existing host-route
33760       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33761       consumes:
33762         - application/json
33763         - application/xml
33764       produces:
33765         - application/json
33766         - application/xml
33767       responses:
33768         "default":
33769           description: Response codes found in [response codes](https://wiki.onap.org/).
33770       parameters:
33771         - name: network-id
33772           in: path
33773           description: Network ID, should be uuid. Unique across A&AI.
33774           required: true
33775           type: string
33776           example: __NETWORK-ID__
33777         - name: subnet-id
33778           in: path
33779           description: Subnet ID, should be UUID.
33780           required: true
33781           type: string
33782           example: __SUBNET-ID__
33783         - name: host-route-id
33784           in: path
33785           description: host-route id
33786           required: true
33787           type: string
33788           example: __HOST-ROUTE-ID__
33789         - name: resource-version
33790           in: query
33791           description: resource-version for concurrency
33792           required: true
33793           type: string
33794   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
33795     get:
33796       tags:
33797         - Network
33798       summary: returns host-routes
33799       description: returns host-routes
33800       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
33801       produces:
33802         - application/json
33803         - application/xml
33804       responses:
33805         "200":
33806           description: successful operation
33807           schema:
33808               $ref: "#/getDefinitions/host-routes"
33809         "default":
33810           description: Response codes found in [response codes](https://wiki.onap.org/).
33811       parameters:
33812         - name: network-id
33813           in: path
33814           description: Network ID, should be uuid. Unique across A&AI.
33815           required: true
33816           type: string
33817           example: __NETWORK-ID__
33818         - name: subnet-id
33819           in: path
33820           description: Subnet ID, should be UUID.
33821           required: true
33822           type: string
33823           example: __SUBNET-ID__
33824         - name: network-name
33825           in: query
33826           description: Name of the network, governed by some naming convention..
33827           required: false
33828           type: string
33829         - name: network-role
33830           in: query
33831           description: Role the network plans - who defines these values?
33832           required: false
33833           type: string
33834         - name: service-id
33835           in: query
33836           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33837           required: false
33838           type: string
33839         - name: heat-stack-id
33840           in: query
33841           description: Heat stack id corresponding to this instance, managed by MSO
33842           required: false
33843           type: string
33844         - name: contrail-network-fqdn
33845           in: query
33846           description: Contrail FQDN for the network
33847           required: false
33848           type: string
33849         - name: model-invariant-id
33850           in: query
33851           description: the ASDC model id for this resource or service model.
33852           required: false
33853           type: string
33854         - name: model-version-id
33855           in: query
33856           description: the ASDC model version for this resource or service model.
33857           required: false
33858           type: string
33859         - name: widget-model-id
33860           in: query
33861           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33862           required: false
33863           type: string
33864         - name: widget-model-version
33865           in: query
33866           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33867           required: false
33868           type: string
33869         - name: subnet-name
33870           in: query
33871           description: Name associated with the subnet.
33872           required: false
33873           type: string
33874   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
33875     put:
33876       tags:
33877         - Network
33878       summary: see node definition for valid relationships
33879       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
33880       consumes:
33881         - application/json
33882         - application/xml
33883       produces:
33884         - application/json
33885         - application/xml
33886       responses:
33887         "default":
33888           description: Response codes found in [response codes](https://wiki.onap.org/).
33889       parameters:
33890         - name: network-id
33891           in: path
33892           description: Network ID, should be uuid. Unique across A&AI.
33893           required: true
33894           type: string
33895           example: __NETWORK-ID__
33896         - name: subnet-id
33897           in: path
33898           description: Subnet ID, should be UUID.
33899           required: true
33900           type: string
33901           example: __SUBNET-ID__
33902         - name: body
33903           in: body
33904           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
33905           required: true
33906           schema:
33907             $ref: "#/definitions/relationship"
33908     delete:
33909       tags:
33910         - Network
33911       summary: delete an existing relationship
33912       description: delete an existing relationship
33913       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
33914       consumes:
33915         - application/json
33916         - application/xml
33917       produces:
33918         - application/json
33919         - application/xml
33920       responses:
33921         "default":
33922           description: Response codes found in [response codes](https://wiki.onap.org/).
33923       parameters:
33924         - name: network-id
33925           in: path
33926           description: Network ID, should be uuid. Unique across A&AI.
33927           required: true
33928           type: string
33929           example: __NETWORK-ID__
33930         - name: subnet-id
33931           in: path
33932           description: Subnet ID, should be UUID.
33933           required: true
33934           type: string
33935           example: __SUBNET-ID__
33936   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
33937     get:
33938       tags:
33939         - Network
33940       summary: returns subnet
33941       description: returns subnet
33942       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
33943       produces:
33944         - application/json
33945         - application/xml
33946       responses:
33947         "200":
33948           description: successful operation
33949           schema:
33950               $ref: "#/getDefinitions/subnet"
33951         "default":
33952           description: Response codes found in [response codes](https://wiki.onap.org/).
33953       parameters:
33954         - name: network-id
33955           in: path
33956           description: Network ID, should be uuid. Unique across A&AI.
33957           required: true
33958           type: string
33959           example: __NETWORK-ID__
33960         - name: subnet-id
33961           in: path
33962           description: Subnet ID, should be UUID.
33963           required: true
33964           type: string
33965           example: __SUBNET-ID__
33966         - name: network-name
33967           in: query
33968           description: Name of the network, governed by some naming convention..
33969           required: false
33970           type: string
33971         - name: network-role
33972           in: query
33973           description: Role the network plans - who defines these values?
33974           required: false
33975           type: string
33976         - name: service-id
33977           in: query
33978           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33979           required: false
33980           type: string
33981         - name: heat-stack-id
33982           in: query
33983           description: Heat stack id corresponding to this instance, managed by MSO
33984           required: false
33985           type: string
33986         - name: contrail-network-fqdn
33987           in: query
33988           description: Contrail FQDN for the network
33989           required: false
33990           type: string
33991         - name: model-invariant-id
33992           in: query
33993           description: the ASDC model id for this resource or service model.
33994           required: false
33995           type: string
33996         - name: model-version-id
33997           in: query
33998           description: the ASDC model version for this resource or service model.
33999           required: false
34000           type: string
34001         - name: widget-model-id
34002           in: query
34003           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34004           required: false
34005           type: string
34006         - name: widget-model-version
34007           in: query
34008           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34009           required: false
34010           type: string
34011         - name: subnet-name
34012           in: query
34013           description: Name associated with the subnet.
34014           required: false
34015           type: string
34016     put:
34017       tags:
34018         - Network
34019       summary: create or update an existing subnet
34020       description: |
34021         Create or update an existing subnet.
34022         #
34023         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34024       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
34025       consumes:
34026         - application/json
34027         - application/xml
34028       produces:
34029         - application/json
34030         - application/xml
34031       responses:
34032         "default":
34033           description: Response codes found in [response codes](https://wiki.onap.org/).
34034       parameters:
34035         - name: network-id
34036           in: path
34037           description: Network ID, should be uuid. Unique across A&AI.
34038           required: true
34039           type: string
34040           example: __NETWORK-ID__
34041         - name: subnet-id
34042           in: path
34043           description: Subnet ID, should be UUID.
34044           required: true
34045           type: string
34046           example: __SUBNET-ID__
34047         - name: body
34048           in: body
34049           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
34050           required: true
34051           schema:
34052             $ref: "#/definitions/subnet"
34053     patch:
34054       tags:
34055         - Network
34056       summary: update an existing subnet
34057       description: |
34058         Update an existing subnet
34059         #
34060         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34061         The PUT operation will entirely replace an existing object.
34062         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34063         #
34064         Other differences between PUT and PATCH are:
34065         #
34066         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34067         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34068         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34069       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
34070       consumes:
34071         - application/json
34072         - application/xml
34073       produces:
34074         - application/json
34075         - application/xml
34076       responses:
34077         "default":
34078           description: Response codes found in [response codes](https://wiki.onap.org/).
34079       parameters:
34080         - name: network-id
34081           in: path
34082           description: Network ID, should be uuid. Unique across A&AI.
34083           required: true
34084           type: string
34085           example: __NETWORK-ID__
34086         - name: subnet-id
34087           in: path
34088           description: Subnet ID, should be UUID.
34089           required: true
34090           type: string
34091           example: __SUBNET-ID__
34092         - name: body
34093           in: body
34094           description: subnet object that needs to be created or updated.
34095           required: true
34096           schema:
34097             $ref: "#/patchDefinitions/subnet"
34098     delete:
34099       tags:
34100         - Network
34101       summary: delete an existing subnet
34102       description: delete an existing subnet
34103       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
34104       consumes:
34105         - application/json
34106         - application/xml
34107       produces:
34108         - application/json
34109         - application/xml
34110       responses:
34111         "default":
34112           description: Response codes found in [response codes](https://wiki.onap.org/).
34113       parameters:
34114         - name: network-id
34115           in: path
34116           description: Network ID, should be uuid. Unique across A&AI.
34117           required: true
34118           type: string
34119           example: __NETWORK-ID__
34120         - name: subnet-id
34121           in: path
34122           description: Subnet ID, should be UUID.
34123           required: true
34124           type: string
34125           example: __SUBNET-ID__
34126         - name: resource-version
34127           in: query
34128           description: resource-version for concurrency
34129           required: true
34130           type: string
34131   /network/l3-networks/l3-network/{network-id}/subnets:
34132     get:
34133       tags:
34134         - Network
34135       summary: returns subnets
34136       description: returns subnets
34137       operationId: getNetworkL3NetworksL3NetworkSubnets
34138       produces:
34139         - application/json
34140         - application/xml
34141       responses:
34142         "200":
34143           description: successful operation
34144           schema:
34145               $ref: "#/getDefinitions/subnets"
34146         "default":
34147           description: Response codes found in [response codes](https://wiki.onap.org/).
34148       parameters:
34149         - name: network-id
34150           in: path
34151           description: Network ID, should be uuid. Unique across A&AI.
34152           required: true
34153           type: string
34154           example: __NETWORK-ID__
34155         - name: network-name
34156           in: query
34157           description: Name of the network, governed by some naming convention..
34158           required: false
34159           type: string
34160         - name: network-role
34161           in: query
34162           description: Role the network plans - who defines these values?
34163           required: false
34164           type: string
34165         - name: service-id
34166           in: query
34167           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34168           required: false
34169           type: string
34170         - name: heat-stack-id
34171           in: query
34172           description: Heat stack id corresponding to this instance, managed by MSO
34173           required: false
34174           type: string
34175         - name: contrail-network-fqdn
34176           in: query
34177           description: Contrail FQDN for the network
34178           required: false
34179           type: string
34180         - name: model-invariant-id
34181           in: query
34182           description: the ASDC model id for this resource or service model.
34183           required: false
34184           type: string
34185         - name: model-version-id
34186           in: query
34187           description: the ASDC model version for this resource or service model.
34188           required: false
34189           type: string
34190         - name: widget-model-id
34191           in: query
34192           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34193           required: false
34194           type: string
34195         - name: widget-model-version
34196           in: query
34197           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34198           required: false
34199           type: string
34200   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
34201     put:
34202       tags:
34203         - Network
34204       summary: see node definition for valid relationships
34205       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
34206       consumes:
34207         - application/json
34208         - application/xml
34209       produces:
34210         - application/json
34211         - application/xml
34212       responses:
34213         "default":
34214           description: Response codes found in [response codes](https://wiki.onap.org/).
34215       parameters:
34216         - name: network-id
34217           in: path
34218           description: Network ID, should be uuid. Unique across A&AI.
34219           required: true
34220           type: string
34221           example: __NETWORK-ID__
34222         - name: vlan-id-inner
34223           in: path
34224           description: id.
34225           required: true
34226           type: integer
34227           format: int64
34228           example: __VLAN-ID-INNER__
34229         - name: body
34230           in: body
34231           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
34232           required: true
34233           schema:
34234             $ref: "#/definitions/relationship"
34235     delete:
34236       tags:
34237         - Network
34238       summary: delete an existing relationship
34239       description: delete an existing relationship
34240       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
34241       consumes:
34242         - application/json
34243         - application/xml
34244       produces:
34245         - application/json
34246         - application/xml
34247       responses:
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: vlan-id-inner
34258           in: path
34259           description: id.
34260           required: true
34261           type: integer
34262           format: int64
34263           example: __VLAN-ID-INNER__
34264   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
34265     get:
34266       tags:
34267         - Network
34268       summary: returns ctag-assignment
34269       description: returns ctag-assignment
34270       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
34271       produces:
34272         - application/json
34273         - application/xml
34274       responses:
34275         "200":
34276           description: successful operation
34277           schema:
34278               $ref: "#/getDefinitions/ctag-assignment"
34279         "default":
34280           description: Response codes found in [response codes](https://wiki.onap.org/).
34281       parameters:
34282         - name: network-id
34283           in: path
34284           description: Network ID, should be uuid. Unique across A&AI.
34285           required: true
34286           type: string
34287           example: __NETWORK-ID__
34288         - name: vlan-id-inner
34289           in: path
34290           description: id.
34291           required: true
34292           type: integer
34293           format: int64
34294           example: __VLAN-ID-INNER__
34295         - name: network-name
34296           in: query
34297           description: Name of the network, governed by some naming convention..
34298           required: false
34299           type: string
34300         - name: network-role
34301           in: query
34302           description: Role the network plans - who defines these values?
34303           required: false
34304           type: string
34305         - name: service-id
34306           in: query
34307           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34308           required: false
34309           type: string
34310         - name: heat-stack-id
34311           in: query
34312           description: Heat stack id corresponding to this instance, managed by MSO
34313           required: false
34314           type: string
34315         - name: contrail-network-fqdn
34316           in: query
34317           description: Contrail FQDN for the network
34318           required: false
34319           type: string
34320         - name: model-invariant-id
34321           in: query
34322           description: the ASDC model id for this resource or service model.
34323           required: false
34324           type: string
34325         - name: model-version-id
34326           in: query
34327           description: the ASDC model version for this resource or service model.
34328           required: false
34329           type: string
34330         - name: widget-model-id
34331           in: query
34332           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34333           required: false
34334           type: string
34335         - name: widget-model-version
34336           in: query
34337           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34338           required: false
34339           type: string
34340     put:
34341       tags:
34342         - Network
34343       summary: create or update an existing ctag-assignment
34344       description: |
34345         Create or update an existing ctag-assignment.
34346         #
34347         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34348       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
34349       consumes:
34350         - application/json
34351         - application/xml
34352       produces:
34353         - application/json
34354         - application/xml
34355       responses:
34356         "default":
34357           description: Response codes found in [response codes](https://wiki.onap.org/).
34358       parameters:
34359         - name: network-id
34360           in: path
34361           description: Network ID, should be uuid. Unique across A&AI.
34362           required: true
34363           type: string
34364           example: __NETWORK-ID__
34365         - name: vlan-id-inner
34366           in: path
34367           description: id.
34368           required: true
34369           type: integer
34370           format: int64
34371           example: __VLAN-ID-INNER__
34372         - name: body
34373           in: body
34374           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
34375           required: true
34376           schema:
34377             $ref: "#/definitions/ctag-assignment"
34378     patch:
34379       tags:
34380         - Network
34381       summary: update an existing ctag-assignment
34382       description: |
34383         Update an existing ctag-assignment
34384         #
34385         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34386         The PUT operation will entirely replace an existing object.
34387         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34388         #
34389         Other differences between PUT and PATCH are:
34390         #
34391         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34392         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34393         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34394       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
34395       consumes:
34396         - application/json
34397         - application/xml
34398       produces:
34399         - application/json
34400         - application/xml
34401       responses:
34402         "default":
34403           description: Response codes found in [response codes](https://wiki.onap.org/).
34404       parameters:
34405         - name: network-id
34406           in: path
34407           description: Network ID, should be uuid. Unique across A&AI.
34408           required: true
34409           type: string
34410           example: __NETWORK-ID__
34411         - name: vlan-id-inner
34412           in: path
34413           description: id.
34414           required: true
34415           type: integer
34416           format: int64
34417           example: __VLAN-ID-INNER__
34418         - name: body
34419           in: body
34420           description: ctag-assignment object that needs to be created or updated.
34421           required: true
34422           schema:
34423             $ref: "#/patchDefinitions/ctag-assignment"
34424     delete:
34425       tags:
34426         - Network
34427       summary: delete an existing ctag-assignment
34428       description: delete an existing ctag-assignment
34429       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
34430       consumes:
34431         - application/json
34432         - application/xml
34433       produces:
34434         - application/json
34435         - application/xml
34436       responses:
34437         "default":
34438           description: Response codes found in [response codes](https://wiki.onap.org/).
34439       parameters:
34440         - name: network-id
34441           in: path
34442           description: Network ID, should be uuid. Unique across A&AI.
34443           required: true
34444           type: string
34445           example: __NETWORK-ID__
34446         - name: vlan-id-inner
34447           in: path
34448           description: id.
34449           required: true
34450           type: integer
34451           format: int64
34452           example: __VLAN-ID-INNER__
34453         - name: resource-version
34454           in: query
34455           description: resource-version for concurrency
34456           required: true
34457           type: string
34458   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
34459     get:
34460       tags:
34461         - Network
34462       summary: returns ctag-assignments
34463       description: returns ctag-assignments
34464       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
34465       produces:
34466         - application/json
34467         - application/xml
34468       responses:
34469         "200":
34470           description: successful operation
34471           schema:
34472               $ref: "#/getDefinitions/ctag-assignments"
34473         "default":
34474           description: Response codes found in [response codes](https://wiki.onap.org/).
34475       parameters:
34476         - name: network-id
34477           in: path
34478           description: Network ID, should be uuid. Unique across A&AI.
34479           required: true
34480           type: string
34481           example: __NETWORK-ID__
34482         - name: network-name
34483           in: query
34484           description: Name of the network, governed by some naming convention..
34485           required: false
34486           type: string
34487         - name: network-role
34488           in: query
34489           description: Role the network plans - who defines these values?
34490           required: false
34491           type: string
34492         - name: service-id
34493           in: query
34494           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34495           required: false
34496           type: string
34497         - name: heat-stack-id
34498           in: query
34499           description: Heat stack id corresponding to this instance, managed by MSO
34500           required: false
34501           type: string
34502         - name: contrail-network-fqdn
34503           in: query
34504           description: Contrail FQDN for the network
34505           required: false
34506           type: string
34507         - name: model-invariant-id
34508           in: query
34509           description: the ASDC model id for this resource or service model.
34510           required: false
34511           type: string
34512         - name: model-version-id
34513           in: query
34514           description: the ASDC model version for this resource or service model.
34515           required: false
34516           type: string
34517         - name: widget-model-id
34518           in: query
34519           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34520           required: false
34521           type: string
34522         - name: widget-model-version
34523           in: query
34524           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34525           required: false
34526           type: string
34527   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
34528     put:
34529       tags:
34530         - Network
34531       summary: see node definition for valid relationships
34532       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
34533       consumes:
34534         - application/json
34535         - application/xml
34536       produces:
34537         - application/json
34538         - application/xml
34539       responses:
34540         "default":
34541           description: Response codes found in [response codes](https://wiki.onap.org/).
34542       parameters:
34543         - name: network-id
34544           in: path
34545           description: Network ID, should be uuid. Unique across A&AI.
34546           required: true
34547           type: string
34548           example: __NETWORK-ID__
34549         - name: segmentation-id
34550           in: path
34551           description: Route Table Reference id, UUID assigned to this instance.
34552           required: true
34553           type: string
34554           example: __SEGMENTATION-ID__
34555         - name: body
34556           in: body
34557           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
34558           required: true
34559           schema:
34560             $ref: "#/definitions/relationship"
34561     delete:
34562       tags:
34563         - Network
34564       summary: delete an existing relationship
34565       description: delete an existing relationship
34566       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
34567       consumes:
34568         - application/json
34569         - application/xml
34570       produces:
34571         - application/json
34572         - application/xml
34573       responses:
34574         "default":
34575           description: Response codes found in [response codes](https://wiki.onap.org/).
34576       parameters:
34577         - name: network-id
34578           in: path
34579           description: Network ID, should be uuid. Unique across A&AI.
34580           required: true
34581           type: string
34582           example: __NETWORK-ID__
34583         - name: segmentation-id
34584           in: path
34585           description: Route Table Reference id, UUID assigned to this instance.
34586           required: true
34587           type: string
34588           example: __SEGMENTATION-ID__
34589   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
34590     get:
34591       tags:
34592         - Network
34593       summary: returns segmentation-assignment
34594       description: returns segmentation-assignment
34595       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34596       produces:
34597         - application/json
34598         - application/xml
34599       responses:
34600         "200":
34601           description: successful operation
34602           schema:
34603               $ref: "#/getDefinitions/segmentation-assignment"
34604         "default":
34605           description: Response codes found in [response codes](https://wiki.onap.org/).
34606       parameters:
34607         - name: network-id
34608           in: path
34609           description: Network ID, should be uuid. Unique across A&AI.
34610           required: true
34611           type: string
34612           example: __NETWORK-ID__
34613         - name: segmentation-id
34614           in: path
34615           description: Route Table Reference id, UUID assigned to this instance.
34616           required: true
34617           type: string
34618           example: __SEGMENTATION-ID__
34619         - name: network-name
34620           in: query
34621           description: Name of the network, governed by some naming convention..
34622           required: false
34623           type: string
34624         - name: network-role
34625           in: query
34626           description: Role the network plans - who defines these values?
34627           required: false
34628           type: string
34629         - name: service-id
34630           in: query
34631           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34632           required: false
34633           type: string
34634         - name: heat-stack-id
34635           in: query
34636           description: Heat stack id corresponding to this instance, managed by MSO
34637           required: false
34638           type: string
34639         - name: contrail-network-fqdn
34640           in: query
34641           description: Contrail FQDN for the network
34642           required: false
34643           type: string
34644         - name: model-invariant-id
34645           in: query
34646           description: the ASDC model id for this resource or service model.
34647           required: false
34648           type: string
34649         - name: model-version-id
34650           in: query
34651           description: the ASDC model version for this resource or service model.
34652           required: false
34653           type: string
34654         - name: widget-model-id
34655           in: query
34656           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34657           required: false
34658           type: string
34659         - name: widget-model-version
34660           in: query
34661           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34662           required: false
34663           type: string
34664     put:
34665       tags:
34666         - Network
34667       summary: create or update an existing segmentation-assignment
34668       description: |
34669         Create or update an existing segmentation-assignment.
34670         #
34671         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34672       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34673       consumes:
34674         - application/json
34675         - application/xml
34676       produces:
34677         - application/json
34678         - application/xml
34679       responses:
34680         "default":
34681           description: Response codes found in [response codes](https://wiki.onap.org/).
34682       parameters:
34683         - name: network-id
34684           in: path
34685           description: Network ID, should be uuid. Unique across A&AI.
34686           required: true
34687           type: string
34688           example: __NETWORK-ID__
34689         - name: segmentation-id
34690           in: path
34691           description: Route Table Reference id, UUID assigned to this instance.
34692           required: true
34693           type: string
34694           example: __SEGMENTATION-ID__
34695         - name: body
34696           in: body
34697           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
34698           required: true
34699           schema:
34700             $ref: "#/definitions/segmentation-assignment"
34701     patch:
34702       tags:
34703         - Network
34704       summary: update an existing segmentation-assignment
34705       description: |
34706         Update an existing segmentation-assignment
34707         #
34708         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34709         The PUT operation will entirely replace an existing object.
34710         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34711         #
34712         Other differences between PUT and PATCH are:
34713         #
34714         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34715         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34716         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34717       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34718       consumes:
34719         - application/json
34720         - application/xml
34721       produces:
34722         - application/json
34723         - application/xml
34724       responses:
34725         "default":
34726           description: Response codes found in [response codes](https://wiki.onap.org/).
34727       parameters:
34728         - name: network-id
34729           in: path
34730           description: Network ID, should be uuid. Unique across A&AI.
34731           required: true
34732           type: string
34733           example: __NETWORK-ID__
34734         - name: segmentation-id
34735           in: path
34736           description: Route Table Reference id, UUID assigned to this instance.
34737           required: true
34738           type: string
34739           example: __SEGMENTATION-ID__
34740         - name: body
34741           in: body
34742           description: segmentation-assignment object that needs to be created or updated.
34743           required: true
34744           schema:
34745             $ref: "#/patchDefinitions/segmentation-assignment"
34746     delete:
34747       tags:
34748         - Network
34749       summary: delete an existing segmentation-assignment
34750       description: delete an existing segmentation-assignment
34751       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34752       consumes:
34753         - application/json
34754         - application/xml
34755       produces:
34756         - application/json
34757         - application/xml
34758       responses:
34759         "default":
34760           description: Response codes found in [response codes](https://wiki.onap.org/).
34761       parameters:
34762         - name: network-id
34763           in: path
34764           description: Network ID, should be uuid. Unique across A&AI.
34765           required: true
34766           type: string
34767           example: __NETWORK-ID__
34768         - name: segmentation-id
34769           in: path
34770           description: Route Table Reference id, UUID assigned to this instance.
34771           required: true
34772           type: string
34773           example: __SEGMENTATION-ID__
34774         - name: resource-version
34775           in: query
34776           description: resource-version for concurrency
34777           required: true
34778           type: string
34779   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
34780     get:
34781       tags:
34782         - Network
34783       summary: returns segmentation-assignments
34784       description: returns segmentation-assignments
34785       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
34786       produces:
34787         - application/json
34788         - application/xml
34789       responses:
34790         "200":
34791           description: successful operation
34792           schema:
34793               $ref: "#/getDefinitions/segmentation-assignments"
34794         "default":
34795           description: Response codes found in [response codes](https://wiki.onap.org/).
34796       parameters:
34797         - name: network-id
34798           in: path
34799           description: Network ID, should be uuid. Unique across A&AI.
34800           required: true
34801           type: string
34802           example: __NETWORK-ID__
34803         - name: network-name
34804           in: query
34805           description: Name of the network, governed by some naming convention..
34806           required: false
34807           type: string
34808         - name: network-role
34809           in: query
34810           description: Role the network plans - who defines these values?
34811           required: false
34812           type: string
34813         - name: service-id
34814           in: query
34815           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34816           required: false
34817           type: string
34818         - name: heat-stack-id
34819           in: query
34820           description: Heat stack id corresponding to this instance, managed by MSO
34821           required: false
34822           type: string
34823         - name: contrail-network-fqdn
34824           in: query
34825           description: Contrail FQDN for the network
34826           required: false
34827           type: string
34828         - name: model-invariant-id
34829           in: query
34830           description: the ASDC model id for this resource or service model.
34831           required: false
34832           type: string
34833         - name: model-version-id
34834           in: query
34835           description: the ASDC model version for this resource or service model.
34836           required: false
34837           type: string
34838         - name: widget-model-id
34839           in: query
34840           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34841           required: false
34842           type: string
34843         - name: widget-model-version
34844           in: query
34845           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34846           required: false
34847           type: string
34848   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
34849     put:
34850       tags:
34851         - Network
34852       summary: see node definition for valid relationships
34853       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
34854       consumes:
34855         - application/json
34856         - application/xml
34857       produces:
34858         - application/json
34859         - application/xml
34860       responses:
34861         "default":
34862           description: Response codes found in [response codes](https://wiki.onap.org/).
34863       parameters:
34864         - name: network-id
34865           in: path
34866           description: Network ID, should be uuid. Unique across A&AI.
34867           required: true
34868           type: string
34869           example: __NETWORK-ID__
34870         - name: body
34871           in: body
34872           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
34873           required: true
34874           schema:
34875             $ref: "#/definitions/relationship"
34876     delete:
34877       tags:
34878         - Network
34879       summary: delete an existing relationship
34880       description: delete an existing relationship
34881       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
34882       consumes:
34883         - application/json
34884         - application/xml
34885       produces:
34886         - application/json
34887         - application/xml
34888       responses:
34889         "default":
34890           description: Response codes found in [response codes](https://wiki.onap.org/).
34891       parameters:
34892         - name: network-id
34893           in: path
34894           description: Network ID, should be uuid. Unique across A&AI.
34895           required: true
34896           type: string
34897           example: __NETWORK-ID__
34898   /network/l3-networks/l3-network/{network-id}:
34899     get:
34900       tags:
34901         - Network
34902       summary: returns l3-network
34903       description: returns l3-network
34904       operationId: getNetworkL3NetworksL3Network
34905       produces:
34906         - application/json
34907         - application/xml
34908       responses:
34909         "200":
34910           description: successful operation
34911           schema:
34912               $ref: "#/getDefinitions/l3-network"
34913         "default":
34914           description: Response codes found in [response codes](https://wiki.onap.org/).
34915       parameters:
34916         - name: network-id
34917           in: path
34918           description: Network ID, should be uuid. Unique across A&AI.
34919           required: true
34920           type: string
34921           example: __NETWORK-ID__
34922         - name: network-name
34923           in: query
34924           description: Name of the network, governed by some naming convention..
34925           required: false
34926           type: string
34927         - name: network-role
34928           in: query
34929           description: Role the network plans - who defines these values?
34930           required: false
34931           type: string
34932         - name: service-id
34933           in: query
34934           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34935           required: false
34936           type: string
34937         - name: heat-stack-id
34938           in: query
34939           description: Heat stack id corresponding to this instance, managed by MSO
34940           required: false
34941           type: string
34942         - name: contrail-network-fqdn
34943           in: query
34944           description: Contrail FQDN for the network
34945           required: false
34946           type: string
34947         - name: model-invariant-id
34948           in: query
34949           description: the ASDC model id for this resource or service model.
34950           required: false
34951           type: string
34952         - name: model-version-id
34953           in: query
34954           description: the ASDC model version for this resource or service model.
34955           required: false
34956           type: string
34957         - name: widget-model-id
34958           in: query
34959           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34960           required: false
34961           type: string
34962         - name: widget-model-version
34963           in: query
34964           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34965           required: false
34966           type: string
34967     put:
34968       tags:
34969         - Network
34970       summary: create or update an existing l3-network
34971       description: |
34972         Create or update an existing l3-network.
34973         #
34974         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34975       operationId: createOrUpdateNetworkL3NetworksL3Network
34976       consumes:
34977         - application/json
34978         - application/xml
34979       produces:
34980         - application/json
34981         - application/xml
34982       responses:
34983         "default":
34984           description: Response codes found in [response codes](https://wiki.onap.org/).
34985       parameters:
34986         - name: network-id
34987           in: path
34988           description: Network ID, should be uuid. Unique across A&AI.
34989           required: true
34990           type: string
34991           example: __NETWORK-ID__
34992         - name: body
34993           in: body
34994           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
34995           required: true
34996           schema:
34997             $ref: "#/definitions/l3-network"
34998     patch:
34999       tags:
35000         - Network
35001       summary: update an existing l3-network
35002       description: |
35003         Update an existing l3-network
35004         #
35005         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35006         The PUT operation will entirely replace an existing object.
35007         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35008         #
35009         Other differences between PUT and PATCH are:
35010         #
35011         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35012         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35013         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35014       operationId: UpdateNetworkL3NetworksL3Network
35015       consumes:
35016         - application/json
35017         - application/xml
35018       produces:
35019         - application/json
35020         - application/xml
35021       responses:
35022         "default":
35023           description: Response codes found in [response codes](https://wiki.onap.org/).
35024       parameters:
35025         - name: network-id
35026           in: path
35027           description: Network ID, should be uuid. Unique across A&AI.
35028           required: true
35029           type: string
35030           example: __NETWORK-ID__
35031         - name: body
35032           in: body
35033           description: l3-network object that needs to be created or updated.
35034           required: true
35035           schema:
35036             $ref: "#/patchDefinitions/l3-network"
35037     delete:
35038       tags:
35039         - Network
35040       summary: delete an existing l3-network
35041       description: delete an existing l3-network
35042       operationId: deleteNetworkL3NetworksL3Network
35043       consumes:
35044         - application/json
35045         - application/xml
35046       produces:
35047         - application/json
35048         - application/xml
35049       responses:
35050         "default":
35051           description: Response codes found in [response codes](https://wiki.onap.org/).
35052       parameters:
35053         - name: network-id
35054           in: path
35055           description: Network ID, should be uuid. Unique across A&AI.
35056           required: true
35057           type: string
35058           example: __NETWORK-ID__
35059         - name: resource-version
35060           in: query
35061           description: resource-version for concurrency
35062           required: true
35063           type: string
35064   /network/l3-networks:
35065     get:
35066       tags:
35067         - Network
35068       summary: returns l3-networks
35069       description: returns l3-networks
35070       operationId: getNetworkL3Networks
35071       produces:
35072         - application/json
35073         - application/xml
35074       responses:
35075         "200":
35076           description: successful operation
35077           schema:
35078               $ref: "#/getDefinitions/l3-networks"
35079         "default":
35080           description: Response codes found in [response codes](https://wiki.onap.org/).
35081   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
35082     put:
35083       tags:
35084         - Network
35085       summary: see node definition for valid relationships
35086       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
35087       consumes:
35088         - application/json
35089         - application/xml
35090       produces:
35091         - application/json
35092         - application/xml
35093       responses:
35094         "default":
35095           description: Response codes found in [response codes](https://wiki.onap.org/).
35096       parameters:
35097         - name: network-policy-id
35098           in: path
35099           description: UUID representing unique key to this instance
35100           required: true
35101           type: string
35102           example: __NETWORK-POLICY-ID__
35103         - name: body
35104           in: body
35105           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
35106           required: true
35107           schema:
35108             $ref: "#/definitions/relationship"
35109     delete:
35110       tags:
35111         - Network
35112       summary: delete an existing relationship
35113       description: delete an existing relationship
35114       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
35115       consumes:
35116         - application/json
35117         - application/xml
35118       produces:
35119         - application/json
35120         - application/xml
35121       responses:
35122         "default":
35123           description: Response codes found in [response codes](https://wiki.onap.org/).
35124       parameters:
35125         - name: network-policy-id
35126           in: path
35127           description: UUID representing unique key to this instance
35128           required: true
35129           type: string
35130           example: __NETWORK-POLICY-ID__
35131   /network/network-policies/network-policy/{network-policy-id}:
35132     get:
35133       tags:
35134         - Network
35135       summary: returns network-policy
35136       description: returns network-policy
35137       operationId: getNetworkNetworkPoliciesNetworkPolicy
35138       produces:
35139         - application/json
35140         - application/xml
35141       responses:
35142         "200":
35143           description: successful operation
35144           schema:
35145               $ref: "#/getDefinitions/network-policy"
35146         "default":
35147           description: Response codes found in [response codes](https://wiki.onap.org/).
35148       parameters:
35149         - name: network-policy-id
35150           in: path
35151           description: UUID representing unique key to this instance
35152           required: true
35153           type: string
35154           example: __NETWORK-POLICY-ID__
35155         - name: network-policy-fqdn
35156           in: query
35157           description: Contrail FQDN for the policy
35158           required: false
35159           type: string
35160     put:
35161       tags:
35162         - Network
35163       summary: create or update an existing network-policy
35164       description: |
35165         Create or update an existing network-policy.
35166         #
35167         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35168       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
35169       consumes:
35170         - application/json
35171         - application/xml
35172       produces:
35173         - application/json
35174         - application/xml
35175       responses:
35176         "default":
35177           description: Response codes found in [response codes](https://wiki.onap.org/).
35178       parameters:
35179         - name: network-policy-id
35180           in: path
35181           description: UUID representing unique key to this instance
35182           required: true
35183           type: string
35184           example: __NETWORK-POLICY-ID__
35185         - name: body
35186           in: body
35187           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
35188           required: true
35189           schema:
35190             $ref: "#/definitions/network-policy"
35191     patch:
35192       tags:
35193         - Network
35194       summary: update an existing network-policy
35195       description: |
35196         Update an existing network-policy
35197         #
35198         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35199         The PUT operation will entirely replace an existing object.
35200         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35201         #
35202         Other differences between PUT and PATCH are:
35203         #
35204         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35205         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35206         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35207       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
35208       consumes:
35209         - application/json
35210         - application/xml
35211       produces:
35212         - application/json
35213         - application/xml
35214       responses:
35215         "default":
35216           description: Response codes found in [response codes](https://wiki.onap.org/).
35217       parameters:
35218         - name: network-policy-id
35219           in: path
35220           description: UUID representing unique key to this instance
35221           required: true
35222           type: string
35223           example: __NETWORK-POLICY-ID__
35224         - name: body
35225           in: body
35226           description: network-policy object that needs to be created or updated.
35227           required: true
35228           schema:
35229             $ref: "#/patchDefinitions/network-policy"
35230     delete:
35231       tags:
35232         - Network
35233       summary: delete an existing network-policy
35234       description: delete an existing network-policy
35235       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
35236       consumes:
35237         - application/json
35238         - application/xml
35239       produces:
35240         - application/json
35241         - application/xml
35242       responses:
35243         "default":
35244           description: Response codes found in [response codes](https://wiki.onap.org/).
35245       parameters:
35246         - name: network-policy-id
35247           in: path
35248           description: UUID representing unique key to this instance
35249           required: true
35250           type: string
35251           example: __NETWORK-POLICY-ID__
35252         - name: resource-version
35253           in: query
35254           description: resource-version for concurrency
35255           required: true
35256           type: string
35257   /network/network-policies:
35258     get:
35259       tags:
35260         - Network
35261       summary: returns network-policies
35262       description: returns network-policies
35263       operationId: getNetworkNetworkPolicies
35264       produces:
35265         - application/json
35266         - application/xml
35267       responses:
35268         "200":
35269           description: successful operation
35270           schema:
35271               $ref: "#/getDefinitions/network-policies"
35272         "default":
35273           description: Response codes found in [response codes](https://wiki.onap.org/).
35274   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
35275     put:
35276       tags:
35277         - Network
35278       summary: see node definition for valid relationships
35279       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
35280       consumes:
35281         - application/json
35282         - application/xml
35283       produces:
35284         - application/json
35285         - application/xml
35286       responses:
35287         "default":
35288           description: Response codes found in [response codes](https://wiki.onap.org/).
35289       parameters:
35290         - name: vnf-id
35291           in: path
35292           description: Unique id of VNF.  This is unique across the graph.
35293           required: true
35294           type: string
35295           example: __VNF-ID__
35296         - name: body
35297           in: body
35298           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
35299           required: true
35300           schema:
35301             $ref: "#/definitions/relationship"
35302     delete:
35303       tags:
35304         - Network
35305       summary: delete an existing relationship
35306       description: delete an existing relationship
35307       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
35308       consumes:
35309         - application/json
35310         - application/xml
35311       produces:
35312         - application/json
35313         - application/xml
35314       responses:
35315         "default":
35316           description: Response codes found in [response codes](https://wiki.onap.org/).
35317       parameters:
35318         - name: vnf-id
35319           in: path
35320           description: Unique id of VNF.  This is unique across the graph.
35321           required: true
35322           type: string
35323           example: __VNF-ID__
35324   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
35325     put:
35326       tags:
35327         - Network
35328       summary: see node definition for valid relationships
35329       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35330       consumes:
35331         - application/json
35332         - application/xml
35333       produces:
35334         - application/json
35335         - application/xml
35336       responses:
35337         "default":
35338           description: Response codes found in [response codes](https://wiki.onap.org/).
35339       parameters:
35340         - name: vnf-id
35341           in: path
35342           description: Unique id of VNF.  This is unique across the graph.
35343           required: true
35344           type: string
35345           example: __VNF-ID__
35346         - name: interface-name
35347           in: path
35348           description: Name given to the interface
35349           required: true
35350           type: string
35351           example: __INTERFACE-NAME__
35352         - name: vlan-interface
35353           in: path
35354           description: String that identifies the interface
35355           required: true
35356           type: string
35357           example: __VLAN-INTERFACE__
35358         - name: body
35359           in: body
35360           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
35361           required: true
35362           schema:
35363             $ref: "#/definitions/relationship"
35364     delete:
35365       tags:
35366         - Network
35367       summary: delete an existing relationship
35368       description: delete an existing relationship
35369       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35370       consumes:
35371         - application/json
35372         - application/xml
35373       produces:
35374         - application/json
35375         - application/xml
35376       responses:
35377         "default":
35378           description: Response codes found in [response codes](https://wiki.onap.org/).
35379       parameters:
35380         - name: vnf-id
35381           in: path
35382           description: Unique id of VNF.  This is unique across the graph.
35383           required: true
35384           type: string
35385           example: __VNF-ID__
35386         - name: interface-name
35387           in: path
35388           description: Name given to the interface
35389           required: true
35390           type: string
35391           example: __INTERFACE-NAME__
35392         - name: vlan-interface
35393           in: path
35394           description: String that identifies the interface
35395           required: true
35396           type: string
35397           example: __VLAN-INTERFACE__
35398   /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:
35399     put:
35400       tags:
35401         - Network
35402       summary: see node definition for valid relationships
35403       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35404       consumes:
35405         - application/json
35406         - application/xml
35407       produces:
35408         - application/json
35409         - application/xml
35410       responses:
35411         "default":
35412           description: Response codes found in [response codes](https://wiki.onap.org/).
35413       parameters:
35414         - name: vnf-id
35415           in: path
35416           description: Unique id of VNF.  This is unique across the graph.
35417           required: true
35418           type: string
35419           example: __VNF-ID__
35420         - name: interface-name
35421           in: path
35422           description: Name given to the interface
35423           required: true
35424           type: string
35425           example: __INTERFACE-NAME__
35426         - name: vlan-interface
35427           in: path
35428           description: String that identifies the interface
35429           required: true
35430           type: string
35431           example: __VLAN-INTERFACE__
35432         - name: l3-interface-ipv4-address
35433           in: path
35434           description: IP address
35435           required: true
35436           type: string
35437           example: __L3-INTERFACE-IPV4-ADDRESS__
35438         - name: body
35439           in: body
35440           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35441           required: true
35442           schema:
35443             $ref: "#/definitions/relationship"
35444     delete:
35445       tags:
35446         - Network
35447       summary: delete an existing relationship
35448       description: delete an existing relationship
35449       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35450       consumes:
35451         - application/json
35452         - application/xml
35453       produces:
35454         - application/json
35455         - application/xml
35456       responses:
35457         "default":
35458           description: Response codes found in [response codes](https://wiki.onap.org/).
35459       parameters:
35460         - name: vnf-id
35461           in: path
35462           description: Unique id of VNF.  This is unique across the graph.
35463           required: true
35464           type: string
35465           example: __VNF-ID__
35466         - name: interface-name
35467           in: path
35468           description: Name given to the interface
35469           required: true
35470           type: string
35471           example: __INTERFACE-NAME__
35472         - name: vlan-interface
35473           in: path
35474           description: String that identifies the interface
35475           required: true
35476           type: string
35477           example: __VLAN-INTERFACE__
35478         - name: l3-interface-ipv4-address
35479           in: path
35480           description: IP address
35481           required: true
35482           type: string
35483           example: __L3-INTERFACE-IPV4-ADDRESS__
35484   /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}:
35485     get:
35486       tags:
35487         - Network
35488       summary: returns l3-interface-ipv4-address-list
35489       description: returns l3-interface-ipv4-address-list
35490       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35491       produces:
35492         - application/json
35493         - application/xml
35494       responses:
35495         "200":
35496           description: successful operation
35497           schema:
35498               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35499         "default":
35500           description: Response codes found in [response codes](https://wiki.onap.org/).
35501       parameters:
35502         - name: vnf-id
35503           in: path
35504           description: Unique id of VNF.  This is unique across the graph.
35505           required: true
35506           type: string
35507           example: __VNF-ID__
35508         - name: interface-name
35509           in: path
35510           description: Name given to the interface
35511           required: true
35512           type: string
35513           example: __INTERFACE-NAME__
35514         - name: vlan-interface
35515           in: path
35516           description: String that identifies the interface
35517           required: true
35518           type: string
35519           example: __VLAN-INTERFACE__
35520         - name: l3-interface-ipv4-address
35521           in: path
35522           description: IP address
35523           required: true
35524           type: string
35525           example: __L3-INTERFACE-IPV4-ADDRESS__
35526         - name: vnf-name
35527           in: query
35528           description: Name of VNF.
35529           required: false
35530           type: string
35531         - name: vnf-name2
35532           in: query
35533           description: Alternate name of VNF.
35534           required: false
35535           type: string
35536         - name: vnf-type
35537           in: query
35538           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.
35539           required: false
35540           type: string
35541         - name: service-id
35542           in: query
35543           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35544           required: false
35545           type: string
35546         - name: regional-resource-zone
35547           in: query
35548           description: Regional way of organizing pservers, source of truth should define values
35549           required: false
35550           type: string
35551         - name: prov-status
35552           in: query
35553           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35554           required: false
35555           type: string
35556         - name: heat-stack-id
35557           in: query
35558           description: Heat stack id corresponding to this instance, managed by MSO
35559           required: false
35560           type: string
35561         - name: in-maint
35562           in: query
35563           required: false
35564           type: boolean
35565         - name: is-closed-loop-disabled
35566           in: query
35567           required: false
35568           type: boolean
35569         - name: model-invariant-id
35570           in: query
35571           description: the ASDC model id for this resource or service model.
35572           required: false
35573           type: string
35574         - name: model-version-id
35575           in: query
35576           description: the ASDC model version for this resource or service model.
35577           required: false
35578           type: string
35579         - name: widget-model-id
35580           in: query
35581           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35582           required: false
35583           type: string
35584         - name: widget-model-version
35585           in: query
35586           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35587           required: false
35588           type: string
35589         - name: nf-type
35590           in: query
35591           description: Generic description of the type of NF
35592           required: false
35593           type: string
35594         - name: nf-function
35595           in: query
35596           description: English description of Network function that the specific VNF deployment is providing
35597           required: false
35598           type: string
35599         - name: nf-role
35600           in: query
35601           description: role in the network that this model will be providing
35602           required: false
35603           type: string
35604         - name: nf-naming-code
35605           in: query
35606           description: string assigned to this model used for naming purposes
35607           required: false
35608           type: string
35609         - name: interface-id
35610           in: query
35611           description: ID of interface
35612           required: false
35613           type: string
35614         - name: macaddr
35615           in: query
35616           description: MAC address for the interface
35617           required: false
35618           type: string
35619         - name: network-name
35620           in: query
35621           description: Name of the network
35622           required: false
35623           type: string
35624         - name: vlan-id-inner
35625           in: query
35626           description: Inner VLAN tag
35627           required: false
35628           type: integer
35629           format: int64
35630         - name: vpn-key
35631           in: query
35632           description: This indicates the customers VPN ID associated with this vlan
35633           required: false
35634           type: string
35635         - name: vlan-id-inner
35636           in: query
35637           description: Inner VLAN tag
35638           required: false
35639           type: integer
35640           format: int64
35641         - name: neutron-network-id
35642           in: query
35643           description: Neutron network id of the interface that address belongs to
35644           required: false
35645           type: string
35646         - name: neutron-subnet-id
35647           in: query
35648           description: Neutron id of subnet that address belongs to
35649           required: false
35650           type: string
35651     put:
35652       tags:
35653         - Network
35654       summary: create or update an existing l3-interface-ipv4-address-list
35655       description: |
35656         Create or update an existing l3-interface-ipv4-address-list.
35657         #
35658         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35659       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35660       consumes:
35661         - application/json
35662         - application/xml
35663       produces:
35664         - application/json
35665         - application/xml
35666       responses:
35667         "default":
35668           description: Response codes found in [response codes](https://wiki.onap.org/).
35669       parameters:
35670         - name: vnf-id
35671           in: path
35672           description: Unique id of VNF.  This is unique across the graph.
35673           required: true
35674           type: string
35675           example: __VNF-ID__
35676         - name: interface-name
35677           in: path
35678           description: Name given to the interface
35679           required: true
35680           type: string
35681           example: __INTERFACE-NAME__
35682         - name: vlan-interface
35683           in: path
35684           description: String that identifies the interface
35685           required: true
35686           type: string
35687           example: __VLAN-INTERFACE__
35688         - name: l3-interface-ipv4-address
35689           in: path
35690           description: IP address
35691           required: true
35692           type: string
35693           example: __L3-INTERFACE-IPV4-ADDRESS__
35694         - name: body
35695           in: body
35696           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35697           required: true
35698           schema:
35699             $ref: "#/definitions/l3-interface-ipv4-address-list"
35700     patch:
35701       tags:
35702         - Network
35703       summary: update an existing l3-interface-ipv4-address-list
35704       description: |
35705         Update an existing l3-interface-ipv4-address-list
35706         #
35707         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35708         The PUT operation will entirely replace an existing object.
35709         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35710         #
35711         Other differences between PUT and PATCH are:
35712         #
35713         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35714         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35715         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35716       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35717       consumes:
35718         - application/json
35719         - application/xml
35720       produces:
35721         - application/json
35722         - application/xml
35723       responses:
35724         "default":
35725           description: Response codes found in [response codes](https://wiki.onap.org/).
35726       parameters:
35727         - name: vnf-id
35728           in: path
35729           description: Unique id of VNF.  This is unique across the graph.
35730           required: true
35731           type: string
35732           example: __VNF-ID__
35733         - name: interface-name
35734           in: path
35735           description: Name given to the interface
35736           required: true
35737           type: string
35738           example: __INTERFACE-NAME__
35739         - name: vlan-interface
35740           in: path
35741           description: String that identifies the interface
35742           required: true
35743           type: string
35744           example: __VLAN-INTERFACE__
35745         - name: l3-interface-ipv4-address
35746           in: path
35747           description: IP address
35748           required: true
35749           type: string
35750           example: __L3-INTERFACE-IPV4-ADDRESS__
35751         - name: body
35752           in: body
35753           description: l3-interface-ipv4-address-list object that needs to be created or updated.
35754           required: true
35755           schema:
35756             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35757     delete:
35758       tags:
35759         - Network
35760       summary: delete an existing l3-interface-ipv4-address-list
35761       description: delete an existing l3-interface-ipv4-address-list
35762       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35763       consumes:
35764         - application/json
35765         - application/xml
35766       produces:
35767         - application/json
35768         - application/xml
35769       responses:
35770         "default":
35771           description: Response codes found in [response codes](https://wiki.onap.org/).
35772       parameters:
35773         - name: vnf-id
35774           in: path
35775           description: Unique id of VNF.  This is unique across the graph.
35776           required: true
35777           type: string
35778           example: __VNF-ID__
35779         - name: interface-name
35780           in: path
35781           description: Name given to the interface
35782           required: true
35783           type: string
35784           example: __INTERFACE-NAME__
35785         - name: vlan-interface
35786           in: path
35787           description: String that identifies the interface
35788           required: true
35789           type: string
35790           example: __VLAN-INTERFACE__
35791         - name: l3-interface-ipv4-address
35792           in: path
35793           description: IP address
35794           required: true
35795           type: string
35796           example: __L3-INTERFACE-IPV4-ADDRESS__
35797         - name: resource-version
35798           in: query
35799           description: resource-version for concurrency
35800           required: true
35801           type: string
35802   /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:
35803     put:
35804       tags:
35805         - Network
35806       summary: see node definition for valid relationships
35807       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35808       consumes:
35809         - application/json
35810         - application/xml
35811       produces:
35812         - application/json
35813         - application/xml
35814       responses:
35815         "default":
35816           description: Response codes found in [response codes](https://wiki.onap.org/).
35817       parameters:
35818         - name: vnf-id
35819           in: path
35820           description: Unique id of VNF.  This is unique across the graph.
35821           required: true
35822           type: string
35823           example: __VNF-ID__
35824         - name: interface-name
35825           in: path
35826           description: Name given to the interface
35827           required: true
35828           type: string
35829           example: __INTERFACE-NAME__
35830         - name: vlan-interface
35831           in: path
35832           description: String that identifies the interface
35833           required: true
35834           type: string
35835           example: __VLAN-INTERFACE__
35836         - name: l3-interface-ipv6-address
35837           in: path
35838           description: IP address
35839           required: true
35840           type: string
35841           example: __L3-INTERFACE-IPV6-ADDRESS__
35842         - name: body
35843           in: body
35844           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35845           required: true
35846           schema:
35847             $ref: "#/definitions/relationship"
35848     delete:
35849       tags:
35850         - Network
35851       summary: delete an existing relationship
35852       description: delete an existing relationship
35853       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35854       consumes:
35855         - application/json
35856         - application/xml
35857       produces:
35858         - application/json
35859         - application/xml
35860       responses:
35861         "default":
35862           description: Response codes found in [response codes](https://wiki.onap.org/).
35863       parameters:
35864         - name: vnf-id
35865           in: path
35866           description: Unique id of VNF.  This is unique across the graph.
35867           required: true
35868           type: string
35869           example: __VNF-ID__
35870         - name: interface-name
35871           in: path
35872           description: Name given to the interface
35873           required: true
35874           type: string
35875           example: __INTERFACE-NAME__
35876         - name: vlan-interface
35877           in: path
35878           description: String that identifies the interface
35879           required: true
35880           type: string
35881           example: __VLAN-INTERFACE__
35882         - name: l3-interface-ipv6-address
35883           in: path
35884           description: IP address
35885           required: true
35886           type: string
35887           example: __L3-INTERFACE-IPV6-ADDRESS__
35888   /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}:
35889     get:
35890       tags:
35891         - Network
35892       summary: returns l3-interface-ipv6-address-list
35893       description: returns l3-interface-ipv6-address-list
35894       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35895       produces:
35896         - application/json
35897         - application/xml
35898       responses:
35899         "200":
35900           description: successful operation
35901           schema:
35902               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35903         "default":
35904           description: Response codes found in [response codes](https://wiki.onap.org/).
35905       parameters:
35906         - name: vnf-id
35907           in: path
35908           description: Unique id of VNF.  This is unique across the graph.
35909           required: true
35910           type: string
35911           example: __VNF-ID__
35912         - name: interface-name
35913           in: path
35914           description: Name given to the interface
35915           required: true
35916           type: string
35917           example: __INTERFACE-NAME__
35918         - name: vlan-interface
35919           in: path
35920           description: String that identifies the interface
35921           required: true
35922           type: string
35923           example: __VLAN-INTERFACE__
35924         - name: l3-interface-ipv6-address
35925           in: path
35926           description: IP address
35927           required: true
35928           type: string
35929           example: __L3-INTERFACE-IPV6-ADDRESS__
35930         - name: vnf-name
35931           in: query
35932           description: Name of VNF.
35933           required: false
35934           type: string
35935         - name: vnf-name2
35936           in: query
35937           description: Alternate name of VNF.
35938           required: false
35939           type: string
35940         - name: vnf-type
35941           in: query
35942           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.
35943           required: false
35944           type: string
35945         - name: service-id
35946           in: query
35947           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35948           required: false
35949           type: string
35950         - name: regional-resource-zone
35951           in: query
35952           description: Regional way of organizing pservers, source of truth should define values
35953           required: false
35954           type: string
35955         - name: prov-status
35956           in: query
35957           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35958           required: false
35959           type: string
35960         - name: heat-stack-id
35961           in: query
35962           description: Heat stack id corresponding to this instance, managed by MSO
35963           required: false
35964           type: string
35965         - name: in-maint
35966           in: query
35967           required: false
35968           type: boolean
35969         - name: is-closed-loop-disabled
35970           in: query
35971           required: false
35972           type: boolean
35973         - name: model-invariant-id
35974           in: query
35975           description: the ASDC model id for this resource or service model.
35976           required: false
35977           type: string
35978         - name: model-version-id
35979           in: query
35980           description: the ASDC model version for this resource or service model.
35981           required: false
35982           type: string
35983         - name: widget-model-id
35984           in: query
35985           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35986           required: false
35987           type: string
35988         - name: widget-model-version
35989           in: query
35990           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35991           required: false
35992           type: string
35993         - name: nf-type
35994           in: query
35995           description: Generic description of the type of NF
35996           required: false
35997           type: string
35998         - name: nf-function
35999           in: query
36000           description: English description of Network function that the specific VNF deployment is providing
36001           required: false
36002           type: string
36003         - name: nf-role
36004           in: query
36005           description: role in the network that this model will be providing
36006           required: false
36007           type: string
36008         - name: nf-naming-code
36009           in: query
36010           description: string assigned to this model used for naming purposes
36011           required: false
36012           type: string
36013         - name: interface-id
36014           in: query
36015           description: ID of interface
36016           required: false
36017           type: string
36018         - name: macaddr
36019           in: query
36020           description: MAC address for the interface
36021           required: false
36022           type: string
36023         - name: network-name
36024           in: query
36025           description: Name of the network
36026           required: false
36027           type: string
36028         - name: vlan-id-inner
36029           in: query
36030           description: Inner VLAN tag
36031           required: false
36032           type: integer
36033           format: int64
36034         - name: vpn-key
36035           in: query
36036           description: This indicates the customers VPN ID associated with this vlan
36037           required: false
36038           type: string
36039         - name: vlan-id-inner
36040           in: query
36041           description: Inner VLAN tag
36042           required: false
36043           type: integer
36044           format: int64
36045         - name: neutron-network-id
36046           in: query
36047           description: Neutron network id of the interface that address belongs to
36048           required: false
36049           type: string
36050         - name: neutron-subnet-id
36051           in: query
36052           description: Neutron id of subnet that address belongs to
36053           required: false
36054           type: string
36055     put:
36056       tags:
36057         - Network
36058       summary: create or update an existing l3-interface-ipv6-address-list
36059       description: |
36060         Create or update an existing l3-interface-ipv6-address-list.
36061         #
36062         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36063       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36064       consumes:
36065         - application/json
36066         - application/xml
36067       produces:
36068         - application/json
36069         - application/xml
36070       responses:
36071         "default":
36072           description: Response codes found in [response codes](https://wiki.onap.org/).
36073       parameters:
36074         - name: vnf-id
36075           in: path
36076           description: Unique id of VNF.  This is unique across the graph.
36077           required: true
36078           type: string
36079           example: __VNF-ID__
36080         - name: interface-name
36081           in: path
36082           description: Name given to the interface
36083           required: true
36084           type: string
36085           example: __INTERFACE-NAME__
36086         - name: vlan-interface
36087           in: path
36088           description: String that identifies the interface
36089           required: true
36090           type: string
36091           example: __VLAN-INTERFACE__
36092         - name: l3-interface-ipv6-address
36093           in: path
36094           description: IP address
36095           required: true
36096           type: string
36097           example: __L3-INTERFACE-IPV6-ADDRESS__
36098         - name: body
36099           in: body
36100           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
36101           required: true
36102           schema:
36103             $ref: "#/definitions/l3-interface-ipv6-address-list"
36104     patch:
36105       tags:
36106         - Network
36107       summary: update an existing l3-interface-ipv6-address-list
36108       description: |
36109         Update an existing l3-interface-ipv6-address-list
36110         #
36111         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36112         The PUT operation will entirely replace an existing object.
36113         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36114         #
36115         Other differences between PUT and PATCH are:
36116         #
36117         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36118         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36119         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36120       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36121       consumes:
36122         - application/json
36123         - application/xml
36124       produces:
36125         - application/json
36126         - application/xml
36127       responses:
36128         "default":
36129           description: Response codes found in [response codes](https://wiki.onap.org/).
36130       parameters:
36131         - name: vnf-id
36132           in: path
36133           description: Unique id of VNF.  This is unique across the graph.
36134           required: true
36135           type: string
36136           example: __VNF-ID__
36137         - name: interface-name
36138           in: path
36139           description: Name given to the interface
36140           required: true
36141           type: string
36142           example: __INTERFACE-NAME__
36143         - name: vlan-interface
36144           in: path
36145           description: String that identifies the interface
36146           required: true
36147           type: string
36148           example: __VLAN-INTERFACE__
36149         - name: l3-interface-ipv6-address
36150           in: path
36151           description: IP address
36152           required: true
36153           type: string
36154           example: __L3-INTERFACE-IPV6-ADDRESS__
36155         - name: body
36156           in: body
36157           description: l3-interface-ipv6-address-list object that needs to be created or updated.
36158           required: true
36159           schema:
36160             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36161     delete:
36162       tags:
36163         - Network
36164       summary: delete an existing l3-interface-ipv6-address-list
36165       description: delete an existing l3-interface-ipv6-address-list
36166       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36167       consumes:
36168         - application/json
36169         - application/xml
36170       produces:
36171         - application/json
36172         - application/xml
36173       responses:
36174         "default":
36175           description: Response codes found in [response codes](https://wiki.onap.org/).
36176       parameters:
36177         - name: vnf-id
36178           in: path
36179           description: Unique id of VNF.  This is unique across the graph.
36180           required: true
36181           type: string
36182           example: __VNF-ID__
36183         - name: interface-name
36184           in: path
36185           description: Name given to the interface
36186           required: true
36187           type: string
36188           example: __INTERFACE-NAME__
36189         - name: vlan-interface
36190           in: path
36191           description: String that identifies the interface
36192           required: true
36193           type: string
36194           example: __VLAN-INTERFACE__
36195         - name: l3-interface-ipv6-address
36196           in: path
36197           description: IP address
36198           required: true
36199           type: string
36200           example: __L3-INTERFACE-IPV6-ADDRESS__
36201         - name: resource-version
36202           in: query
36203           description: resource-version for concurrency
36204           required: true
36205           type: string
36206   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
36207     get:
36208       tags:
36209         - Network
36210       summary: returns vlan
36211       description: returns vlan
36212       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36213       produces:
36214         - application/json
36215         - application/xml
36216       responses:
36217         "200":
36218           description: successful operation
36219           schema:
36220               $ref: "#/getDefinitions/vlan"
36221         "default":
36222           description: Response codes found in [response codes](https://wiki.onap.org/).
36223       parameters:
36224         - name: vnf-id
36225           in: path
36226           description: Unique id of VNF.  This is unique across the graph.
36227           required: true
36228           type: string
36229           example: __VNF-ID__
36230         - name: interface-name
36231           in: path
36232           description: Name given to the interface
36233           required: true
36234           type: string
36235           example: __INTERFACE-NAME__
36236         - name: vlan-interface
36237           in: path
36238           description: String that identifies the interface
36239           required: true
36240           type: string
36241           example: __VLAN-INTERFACE__
36242         - name: vnf-name
36243           in: query
36244           description: Name of VNF.
36245           required: false
36246           type: string
36247         - name: vnf-name2
36248           in: query
36249           description: Alternate name of VNF.
36250           required: false
36251           type: string
36252         - name: vnf-type
36253           in: query
36254           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.
36255           required: false
36256           type: string
36257         - name: service-id
36258           in: query
36259           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36260           required: false
36261           type: string
36262         - name: regional-resource-zone
36263           in: query
36264           description: Regional way of organizing pservers, source of truth should define values
36265           required: false
36266           type: string
36267         - name: prov-status
36268           in: query
36269           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36270           required: false
36271           type: string
36272         - name: heat-stack-id
36273           in: query
36274           description: Heat stack id corresponding to this instance, managed by MSO
36275           required: false
36276           type: string
36277         - name: in-maint
36278           in: query
36279           required: false
36280           type: boolean
36281         - name: is-closed-loop-disabled
36282           in: query
36283           required: false
36284           type: boolean
36285         - name: model-invariant-id
36286           in: query
36287           description: the ASDC model id for this resource or service model.
36288           required: false
36289           type: string
36290         - name: model-version-id
36291           in: query
36292           description: the ASDC model version for this resource or service model.
36293           required: false
36294           type: string
36295         - name: widget-model-id
36296           in: query
36297           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36298           required: false
36299           type: string
36300         - name: widget-model-version
36301           in: query
36302           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36303           required: false
36304           type: string
36305         - name: nf-type
36306           in: query
36307           description: Generic description of the type of NF
36308           required: false
36309           type: string
36310         - name: nf-function
36311           in: query
36312           description: English description of Network function that the specific VNF deployment is providing
36313           required: false
36314           type: string
36315         - name: nf-role
36316           in: query
36317           description: role in the network that this model will be providing
36318           required: false
36319           type: string
36320         - name: nf-naming-code
36321           in: query
36322           description: string assigned to this model used for naming purposes
36323           required: false
36324           type: string
36325         - name: interface-id
36326           in: query
36327           description: ID of interface
36328           required: false
36329           type: string
36330         - name: macaddr
36331           in: query
36332           description: MAC address for the interface
36333           required: false
36334           type: string
36335         - name: network-name
36336           in: query
36337           description: Name of the network
36338           required: false
36339           type: string
36340         - name: vlan-id-inner
36341           in: query
36342           description: Inner VLAN tag
36343           required: false
36344           type: integer
36345           format: int64
36346         - name: vpn-key
36347           in: query
36348           description: This indicates the customers VPN ID associated with this vlan
36349           required: false
36350           type: string
36351     put:
36352       tags:
36353         - Network
36354       summary: create or update an existing vlan
36355       description: |
36356         Create or update an existing vlan.
36357         #
36358         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36359       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36360       consumes:
36361         - application/json
36362         - application/xml
36363       produces:
36364         - application/json
36365         - application/xml
36366       responses:
36367         "default":
36368           description: Response codes found in [response codes](https://wiki.onap.org/).
36369       parameters:
36370         - name: vnf-id
36371           in: path
36372           description: Unique id of VNF.  This is unique across the graph.
36373           required: true
36374           type: string
36375           example: __VNF-ID__
36376         - name: interface-name
36377           in: path
36378           description: Name given to the interface
36379           required: true
36380           type: string
36381           example: __INTERFACE-NAME__
36382         - name: vlan-interface
36383           in: path
36384           description: String that identifies the interface
36385           required: true
36386           type: string
36387           example: __VLAN-INTERFACE__
36388         - name: body
36389           in: body
36390           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
36391           required: true
36392           schema:
36393             $ref: "#/definitions/vlan"
36394     patch:
36395       tags:
36396         - Network
36397       summary: update an existing vlan
36398       description: |
36399         Update an existing vlan
36400         #
36401         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36402         The PUT operation will entirely replace an existing object.
36403         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36404         #
36405         Other differences between PUT and PATCH are:
36406         #
36407         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36408         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36409         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36410       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36411       consumes:
36412         - application/json
36413         - application/xml
36414       produces:
36415         - application/json
36416         - application/xml
36417       responses:
36418         "default":
36419           description: Response codes found in [response codes](https://wiki.onap.org/).
36420       parameters:
36421         - name: vnf-id
36422           in: path
36423           description: Unique id of VNF.  This is unique across the graph.
36424           required: true
36425           type: string
36426           example: __VNF-ID__
36427         - name: interface-name
36428           in: path
36429           description: Name given to the interface
36430           required: true
36431           type: string
36432           example: __INTERFACE-NAME__
36433         - name: vlan-interface
36434           in: path
36435           description: String that identifies the interface
36436           required: true
36437           type: string
36438           example: __VLAN-INTERFACE__
36439         - name: body
36440           in: body
36441           description: vlan object that needs to be created or updated.
36442           required: true
36443           schema:
36444             $ref: "#/patchDefinitions/vlan"
36445     delete:
36446       tags:
36447         - Network
36448       summary: delete an existing vlan
36449       description: delete an existing vlan
36450       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36451       consumes:
36452         - application/json
36453         - application/xml
36454       produces:
36455         - application/json
36456         - application/xml
36457       responses:
36458         "default":
36459           description: Response codes found in [response codes](https://wiki.onap.org/).
36460       parameters:
36461         - name: vnf-id
36462           in: path
36463           description: Unique id of VNF.  This is unique across the graph.
36464           required: true
36465           type: string
36466           example: __VNF-ID__
36467         - name: interface-name
36468           in: path
36469           description: Name given to the interface
36470           required: true
36471           type: string
36472           example: __INTERFACE-NAME__
36473         - name: vlan-interface
36474           in: path
36475           description: String that identifies the interface
36476           required: true
36477           type: string
36478           example: __VLAN-INTERFACE__
36479         - name: resource-version
36480           in: query
36481           description: resource-version for concurrency
36482           required: true
36483           type: string
36484   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
36485     get:
36486       tags:
36487         - Network
36488       summary: returns vlans
36489       description: returns vlans
36490       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
36491       produces:
36492         - application/json
36493         - application/xml
36494       responses:
36495         "200":
36496           description: successful operation
36497           schema:
36498               $ref: "#/getDefinitions/vlans"
36499         "default":
36500           description: Response codes found in [response codes](https://wiki.onap.org/).
36501       parameters:
36502         - name: vnf-id
36503           in: path
36504           description: Unique id of VNF.  This is unique across the graph.
36505           required: true
36506           type: string
36507           example: __VNF-ID__
36508         - name: interface-name
36509           in: path
36510           description: Name given to the interface
36511           required: true
36512           type: string
36513           example: __INTERFACE-NAME__
36514         - name: vnf-name
36515           in: query
36516           description: Name of VNF.
36517           required: false
36518           type: string
36519         - name: vnf-name2
36520           in: query
36521           description: Alternate name of VNF.
36522           required: false
36523           type: string
36524         - name: vnf-type
36525           in: query
36526           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.
36527           required: false
36528           type: string
36529         - name: service-id
36530           in: query
36531           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36532           required: false
36533           type: string
36534         - name: regional-resource-zone
36535           in: query
36536           description: Regional way of organizing pservers, source of truth should define values
36537           required: false
36538           type: string
36539         - name: prov-status
36540           in: query
36541           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36542           required: false
36543           type: string
36544         - name: heat-stack-id
36545           in: query
36546           description: Heat stack id corresponding to this instance, managed by MSO
36547           required: false
36548           type: string
36549         - name: in-maint
36550           in: query
36551           required: false
36552           type: boolean
36553         - name: is-closed-loop-disabled
36554           in: query
36555           required: false
36556           type: boolean
36557         - name: model-invariant-id
36558           in: query
36559           description: the ASDC model id for this resource or service model.
36560           required: false
36561           type: string
36562         - name: model-version-id
36563           in: query
36564           description: the ASDC model version for this resource or service model.
36565           required: false
36566           type: string
36567         - name: widget-model-id
36568           in: query
36569           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36570           required: false
36571           type: string
36572         - name: widget-model-version
36573           in: query
36574           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36575           required: false
36576           type: string
36577         - name: nf-type
36578           in: query
36579           description: Generic description of the type of NF
36580           required: false
36581           type: string
36582         - name: nf-function
36583           in: query
36584           description: English description of Network function that the specific VNF deployment is providing
36585           required: false
36586           type: string
36587         - name: nf-role
36588           in: query
36589           description: role in the network that this model will be providing
36590           required: false
36591           type: string
36592         - name: nf-naming-code
36593           in: query
36594           description: string assigned to this model used for naming purposes
36595           required: false
36596           type: string
36597         - name: interface-id
36598           in: query
36599           description: ID of interface
36600           required: false
36601           type: string
36602         - name: macaddr
36603           in: query
36604           description: MAC address for the interface
36605           required: false
36606           type: string
36607         - name: network-name
36608           in: query
36609           description: Name of the network
36610           required: false
36611           type: string
36612   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
36613     put:
36614       tags:
36615         - Network
36616       summary: see node definition for valid relationships
36617       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36618       consumes:
36619         - application/json
36620         - application/xml
36621       produces:
36622         - application/json
36623         - application/xml
36624       responses:
36625         "default":
36626           description: Response codes found in [response codes](https://wiki.onap.org/).
36627       parameters:
36628         - name: vnf-id
36629           in: path
36630           description: Unique id of VNF.  This is unique across the graph.
36631           required: true
36632           type: string
36633           example: __VNF-ID__
36634         - name: interface-name
36635           in: path
36636           description: Name given to the interface
36637           required: true
36638           type: string
36639           example: __INTERFACE-NAME__
36640         - name: pci-id
36641           in: path
36642           description: PCI ID used to identify the sriov-vf
36643           required: true
36644           type: string
36645           example: __PCI-ID__
36646         - name: body
36647           in: body
36648           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
36649           required: true
36650           schema:
36651             $ref: "#/definitions/relationship"
36652     delete:
36653       tags:
36654         - Network
36655       summary: delete an existing relationship
36656       description: delete an existing relationship
36657       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36658       consumes:
36659         - application/json
36660         - application/xml
36661       produces:
36662         - application/json
36663         - application/xml
36664       responses:
36665         "default":
36666           description: Response codes found in [response codes](https://wiki.onap.org/).
36667       parameters:
36668         - name: vnf-id
36669           in: path
36670           description: Unique id of VNF.  This is unique across the graph.
36671           required: true
36672           type: string
36673           example: __VNF-ID__
36674         - name: interface-name
36675           in: path
36676           description: Name given to the interface
36677           required: true
36678           type: string
36679           example: __INTERFACE-NAME__
36680         - name: pci-id
36681           in: path
36682           description: PCI ID used to identify the sriov-vf
36683           required: true
36684           type: string
36685           example: __PCI-ID__
36686   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36687     get:
36688       tags:
36689         - Network
36690       summary: returns sriov-vf
36691       description: returns sriov-vf
36692       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36693       produces:
36694         - application/json
36695         - application/xml
36696       responses:
36697         "200":
36698           description: successful operation
36699           schema:
36700               $ref: "#/getDefinitions/sriov-vf"
36701         "default":
36702           description: Response codes found in [response codes](https://wiki.onap.org/).
36703       parameters:
36704         - name: vnf-id
36705           in: path
36706           description: Unique id of VNF.  This is unique across the graph.
36707           required: true
36708           type: string
36709           example: __VNF-ID__
36710         - name: interface-name
36711           in: path
36712           description: Name given to the interface
36713           required: true
36714           type: string
36715           example: __INTERFACE-NAME__
36716         - name: pci-id
36717           in: path
36718           description: PCI ID used to identify the sriov-vf
36719           required: true
36720           type: string
36721           example: __PCI-ID__
36722         - name: vnf-name
36723           in: query
36724           description: Name of VNF.
36725           required: false
36726           type: string
36727         - name: vnf-name2
36728           in: query
36729           description: Alternate name of VNF.
36730           required: false
36731           type: string
36732         - name: vnf-type
36733           in: query
36734           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.
36735           required: false
36736           type: string
36737         - name: service-id
36738           in: query
36739           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36740           required: false
36741           type: string
36742         - name: regional-resource-zone
36743           in: query
36744           description: Regional way of organizing pservers, source of truth should define values
36745           required: false
36746           type: string
36747         - name: prov-status
36748           in: query
36749           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36750           required: false
36751           type: string
36752         - name: heat-stack-id
36753           in: query
36754           description: Heat stack id corresponding to this instance, managed by MSO
36755           required: false
36756           type: string
36757         - name: in-maint
36758           in: query
36759           required: false
36760           type: boolean
36761         - name: is-closed-loop-disabled
36762           in: query
36763           required: false
36764           type: boolean
36765         - name: model-invariant-id
36766           in: query
36767           description: the ASDC model id for this resource or service model.
36768           required: false
36769           type: string
36770         - name: model-version-id
36771           in: query
36772           description: the ASDC model version for this resource or service model.
36773           required: false
36774           type: string
36775         - name: widget-model-id
36776           in: query
36777           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36778           required: false
36779           type: string
36780         - name: widget-model-version
36781           in: query
36782           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36783           required: false
36784           type: string
36785         - name: nf-type
36786           in: query
36787           description: Generic description of the type of NF
36788           required: false
36789           type: string
36790         - name: nf-function
36791           in: query
36792           description: English description of Network function that the specific VNF deployment is providing
36793           required: false
36794           type: string
36795         - name: nf-role
36796           in: query
36797           description: role in the network that this model will be providing
36798           required: false
36799           type: string
36800         - name: nf-naming-code
36801           in: query
36802           description: string assigned to this model used for naming purposes
36803           required: false
36804           type: string
36805         - name: interface-id
36806           in: query
36807           description: ID of interface
36808           required: false
36809           type: string
36810         - name: macaddr
36811           in: query
36812           description: MAC address for the interface
36813           required: false
36814           type: string
36815         - name: network-name
36816           in: query
36817           description: Name of the network
36818           required: false
36819           type: string
36820         - name: vf-vlan-filter
36821           in: query
36822           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
36823           required: false
36824           type: string
36825         - name: vf-mac-filter
36826           in: query
36827           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
36828           required: false
36829           type: string
36830         - name: vf-vlan-strip
36831           in: query
36832           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
36833           required: false
36834           type: boolean
36835         - name: neutron-network-id
36836           in: query
36837           description: Neutron network id of the interface
36838           required: false
36839           type: string
36840     put:
36841       tags:
36842         - Network
36843       summary: create or update an existing sriov-vf
36844       description: |
36845         Create or update an existing sriov-vf.
36846         #
36847         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36848       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36849       consumes:
36850         - application/json
36851         - application/xml
36852       produces:
36853         - application/json
36854         - application/xml
36855       responses:
36856         "default":
36857           description: Response codes found in [response codes](https://wiki.onap.org/).
36858       parameters:
36859         - name: vnf-id
36860           in: path
36861           description: Unique id of VNF.  This is unique across the graph.
36862           required: true
36863           type: string
36864           example: __VNF-ID__
36865         - name: interface-name
36866           in: path
36867           description: Name given to the interface
36868           required: true
36869           type: string
36870           example: __INTERFACE-NAME__
36871         - name: pci-id
36872           in: path
36873           description: PCI ID used to identify the sriov-vf
36874           required: true
36875           type: string
36876           example: __PCI-ID__
36877         - name: body
36878           in: body
36879           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
36880           required: true
36881           schema:
36882             $ref: "#/definitions/sriov-vf"
36883     patch:
36884       tags:
36885         - Network
36886       summary: update an existing sriov-vf
36887       description: |
36888         Update an existing sriov-vf
36889         #
36890         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36891         The PUT operation will entirely replace an existing object.
36892         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36893         #
36894         Other differences between PUT and PATCH are:
36895         #
36896         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36897         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36898         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36899       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36900       consumes:
36901         - application/json
36902         - application/xml
36903       produces:
36904         - application/json
36905         - application/xml
36906       responses:
36907         "default":
36908           description: Response codes found in [response codes](https://wiki.onap.org/).
36909       parameters:
36910         - name: vnf-id
36911           in: path
36912           description: Unique id of VNF.  This is unique across the graph.
36913           required: true
36914           type: string
36915           example: __VNF-ID__
36916         - name: interface-name
36917           in: path
36918           description: Name given to the interface
36919           required: true
36920           type: string
36921           example: __INTERFACE-NAME__
36922         - name: pci-id
36923           in: path
36924           description: PCI ID used to identify the sriov-vf
36925           required: true
36926           type: string
36927           example: __PCI-ID__
36928         - name: body
36929           in: body
36930           description: sriov-vf object that needs to be created or updated.
36931           required: true
36932           schema:
36933             $ref: "#/patchDefinitions/sriov-vf"
36934     delete:
36935       tags:
36936         - Network
36937       summary: delete an existing sriov-vf
36938       description: delete an existing sriov-vf
36939       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36940       consumes:
36941         - application/json
36942         - application/xml
36943       produces:
36944         - application/json
36945         - application/xml
36946       responses:
36947         "default":
36948           description: Response codes found in [response codes](https://wiki.onap.org/).
36949       parameters:
36950         - name: vnf-id
36951           in: path
36952           description: Unique id of VNF.  This is unique across the graph.
36953           required: true
36954           type: string
36955           example: __VNF-ID__
36956         - name: interface-name
36957           in: path
36958           description: Name given to the interface
36959           required: true
36960           type: string
36961           example: __INTERFACE-NAME__
36962         - name: pci-id
36963           in: path
36964           description: PCI ID used to identify the sriov-vf
36965           required: true
36966           type: string
36967           example: __PCI-ID__
36968         - name: resource-version
36969           in: query
36970           description: resource-version for concurrency
36971           required: true
36972           type: string
36973   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36974     get:
36975       tags:
36976         - Network
36977       summary: returns sriov-vfs
36978       description: returns sriov-vfs
36979       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
36980       produces:
36981         - application/json
36982         - application/xml
36983       responses:
36984         "200":
36985           description: successful operation
36986           schema:
36987               $ref: "#/getDefinitions/sriov-vfs"
36988         "default":
36989           description: Response codes found in [response codes](https://wiki.onap.org/).
36990       parameters:
36991         - name: vnf-id
36992           in: path
36993           description: Unique id of VNF.  This is unique across the graph.
36994           required: true
36995           type: string
36996           example: __VNF-ID__
36997         - name: interface-name
36998           in: path
36999           description: Name given to the interface
37000           required: true
37001           type: string
37002           example: __INTERFACE-NAME__
37003         - name: vnf-name
37004           in: query
37005           description: Name of VNF.
37006           required: false
37007           type: string
37008         - name: vnf-name2
37009           in: query
37010           description: Alternate name of VNF.
37011           required: false
37012           type: string
37013         - name: vnf-type
37014           in: query
37015           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.
37016           required: false
37017           type: string
37018         - name: service-id
37019           in: query
37020           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37021           required: false
37022           type: string
37023         - name: regional-resource-zone
37024           in: query
37025           description: Regional way of organizing pservers, source of truth should define values
37026           required: false
37027           type: string
37028         - name: prov-status
37029           in: query
37030           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37031           required: false
37032           type: string
37033         - name: heat-stack-id
37034           in: query
37035           description: Heat stack id corresponding to this instance, managed by MSO
37036           required: false
37037           type: string
37038         - name: in-maint
37039           in: query
37040           required: false
37041           type: boolean
37042         - name: is-closed-loop-disabled
37043           in: query
37044           required: false
37045           type: boolean
37046         - name: model-invariant-id
37047           in: query
37048           description: the ASDC model id for this resource or service model.
37049           required: false
37050           type: string
37051         - name: model-version-id
37052           in: query
37053           description: the ASDC model version for this resource or service model.
37054           required: false
37055           type: string
37056         - name: widget-model-id
37057           in: query
37058           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37059           required: false
37060           type: string
37061         - name: widget-model-version
37062           in: query
37063           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37064           required: false
37065           type: string
37066         - name: nf-type
37067           in: query
37068           description: Generic description of the type of NF
37069           required: false
37070           type: string
37071         - name: nf-function
37072           in: query
37073           description: English description of Network function that the specific VNF deployment is providing
37074           required: false
37075           type: string
37076         - name: nf-role
37077           in: query
37078           description: role in the network that this model will be providing
37079           required: false
37080           type: string
37081         - name: nf-naming-code
37082           in: query
37083           description: string assigned to this model used for naming purposes
37084           required: false
37085           type: string
37086         - name: interface-id
37087           in: query
37088           description: ID of interface
37089           required: false
37090           type: string
37091         - name: macaddr
37092           in: query
37093           description: MAC address for the interface
37094           required: false
37095           type: string
37096         - name: network-name
37097           in: query
37098           description: Name of the network
37099           required: false
37100           type: string
37101   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
37102     put:
37103       tags:
37104         - Network
37105       summary: see node definition for valid relationships
37106       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
37107       consumes:
37108         - application/json
37109         - application/xml
37110       produces:
37111         - application/json
37112         - application/xml
37113       responses:
37114         "default":
37115           description: Response codes found in [response codes](https://wiki.onap.org/).
37116       parameters:
37117         - name: vnf-id
37118           in: path
37119           description: Unique id of VNF.  This is unique across the graph.
37120           required: true
37121           type: string
37122           example: __VNF-ID__
37123         - name: interface-name
37124           in: path
37125           description: Name given to the interface
37126           required: true
37127           type: string
37128           example: __INTERFACE-NAME__
37129         - name: body
37130           in: body
37131           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
37132           required: true
37133           schema:
37134             $ref: "#/definitions/relationship"
37135     delete:
37136       tags:
37137         - Network
37138       summary: delete an existing relationship
37139       description: delete an existing relationship
37140       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
37141       consumes:
37142         - application/json
37143         - application/xml
37144       produces:
37145         - application/json
37146         - application/xml
37147       responses:
37148         "default":
37149           description: Response codes found in [response codes](https://wiki.onap.org/).
37150       parameters:
37151         - name: vnf-id
37152           in: path
37153           description: Unique id of VNF.  This is unique across the graph.
37154           required: true
37155           type: string
37156           example: __VNF-ID__
37157         - name: interface-name
37158           in: path
37159           description: Name given to the interface
37160           required: true
37161           type: string
37162           example: __INTERFACE-NAME__
37163   /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:
37164     put:
37165       tags:
37166         - Network
37167       summary: see node definition for valid relationships
37168       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
37169       consumes:
37170         - application/json
37171         - application/xml
37172       produces:
37173         - application/json
37174         - application/xml
37175       responses:
37176         "default":
37177           description: Response codes found in [response codes](https://wiki.onap.org/).
37178       parameters:
37179         - name: vnf-id
37180           in: path
37181           description: Unique id of VNF.  This is unique across the graph.
37182           required: true
37183           type: string
37184           example: __VNF-ID__
37185         - name: interface-name
37186           in: path
37187           description: Name given to the interface
37188           required: true
37189           type: string
37190           example: __INTERFACE-NAME__
37191         - name: l3-interface-ipv4-address
37192           in: path
37193           description: IP address
37194           required: true
37195           type: string
37196           example: __L3-INTERFACE-IPV4-ADDRESS__
37197         - name: body
37198           in: body
37199           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37200           required: true
37201           schema:
37202             $ref: "#/definitions/relationship"
37203     delete:
37204       tags:
37205         - Network
37206       summary: delete an existing relationship
37207       description: delete an existing relationship
37208       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
37209       consumes:
37210         - application/json
37211         - application/xml
37212       produces:
37213         - application/json
37214         - application/xml
37215       responses:
37216         "default":
37217           description: Response codes found in [response codes](https://wiki.onap.org/).
37218       parameters:
37219         - name: vnf-id
37220           in: path
37221           description: Unique id of VNF.  This is unique across the graph.
37222           required: true
37223           type: string
37224           example: __VNF-ID__
37225         - name: interface-name
37226           in: path
37227           description: Name given to the interface
37228           required: true
37229           type: string
37230           example: __INTERFACE-NAME__
37231         - name: l3-interface-ipv4-address
37232           in: path
37233           description: IP address
37234           required: true
37235           type: string
37236           example: __L3-INTERFACE-IPV4-ADDRESS__
37237   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37238     get:
37239       tags:
37240         - Network
37241       summary: returns l3-interface-ipv4-address-list
37242       description: returns l3-interface-ipv4-address-list
37243       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37244       produces:
37245         - application/json
37246         - application/xml
37247       responses:
37248         "200":
37249           description: successful operation
37250           schema:
37251               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37252         "default":
37253           description: Response codes found in [response codes](https://wiki.onap.org/).
37254       parameters:
37255         - name: vnf-id
37256           in: path
37257           description: Unique id of VNF.  This is unique across the graph.
37258           required: true
37259           type: string
37260           example: __VNF-ID__
37261         - name: interface-name
37262           in: path
37263           description: Name given to the interface
37264           required: true
37265           type: string
37266           example: __INTERFACE-NAME__
37267         - name: l3-interface-ipv4-address
37268           in: path
37269           description: IP address
37270           required: true
37271           type: string
37272           example: __L3-INTERFACE-IPV4-ADDRESS__
37273         - name: vnf-name
37274           in: query
37275           description: Name of VNF.
37276           required: false
37277           type: string
37278         - name: vnf-name2
37279           in: query
37280           description: Alternate name of VNF.
37281           required: false
37282           type: string
37283         - name: vnf-type
37284           in: query
37285           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.
37286           required: false
37287           type: string
37288         - name: service-id
37289           in: query
37290           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37291           required: false
37292           type: string
37293         - name: regional-resource-zone
37294           in: query
37295           description: Regional way of organizing pservers, source of truth should define values
37296           required: false
37297           type: string
37298         - name: prov-status
37299           in: query
37300           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37301           required: false
37302           type: string
37303         - name: heat-stack-id
37304           in: query
37305           description: Heat stack id corresponding to this instance, managed by MSO
37306           required: false
37307           type: string
37308         - name: in-maint
37309           in: query
37310           required: false
37311           type: boolean
37312         - name: is-closed-loop-disabled
37313           in: query
37314           required: false
37315           type: boolean
37316         - name: model-invariant-id
37317           in: query
37318           description: the ASDC model id for this resource or service model.
37319           required: false
37320           type: string
37321         - name: model-version-id
37322           in: query
37323           description: the ASDC model version for this resource or service model.
37324           required: false
37325           type: string
37326         - name: widget-model-id
37327           in: query
37328           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37329           required: false
37330           type: string
37331         - name: widget-model-version
37332           in: query
37333           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37334           required: false
37335           type: string
37336         - name: nf-type
37337           in: query
37338           description: Generic description of the type of NF
37339           required: false
37340           type: string
37341         - name: nf-function
37342           in: query
37343           description: English description of Network function that the specific VNF deployment is providing
37344           required: false
37345           type: string
37346         - name: nf-role
37347           in: query
37348           description: role in the network that this model will be providing
37349           required: false
37350           type: string
37351         - name: nf-naming-code
37352           in: query
37353           description: string assigned to this model used for naming purposes
37354           required: false
37355           type: string
37356         - name: interface-id
37357           in: query
37358           description: ID of interface
37359           required: false
37360           type: string
37361         - name: macaddr
37362           in: query
37363           description: MAC address for the interface
37364           required: false
37365           type: string
37366         - name: network-name
37367           in: query
37368           description: Name of the network
37369           required: false
37370           type: string
37371         - name: vlan-id-inner
37372           in: query
37373           description: Inner VLAN tag
37374           required: false
37375           type: integer
37376           format: int64
37377         - name: neutron-network-id
37378           in: query
37379           description: Neutron network id of the interface that address belongs to
37380           required: false
37381           type: string
37382         - name: neutron-subnet-id
37383           in: query
37384           description: Neutron id of subnet that address belongs to
37385           required: false
37386           type: string
37387     put:
37388       tags:
37389         - Network
37390       summary: create or update an existing l3-interface-ipv4-address-list
37391       description: |
37392         Create or update an existing l3-interface-ipv4-address-list.
37393         #
37394         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37395       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37396       consumes:
37397         - application/json
37398         - application/xml
37399       produces:
37400         - application/json
37401         - application/xml
37402       responses:
37403         "default":
37404           description: Response codes found in [response codes](https://wiki.onap.org/).
37405       parameters:
37406         - name: vnf-id
37407           in: path
37408           description: Unique id of VNF.  This is unique across the graph.
37409           required: true
37410           type: string
37411           example: __VNF-ID__
37412         - name: interface-name
37413           in: path
37414           description: Name given to the interface
37415           required: true
37416           type: string
37417           example: __INTERFACE-NAME__
37418         - name: l3-interface-ipv4-address
37419           in: path
37420           description: IP address
37421           required: true
37422           type: string
37423           example: __L3-INTERFACE-IPV4-ADDRESS__
37424         - name: body
37425           in: body
37426           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37427           required: true
37428           schema:
37429             $ref: "#/definitions/l3-interface-ipv4-address-list"
37430     patch:
37431       tags:
37432         - Network
37433       summary: update an existing l3-interface-ipv4-address-list
37434       description: |
37435         Update an existing l3-interface-ipv4-address-list
37436         #
37437         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37438         The PUT operation will entirely replace an existing object.
37439         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37440         #
37441         Other differences between PUT and PATCH are:
37442         #
37443         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37444         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37445         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37446       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37447       consumes:
37448         - application/json
37449         - application/xml
37450       produces:
37451         - application/json
37452         - application/xml
37453       responses:
37454         "default":
37455           description: Response codes found in [response codes](https://wiki.onap.org/).
37456       parameters:
37457         - name: vnf-id
37458           in: path
37459           description: Unique id of VNF.  This is unique across the graph.
37460           required: true
37461           type: string
37462           example: __VNF-ID__
37463         - name: interface-name
37464           in: path
37465           description: Name given to the interface
37466           required: true
37467           type: string
37468           example: __INTERFACE-NAME__
37469         - name: l3-interface-ipv4-address
37470           in: path
37471           description: IP address
37472           required: true
37473           type: string
37474           example: __L3-INTERFACE-IPV4-ADDRESS__
37475         - name: body
37476           in: body
37477           description: l3-interface-ipv4-address-list object that needs to be created or updated.
37478           required: true
37479           schema:
37480             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37481     delete:
37482       tags:
37483         - Network
37484       summary: delete an existing l3-interface-ipv4-address-list
37485       description: delete an existing l3-interface-ipv4-address-list
37486       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37487       consumes:
37488         - application/json
37489         - application/xml
37490       produces:
37491         - application/json
37492         - application/xml
37493       responses:
37494         "default":
37495           description: Response codes found in [response codes](https://wiki.onap.org/).
37496       parameters:
37497         - name: vnf-id
37498           in: path
37499           description: Unique id of VNF.  This is unique across the graph.
37500           required: true
37501           type: string
37502           example: __VNF-ID__
37503         - name: interface-name
37504           in: path
37505           description: Name given to the interface
37506           required: true
37507           type: string
37508           example: __INTERFACE-NAME__
37509         - name: l3-interface-ipv4-address
37510           in: path
37511           description: IP address
37512           required: true
37513           type: string
37514           example: __L3-INTERFACE-IPV4-ADDRESS__
37515         - name: resource-version
37516           in: query
37517           description: resource-version for concurrency
37518           required: true
37519           type: string
37520   /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:
37521     put:
37522       tags:
37523         - Network
37524       summary: see node definition for valid relationships
37525       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37526       consumes:
37527         - application/json
37528         - application/xml
37529       produces:
37530         - application/json
37531         - application/xml
37532       responses:
37533         "default":
37534           description: Response codes found in [response codes](https://wiki.onap.org/).
37535       parameters:
37536         - name: vnf-id
37537           in: path
37538           description: Unique id of VNF.  This is unique across the graph.
37539           required: true
37540           type: string
37541           example: __VNF-ID__
37542         - name: interface-name
37543           in: path
37544           description: Name given to the interface
37545           required: true
37546           type: string
37547           example: __INTERFACE-NAME__
37548         - name: l3-interface-ipv6-address
37549           in: path
37550           description: IP address
37551           required: true
37552           type: string
37553           example: __L3-INTERFACE-IPV6-ADDRESS__
37554         - name: body
37555           in: body
37556           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37557           required: true
37558           schema:
37559             $ref: "#/definitions/relationship"
37560     delete:
37561       tags:
37562         - Network
37563       summary: delete an existing relationship
37564       description: delete an existing relationship
37565       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37566       consumes:
37567         - application/json
37568         - application/xml
37569       produces:
37570         - application/json
37571         - application/xml
37572       responses:
37573         "default":
37574           description: Response codes found in [response codes](https://wiki.onap.org/).
37575       parameters:
37576         - name: vnf-id
37577           in: path
37578           description: Unique id of VNF.  This is unique across the graph.
37579           required: true
37580           type: string
37581           example: __VNF-ID__
37582         - name: interface-name
37583           in: path
37584           description: Name given to the interface
37585           required: true
37586           type: string
37587           example: __INTERFACE-NAME__
37588         - name: l3-interface-ipv6-address
37589           in: path
37590           description: IP address
37591           required: true
37592           type: string
37593           example: __L3-INTERFACE-IPV6-ADDRESS__
37594   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37595     get:
37596       tags:
37597         - Network
37598       summary: returns l3-interface-ipv6-address-list
37599       description: returns l3-interface-ipv6-address-list
37600       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37601       produces:
37602         - application/json
37603         - application/xml
37604       responses:
37605         "200":
37606           description: successful operation
37607           schema:
37608               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37609         "default":
37610           description: Response codes found in [response codes](https://wiki.onap.org/).
37611       parameters:
37612         - name: vnf-id
37613           in: path
37614           description: Unique id of VNF.  This is unique across the graph.
37615           required: true
37616           type: string
37617           example: __VNF-ID__
37618         - name: interface-name
37619           in: path
37620           description: Name given to the interface
37621           required: true
37622           type: string
37623           example: __INTERFACE-NAME__
37624         - name: l3-interface-ipv6-address
37625           in: path
37626           description: IP address
37627           required: true
37628           type: string
37629           example: __L3-INTERFACE-IPV6-ADDRESS__
37630         - name: vnf-name
37631           in: query
37632           description: Name of VNF.
37633           required: false
37634           type: string
37635         - name: vnf-name2
37636           in: query
37637           description: Alternate name of VNF.
37638           required: false
37639           type: string
37640         - name: vnf-type
37641           in: query
37642           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.
37643           required: false
37644           type: string
37645         - name: service-id
37646           in: query
37647           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37648           required: false
37649           type: string
37650         - name: regional-resource-zone
37651           in: query
37652           description: Regional way of organizing pservers, source of truth should define values
37653           required: false
37654           type: string
37655         - name: prov-status
37656           in: query
37657           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37658           required: false
37659           type: string
37660         - name: heat-stack-id
37661           in: query
37662           description: Heat stack id corresponding to this instance, managed by MSO
37663           required: false
37664           type: string
37665         - name: in-maint
37666           in: query
37667           required: false
37668           type: boolean
37669         - name: is-closed-loop-disabled
37670           in: query
37671           required: false
37672           type: boolean
37673         - name: model-invariant-id
37674           in: query
37675           description: the ASDC model id for this resource or service model.
37676           required: false
37677           type: string
37678         - name: model-version-id
37679           in: query
37680           description: the ASDC model version for this resource or service model.
37681           required: false
37682           type: string
37683         - name: widget-model-id
37684           in: query
37685           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37686           required: false
37687           type: string
37688         - name: widget-model-version
37689           in: query
37690           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37691           required: false
37692           type: string
37693         - name: nf-type
37694           in: query
37695           description: Generic description of the type of NF
37696           required: false
37697           type: string
37698         - name: nf-function
37699           in: query
37700           description: English description of Network function that the specific VNF deployment is providing
37701           required: false
37702           type: string
37703         - name: nf-role
37704           in: query
37705           description: role in the network that this model will be providing
37706           required: false
37707           type: string
37708         - name: nf-naming-code
37709           in: query
37710           description: string assigned to this model used for naming purposes
37711           required: false
37712           type: string
37713         - name: interface-id
37714           in: query
37715           description: ID of interface
37716           required: false
37717           type: string
37718         - name: macaddr
37719           in: query
37720           description: MAC address for the interface
37721           required: false
37722           type: string
37723         - name: network-name
37724           in: query
37725           description: Name of the network
37726           required: false
37727           type: string
37728         - name: vlan-id-inner
37729           in: query
37730           description: Inner VLAN tag
37731           required: false
37732           type: integer
37733           format: int64
37734         - name: neutron-network-id
37735           in: query
37736           description: Neutron network id of the interface that address belongs to
37737           required: false
37738           type: string
37739         - name: neutron-subnet-id
37740           in: query
37741           description: Neutron id of subnet that address belongs to
37742           required: false
37743           type: string
37744     put:
37745       tags:
37746         - Network
37747       summary: create or update an existing l3-interface-ipv6-address-list
37748       description: |
37749         Create or update an existing l3-interface-ipv6-address-list.
37750         #
37751         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37752       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37753       consumes:
37754         - application/json
37755         - application/xml
37756       produces:
37757         - application/json
37758         - application/xml
37759       responses:
37760         "default":
37761           description: Response codes found in [response codes](https://wiki.onap.org/).
37762       parameters:
37763         - name: vnf-id
37764           in: path
37765           description: Unique id of VNF.  This is unique across the graph.
37766           required: true
37767           type: string
37768           example: __VNF-ID__
37769         - name: interface-name
37770           in: path
37771           description: Name given to the interface
37772           required: true
37773           type: string
37774           example: __INTERFACE-NAME__
37775         - name: l3-interface-ipv6-address
37776           in: path
37777           description: IP address
37778           required: true
37779           type: string
37780           example: __L3-INTERFACE-IPV6-ADDRESS__
37781         - name: body
37782           in: body
37783           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37784           required: true
37785           schema:
37786             $ref: "#/definitions/l3-interface-ipv6-address-list"
37787     patch:
37788       tags:
37789         - Network
37790       summary: update an existing l3-interface-ipv6-address-list
37791       description: |
37792         Update an existing l3-interface-ipv6-address-list
37793         #
37794         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37795         The PUT operation will entirely replace an existing object.
37796         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37797         #
37798         Other differences between PUT and PATCH are:
37799         #
37800         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37801         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37802         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37803       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37804       consumes:
37805         - application/json
37806         - application/xml
37807       produces:
37808         - application/json
37809         - application/xml
37810       responses:
37811         "default":
37812           description: Response codes found in [response codes](https://wiki.onap.org/).
37813       parameters:
37814         - name: vnf-id
37815           in: path
37816           description: Unique id of VNF.  This is unique across the graph.
37817           required: true
37818           type: string
37819           example: __VNF-ID__
37820         - name: interface-name
37821           in: path
37822           description: Name given to the interface
37823           required: true
37824           type: string
37825           example: __INTERFACE-NAME__
37826         - name: l3-interface-ipv6-address
37827           in: path
37828           description: IP address
37829           required: true
37830           type: string
37831           example: __L3-INTERFACE-IPV6-ADDRESS__
37832         - name: body
37833           in: body
37834           description: l3-interface-ipv6-address-list object that needs to be created or updated.
37835           required: true
37836           schema:
37837             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37838     delete:
37839       tags:
37840         - Network
37841       summary: delete an existing l3-interface-ipv6-address-list
37842       description: delete an existing l3-interface-ipv6-address-list
37843       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37844       consumes:
37845         - application/json
37846         - application/xml
37847       produces:
37848         - application/json
37849         - application/xml
37850       responses:
37851         "default":
37852           description: Response codes found in [response codes](https://wiki.onap.org/).
37853       parameters:
37854         - name: vnf-id
37855           in: path
37856           description: Unique id of VNF.  This is unique across the graph.
37857           required: true
37858           type: string
37859           example: __VNF-ID__
37860         - name: interface-name
37861           in: path
37862           description: Name given to the interface
37863           required: true
37864           type: string
37865           example: __INTERFACE-NAME__
37866         - name: l3-interface-ipv6-address
37867           in: path
37868           description: IP address
37869           required: true
37870           type: string
37871           example: __L3-INTERFACE-IPV6-ADDRESS__
37872         - name: resource-version
37873           in: query
37874           description: resource-version for concurrency
37875           required: true
37876           type: string
37877   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
37878     get:
37879       tags:
37880         - Network
37881       summary: returns l-interface
37882       description: returns l-interface
37883       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
37884       produces:
37885         - application/json
37886         - application/xml
37887       responses:
37888         "200":
37889           description: successful operation
37890           schema:
37891               $ref: "#/getDefinitions/l-interface"
37892         "default":
37893           description: Response codes found in [response codes](https://wiki.onap.org/).
37894       parameters:
37895         - name: vnf-id
37896           in: path
37897           description: Unique id of VNF.  This is unique across the graph.
37898           required: true
37899           type: string
37900           example: __VNF-ID__
37901         - name: interface-name
37902           in: path
37903           description: Name given to the interface
37904           required: true
37905           type: string
37906           example: __INTERFACE-NAME__
37907         - name: vnf-name
37908           in: query
37909           description: Name of VNF.
37910           required: false
37911           type: string
37912         - name: vnf-name2
37913           in: query
37914           description: Alternate name of VNF.
37915           required: false
37916           type: string
37917         - name: vnf-type
37918           in: query
37919           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.
37920           required: false
37921           type: string
37922         - name: service-id
37923           in: query
37924           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37925           required: false
37926           type: string
37927         - name: regional-resource-zone
37928           in: query
37929           description: Regional way of organizing pservers, source of truth should define values
37930           required: false
37931           type: string
37932         - name: prov-status
37933           in: query
37934           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37935           required: false
37936           type: string
37937         - name: heat-stack-id
37938           in: query
37939           description: Heat stack id corresponding to this instance, managed by MSO
37940           required: false
37941           type: string
37942         - name: in-maint
37943           in: query
37944           required: false
37945           type: boolean
37946         - name: is-closed-loop-disabled
37947           in: query
37948           required: false
37949           type: boolean
37950         - name: model-invariant-id
37951           in: query
37952           description: the ASDC model id for this resource or service model.
37953           required: false
37954           type: string
37955         - name: model-version-id
37956           in: query
37957           description: the ASDC model version for this resource or service model.
37958           required: false
37959           type: string
37960         - name: widget-model-id
37961           in: query
37962           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37963           required: false
37964           type: string
37965         - name: widget-model-version
37966           in: query
37967           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37968           required: false
37969           type: string
37970         - name: nf-type
37971           in: query
37972           description: Generic description of the type of NF
37973           required: false
37974           type: string
37975         - name: nf-function
37976           in: query
37977           description: English description of Network function that the specific VNF deployment is providing
37978           required: false
37979           type: string
37980         - name: nf-role
37981           in: query
37982           description: role in the network that this model will be providing
37983           required: false
37984           type: string
37985         - name: nf-naming-code
37986           in: query
37987           description: string assigned to this model used for naming purposes
37988           required: false
37989           type: string
37990         - name: interface-id
37991           in: query
37992           description: ID of interface
37993           required: false
37994           type: string
37995         - name: macaddr
37996           in: query
37997           description: MAC address for the interface
37998           required: false
37999           type: string
38000         - name: network-name
38001           in: query
38002           description: Name of the network
38003           required: false
38004           type: string
38005     put:
38006       tags:
38007         - Network
38008       summary: create or update an existing l-interface
38009       description: |
38010         Create or update an existing l-interface.
38011         #
38012         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38013       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
38014       consumes:
38015         - application/json
38016         - application/xml
38017       produces:
38018         - application/json
38019         - application/xml
38020       responses:
38021         "default":
38022           description: Response codes found in [response codes](https://wiki.onap.org/).
38023       parameters:
38024         - name: vnf-id
38025           in: path
38026           description: Unique id of VNF.  This is unique across the graph.
38027           required: true
38028           type: string
38029           example: __VNF-ID__
38030         - name: interface-name
38031           in: path
38032           description: Name given to the interface
38033           required: true
38034           type: string
38035           example: __INTERFACE-NAME__
38036         - name: body
38037           in: body
38038           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
38039           required: true
38040           schema:
38041             $ref: "#/definitions/l-interface"
38042     patch:
38043       tags:
38044         - Network
38045       summary: update an existing l-interface
38046       description: |
38047         Update an existing l-interface
38048         #
38049         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38050         The PUT operation will entirely replace an existing object.
38051         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38052         #
38053         Other differences between PUT and PATCH are:
38054         #
38055         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38056         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38057         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38058       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
38059       consumes:
38060         - application/json
38061         - application/xml
38062       produces:
38063         - application/json
38064         - application/xml
38065       responses:
38066         "default":
38067           description: Response codes found in [response codes](https://wiki.onap.org/).
38068       parameters:
38069         - name: vnf-id
38070           in: path
38071           description: Unique id of VNF.  This is unique across the graph.
38072           required: true
38073           type: string
38074           example: __VNF-ID__
38075         - name: interface-name
38076           in: path
38077           description: Name given to the interface
38078           required: true
38079           type: string
38080           example: __INTERFACE-NAME__
38081         - name: body
38082           in: body
38083           description: l-interface object that needs to be created or updated.
38084           required: true
38085           schema:
38086             $ref: "#/patchDefinitions/l-interface"
38087     delete:
38088       tags:
38089         - Network
38090       summary: delete an existing l-interface
38091       description: delete an existing l-interface
38092       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
38093       consumes:
38094         - application/json
38095         - application/xml
38096       produces:
38097         - application/json
38098         - application/xml
38099       responses:
38100         "default":
38101           description: Response codes found in [response codes](https://wiki.onap.org/).
38102       parameters:
38103         - name: vnf-id
38104           in: path
38105           description: Unique id of VNF.  This is unique across the graph.
38106           required: true
38107           type: string
38108           example: __VNF-ID__
38109         - name: interface-name
38110           in: path
38111           description: Name given to the interface
38112           required: true
38113           type: string
38114           example: __INTERFACE-NAME__
38115         - name: resource-version
38116           in: query
38117           description: resource-version for concurrency
38118           required: true
38119           type: string
38120   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
38121     get:
38122       tags:
38123         - Network
38124       summary: returns l-interfaces
38125       description: returns l-interfaces
38126       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
38127       produces:
38128         - application/json
38129         - application/xml
38130       responses:
38131         "200":
38132           description: successful operation
38133           schema:
38134               $ref: "#/getDefinitions/l-interfaces"
38135         "default":
38136           description: Response codes found in [response codes](https://wiki.onap.org/).
38137       parameters:
38138         - name: vnf-id
38139           in: path
38140           description: Unique id of VNF.  This is unique across the graph.
38141           required: true
38142           type: string
38143           example: __VNF-ID__
38144         - name: vnf-name
38145           in: query
38146           description: Name of VNF.
38147           required: false
38148           type: string
38149         - name: vnf-name2
38150           in: query
38151           description: Alternate name of VNF.
38152           required: false
38153           type: string
38154         - name: vnf-type
38155           in: query
38156           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.
38157           required: false
38158           type: string
38159         - name: service-id
38160           in: query
38161           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38162           required: false
38163           type: string
38164         - name: regional-resource-zone
38165           in: query
38166           description: Regional way of organizing pservers, source of truth should define values
38167           required: false
38168           type: string
38169         - name: prov-status
38170           in: query
38171           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38172           required: false
38173           type: string
38174         - name: heat-stack-id
38175           in: query
38176           description: Heat stack id corresponding to this instance, managed by MSO
38177           required: false
38178           type: string
38179         - name: in-maint
38180           in: query
38181           required: false
38182           type: boolean
38183         - name: is-closed-loop-disabled
38184           in: query
38185           required: false
38186           type: boolean
38187         - name: model-invariant-id
38188           in: query
38189           description: the ASDC model id for this resource or service model.
38190           required: false
38191           type: string
38192         - name: model-version-id
38193           in: query
38194           description: the ASDC model version for this resource or service model.
38195           required: false
38196           type: string
38197         - name: widget-model-id
38198           in: query
38199           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38200           required: false
38201           type: string
38202         - name: widget-model-version
38203           in: query
38204           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38205           required: false
38206           type: string
38207         - name: nf-type
38208           in: query
38209           description: Generic description of the type of NF
38210           required: false
38211           type: string
38212         - name: nf-function
38213           in: query
38214           description: English description of Network function that the specific VNF deployment is providing
38215           required: false
38216           type: string
38217         - name: nf-role
38218           in: query
38219           description: role in the network that this model will be providing
38220           required: false
38221           type: string
38222         - name: nf-naming-code
38223           in: query
38224           description: string assigned to this model used for naming purposes
38225           required: false
38226           type: string
38227   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
38228     put:
38229       tags:
38230         - Network
38231       summary: see node definition for valid relationships
38232       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
38233       consumes:
38234         - application/json
38235         - application/xml
38236       produces:
38237         - application/json
38238         - application/xml
38239       responses:
38240         "default":
38241           description: Response codes found in [response codes](https://wiki.onap.org/).
38242       parameters:
38243         - name: vnf-id
38244           in: path
38245           description: Unique id of VNF.  This is unique across the graph.
38246           required: true
38247           type: string
38248           example: __VNF-ID__
38249         - name: interface-name
38250           in: path
38251           description: Name that identifies the link aggregate interface
38252           required: true
38253           type: string
38254           example: __INTERFACE-NAME__
38255         - name: body
38256           in: body
38257           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
38258           required: true
38259           schema:
38260             $ref: "#/definitions/relationship"
38261     delete:
38262       tags:
38263         - Network
38264       summary: delete an existing relationship
38265       description: delete an existing relationship
38266       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
38267       consumes:
38268         - application/json
38269         - application/xml
38270       produces:
38271         - application/json
38272         - application/xml
38273       responses:
38274         "default":
38275           description: Response codes found in [response codes](https://wiki.onap.org/).
38276       parameters:
38277         - name: vnf-id
38278           in: path
38279           description: Unique id of VNF.  This is unique across the graph.
38280           required: true
38281           type: string
38282           example: __VNF-ID__
38283         - name: interface-name
38284           in: path
38285           description: Name that identifies the link aggregate interface
38286           required: true
38287           type: string
38288           example: __INTERFACE-NAME__
38289   /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:
38290     put:
38291       tags:
38292         - Network
38293       summary: see node definition for valid relationships
38294       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38295       consumes:
38296         - application/json
38297         - application/xml
38298       produces:
38299         - application/json
38300         - application/xml
38301       responses:
38302         "default":
38303           description: Response codes found in [response codes](https://wiki.onap.org/).
38304       parameters:
38305         - name: vnf-id
38306           in: path
38307           description: Unique id of VNF.  This is unique across the graph.
38308           required: true
38309           type: string
38310           example: __VNF-ID__
38311         - name: interface-name
38312           in: path
38313           description: Name that identifies the link aggregate interface
38314           required: true
38315           type: string
38316           example: __INTERFACE-NAME__
38317         - name: interface-name
38318           in: path
38319           description: Name given to the interface
38320           required: true
38321           type: string
38322           example: __INTERFACE-NAME__
38323         - name: vlan-interface
38324           in: path
38325           description: String that identifies the interface
38326           required: true
38327           type: string
38328           example: __VLAN-INTERFACE__
38329         - name: body
38330           in: body
38331           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38332           required: true
38333           schema:
38334             $ref: "#/definitions/relationship"
38335     delete:
38336       tags:
38337         - Network
38338       summary: delete an existing relationship
38339       description: delete an existing relationship
38340       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38341       consumes:
38342         - application/json
38343         - application/xml
38344       produces:
38345         - application/json
38346         - application/xml
38347       responses:
38348         "default":
38349           description: Response codes found in [response codes](https://wiki.onap.org/).
38350       parameters:
38351         - name: vnf-id
38352           in: path
38353           description: Unique id of VNF.  This is unique across the graph.
38354           required: true
38355           type: string
38356           example: __VNF-ID__
38357         - name: interface-name
38358           in: path
38359           description: Name that identifies the link aggregate interface
38360           required: true
38361           type: string
38362           example: __INTERFACE-NAME__
38363         - name: interface-name
38364           in: path
38365           description: Name given to the interface
38366           required: true
38367           type: string
38368           example: __INTERFACE-NAME__
38369         - name: vlan-interface
38370           in: path
38371           description: String that identifies the interface
38372           required: true
38373           type: string
38374           example: __VLAN-INTERFACE__
38375   /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:
38376     put:
38377       tags:
38378         - Network
38379       summary: see node definition for valid relationships
38380       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38381       consumes:
38382         - application/json
38383         - application/xml
38384       produces:
38385         - application/json
38386         - application/xml
38387       responses:
38388         "default":
38389           description: Response codes found in [response codes](https://wiki.onap.org/).
38390       parameters:
38391         - name: vnf-id
38392           in: path
38393           description: Unique id of VNF.  This is unique across the graph.
38394           required: true
38395           type: string
38396           example: __VNF-ID__
38397         - name: interface-name
38398           in: path
38399           description: Name that identifies the link aggregate interface
38400           required: true
38401           type: string
38402           example: __INTERFACE-NAME__
38403         - name: interface-name
38404           in: path
38405           description: Name given to the interface
38406           required: true
38407           type: string
38408           example: __INTERFACE-NAME__
38409         - name: vlan-interface
38410           in: path
38411           description: String that identifies the interface
38412           required: true
38413           type: string
38414           example: __VLAN-INTERFACE__
38415         - name: l3-interface-ipv4-address
38416           in: path
38417           description: IP address
38418           required: true
38419           type: string
38420           example: __L3-INTERFACE-IPV4-ADDRESS__
38421         - name: body
38422           in: body
38423           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38424           required: true
38425           schema:
38426             $ref: "#/definitions/relationship"
38427     delete:
38428       tags:
38429         - Network
38430       summary: delete an existing relationship
38431       description: delete an existing relationship
38432       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38433       consumes:
38434         - application/json
38435         - application/xml
38436       produces:
38437         - application/json
38438         - application/xml
38439       responses:
38440         "default":
38441           description: Response codes found in [response codes](https://wiki.onap.org/).
38442       parameters:
38443         - name: vnf-id
38444           in: path
38445           description: Unique id of VNF.  This is unique across the graph.
38446           required: true
38447           type: string
38448           example: __VNF-ID__
38449         - name: interface-name
38450           in: path
38451           description: Name that identifies the link aggregate interface
38452           required: true
38453           type: string
38454           example: __INTERFACE-NAME__
38455         - name: interface-name
38456           in: path
38457           description: Name given to the interface
38458           required: true
38459           type: string
38460           example: __INTERFACE-NAME__
38461         - name: vlan-interface
38462           in: path
38463           description: String that identifies the interface
38464           required: true
38465           type: string
38466           example: __VLAN-INTERFACE__
38467         - name: l3-interface-ipv4-address
38468           in: path
38469           description: IP address
38470           required: true
38471           type: string
38472           example: __L3-INTERFACE-IPV4-ADDRESS__
38473   /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}:
38474     get:
38475       tags:
38476         - Network
38477       summary: returns l3-interface-ipv4-address-list
38478       description: returns l3-interface-ipv4-address-list
38479       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38480       produces:
38481         - application/json
38482         - application/xml
38483       responses:
38484         "200":
38485           description: successful operation
38486           schema:
38487               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38488         "default":
38489           description: Response codes found in [response codes](https://wiki.onap.org/).
38490       parameters:
38491         - name: vnf-id
38492           in: path
38493           description: Unique id of VNF.  This is unique across the graph.
38494           required: true
38495           type: string
38496           example: __VNF-ID__
38497         - name: interface-name
38498           in: path
38499           description: Name that identifies the link aggregate interface
38500           required: true
38501           type: string
38502           example: __INTERFACE-NAME__
38503         - name: interface-name
38504           in: path
38505           description: Name given to the interface
38506           required: true
38507           type: string
38508           example: __INTERFACE-NAME__
38509         - name: vlan-interface
38510           in: path
38511           description: String that identifies the interface
38512           required: true
38513           type: string
38514           example: __VLAN-INTERFACE__
38515         - name: l3-interface-ipv4-address
38516           in: path
38517           description: IP address
38518           required: true
38519           type: string
38520           example: __L3-INTERFACE-IPV4-ADDRESS__
38521         - name: vnf-name
38522           in: query
38523           description: Name of VNF.
38524           required: false
38525           type: string
38526         - name: vnf-name2
38527           in: query
38528           description: Alternate name of VNF.
38529           required: false
38530           type: string
38531         - name: vnf-type
38532           in: query
38533           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.
38534           required: false
38535           type: string
38536         - name: service-id
38537           in: query
38538           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38539           required: false
38540           type: string
38541         - name: regional-resource-zone
38542           in: query
38543           description: Regional way of organizing pservers, source of truth should define values
38544           required: false
38545           type: string
38546         - name: prov-status
38547           in: query
38548           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38549           required: false
38550           type: string
38551         - name: heat-stack-id
38552           in: query
38553           description: Heat stack id corresponding to this instance, managed by MSO
38554           required: false
38555           type: string
38556         - name: in-maint
38557           in: query
38558           required: false
38559           type: boolean
38560         - name: is-closed-loop-disabled
38561           in: query
38562           required: false
38563           type: boolean
38564         - name: model-invariant-id
38565           in: query
38566           description: the ASDC model id for this resource or service model.
38567           required: false
38568           type: string
38569         - name: model-version-id
38570           in: query
38571           description: the ASDC model version for this resource or service model.
38572           required: false
38573           type: string
38574         - name: widget-model-id
38575           in: query
38576           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38577           required: false
38578           type: string
38579         - name: widget-model-version
38580           in: query
38581           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38582           required: false
38583           type: string
38584         - name: nf-type
38585           in: query
38586           description: Generic description of the type of NF
38587           required: false
38588           type: string
38589         - name: nf-function
38590           in: query
38591           description: English description of Network function that the specific VNF deployment is providing
38592           required: false
38593           type: string
38594         - name: nf-role
38595           in: query
38596           description: role in the network that this model will be providing
38597           required: false
38598           type: string
38599         - name: nf-naming-code
38600           in: query
38601           description: string assigned to this model used for naming purposes
38602           required: false
38603           type: string
38604         - name: interface-id
38605           in: query
38606           description: ID of interface
38607           required: false
38608           type: string
38609         - name: interface-role
38610           in: query
38611           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38612           required: false
38613           type: string
38614         - name: interface-id
38615           in: query
38616           description: ID of interface
38617           required: false
38618           type: string
38619         - name: macaddr
38620           in: query
38621           description: MAC address for the interface
38622           required: false
38623           type: string
38624         - name: network-name
38625           in: query
38626           description: Name of the network
38627           required: false
38628           type: string
38629         - name: vlan-id-inner
38630           in: query
38631           description: Inner VLAN tag
38632           required: false
38633           type: integer
38634           format: int64
38635         - name: vpn-key
38636           in: query
38637           description: This indicates the customers VPN ID associated with this vlan
38638           required: false
38639           type: string
38640         - name: vlan-id-inner
38641           in: query
38642           description: Inner VLAN tag
38643           required: false
38644           type: integer
38645           format: int64
38646         - name: neutron-network-id
38647           in: query
38648           description: Neutron network id of the interface that address belongs to
38649           required: false
38650           type: string
38651         - name: neutron-subnet-id
38652           in: query
38653           description: Neutron id of subnet that address belongs to
38654           required: false
38655           type: string
38656     put:
38657       tags:
38658         - Network
38659       summary: create or update an existing l3-interface-ipv4-address-list
38660       description: |
38661         Create or update an existing l3-interface-ipv4-address-list.
38662         #
38663         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38664       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38665       consumes:
38666         - application/json
38667         - application/xml
38668       produces:
38669         - application/json
38670         - application/xml
38671       responses:
38672         "default":
38673           description: Response codes found in [response codes](https://wiki.onap.org/).
38674       parameters:
38675         - name: vnf-id
38676           in: path
38677           description: Unique id of VNF.  This is unique across the graph.
38678           required: true
38679           type: string
38680           example: __VNF-ID__
38681         - name: interface-name
38682           in: path
38683           description: Name that identifies the link aggregate interface
38684           required: true
38685           type: string
38686           example: __INTERFACE-NAME__
38687         - name: interface-name
38688           in: path
38689           description: Name given to the interface
38690           required: true
38691           type: string
38692           example: __INTERFACE-NAME__
38693         - name: vlan-interface
38694           in: path
38695           description: String that identifies the interface
38696           required: true
38697           type: string
38698           example: __VLAN-INTERFACE__
38699         - name: l3-interface-ipv4-address
38700           in: path
38701           description: IP address
38702           required: true
38703           type: string
38704           example: __L3-INTERFACE-IPV4-ADDRESS__
38705         - name: body
38706           in: body
38707           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38708           required: true
38709           schema:
38710             $ref: "#/definitions/l3-interface-ipv4-address-list"
38711     patch:
38712       tags:
38713         - Network
38714       summary: update an existing l3-interface-ipv4-address-list
38715       description: |
38716         Update an existing l3-interface-ipv4-address-list
38717         #
38718         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38719         The PUT operation will entirely replace an existing object.
38720         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38721         #
38722         Other differences between PUT and PATCH are:
38723         #
38724         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38725         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38726         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38727       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38728       consumes:
38729         - application/json
38730         - application/xml
38731       produces:
38732         - application/json
38733         - application/xml
38734       responses:
38735         "default":
38736           description: Response codes found in [response codes](https://wiki.onap.org/).
38737       parameters:
38738         - name: vnf-id
38739           in: path
38740           description: Unique id of VNF.  This is unique across the graph.
38741           required: true
38742           type: string
38743           example: __VNF-ID__
38744         - name: interface-name
38745           in: path
38746           description: Name that identifies the link aggregate interface
38747           required: true
38748           type: string
38749           example: __INTERFACE-NAME__
38750         - name: interface-name
38751           in: path
38752           description: Name given to the interface
38753           required: true
38754           type: string
38755           example: __INTERFACE-NAME__
38756         - name: vlan-interface
38757           in: path
38758           description: String that identifies the interface
38759           required: true
38760           type: string
38761           example: __VLAN-INTERFACE__
38762         - name: l3-interface-ipv4-address
38763           in: path
38764           description: IP address
38765           required: true
38766           type: string
38767           example: __L3-INTERFACE-IPV4-ADDRESS__
38768         - name: body
38769           in: body
38770           description: l3-interface-ipv4-address-list object that needs to be created or updated.
38771           required: true
38772           schema:
38773             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38774     delete:
38775       tags:
38776         - Network
38777       summary: delete an existing l3-interface-ipv4-address-list
38778       description: delete an existing l3-interface-ipv4-address-list
38779       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38780       consumes:
38781         - application/json
38782         - application/xml
38783       produces:
38784         - application/json
38785         - application/xml
38786       responses:
38787         "default":
38788           description: Response codes found in [response codes](https://wiki.onap.org/).
38789       parameters:
38790         - name: vnf-id
38791           in: path
38792           description: Unique id of VNF.  This is unique across the graph.
38793           required: true
38794           type: string
38795           example: __VNF-ID__
38796         - name: interface-name
38797           in: path
38798           description: Name that identifies the link aggregate interface
38799           required: true
38800           type: string
38801           example: __INTERFACE-NAME__
38802         - name: interface-name
38803           in: path
38804           description: Name given to the interface
38805           required: true
38806           type: string
38807           example: __INTERFACE-NAME__
38808         - name: vlan-interface
38809           in: path
38810           description: String that identifies the interface
38811           required: true
38812           type: string
38813           example: __VLAN-INTERFACE__
38814         - name: l3-interface-ipv4-address
38815           in: path
38816           description: IP address
38817           required: true
38818           type: string
38819           example: __L3-INTERFACE-IPV4-ADDRESS__
38820         - name: resource-version
38821           in: query
38822           description: resource-version for concurrency
38823           required: true
38824           type: string
38825   /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:
38826     put:
38827       tags:
38828         - Network
38829       summary: see node definition for valid relationships
38830       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38831       consumes:
38832         - application/json
38833         - application/xml
38834       produces:
38835         - application/json
38836         - application/xml
38837       responses:
38838         "default":
38839           description: Response codes found in [response codes](https://wiki.onap.org/).
38840       parameters:
38841         - name: vnf-id
38842           in: path
38843           description: Unique id of VNF.  This is unique across the graph.
38844           required: true
38845           type: string
38846           example: __VNF-ID__
38847         - name: interface-name
38848           in: path
38849           description: Name that identifies the link aggregate interface
38850           required: true
38851           type: string
38852           example: __INTERFACE-NAME__
38853         - name: interface-name
38854           in: path
38855           description: Name given to the interface
38856           required: true
38857           type: string
38858           example: __INTERFACE-NAME__
38859         - name: vlan-interface
38860           in: path
38861           description: String that identifies the interface
38862           required: true
38863           type: string
38864           example: __VLAN-INTERFACE__
38865         - name: l3-interface-ipv6-address
38866           in: path
38867           description: IP address
38868           required: true
38869           type: string
38870           example: __L3-INTERFACE-IPV6-ADDRESS__
38871         - name: body
38872           in: body
38873           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38874           required: true
38875           schema:
38876             $ref: "#/definitions/relationship"
38877     delete:
38878       tags:
38879         - Network
38880       summary: delete an existing relationship
38881       description: delete an existing relationship
38882       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38883       consumes:
38884         - application/json
38885         - application/xml
38886       produces:
38887         - application/json
38888         - application/xml
38889       responses:
38890         "default":
38891           description: Response codes found in [response codes](https://wiki.onap.org/).
38892       parameters:
38893         - name: vnf-id
38894           in: path
38895           description: Unique id of VNF.  This is unique across the graph.
38896           required: true
38897           type: string
38898           example: __VNF-ID__
38899         - name: interface-name
38900           in: path
38901           description: Name that identifies the link aggregate interface
38902           required: true
38903           type: string
38904           example: __INTERFACE-NAME__
38905         - name: interface-name
38906           in: path
38907           description: Name given to the interface
38908           required: true
38909           type: string
38910           example: __INTERFACE-NAME__
38911         - name: vlan-interface
38912           in: path
38913           description: String that identifies the interface
38914           required: true
38915           type: string
38916           example: __VLAN-INTERFACE__
38917         - name: l3-interface-ipv6-address
38918           in: path
38919           description: IP address
38920           required: true
38921           type: string
38922           example: __L3-INTERFACE-IPV6-ADDRESS__
38923   /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}:
38924     get:
38925       tags:
38926         - Network
38927       summary: returns l3-interface-ipv6-address-list
38928       description: returns l3-interface-ipv6-address-list
38929       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38930       produces:
38931         - application/json
38932         - application/xml
38933       responses:
38934         "200":
38935           description: successful operation
38936           schema:
38937               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38938         "default":
38939           description: Response codes found in [response codes](https://wiki.onap.org/).
38940       parameters:
38941         - name: vnf-id
38942           in: path
38943           description: Unique id of VNF.  This is unique across the graph.
38944           required: true
38945           type: string
38946           example: __VNF-ID__
38947         - name: interface-name
38948           in: path
38949           description: Name that identifies the link aggregate interface
38950           required: true
38951           type: string
38952           example: __INTERFACE-NAME__
38953         - name: interface-name
38954           in: path
38955           description: Name given to the interface
38956           required: true
38957           type: string
38958           example: __INTERFACE-NAME__
38959         - name: vlan-interface
38960           in: path
38961           description: String that identifies the interface
38962           required: true
38963           type: string
38964           example: __VLAN-INTERFACE__
38965         - name: l3-interface-ipv6-address
38966           in: path
38967           description: IP address
38968           required: true
38969           type: string
38970           example: __L3-INTERFACE-IPV6-ADDRESS__
38971         - name: vnf-name
38972           in: query
38973           description: Name of VNF.
38974           required: false
38975           type: string
38976         - name: vnf-name2
38977           in: query
38978           description: Alternate name of VNF.
38979           required: false
38980           type: string
38981         - name: vnf-type
38982           in: query
38983           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.
38984           required: false
38985           type: string
38986         - name: service-id
38987           in: query
38988           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38989           required: false
38990           type: string
38991         - name: regional-resource-zone
38992           in: query
38993           description: Regional way of organizing pservers, source of truth should define values
38994           required: false
38995           type: string
38996         - name: prov-status
38997           in: query
38998           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38999           required: false
39000           type: string
39001         - name: heat-stack-id
39002           in: query
39003           description: Heat stack id corresponding to this instance, managed by MSO
39004           required: false
39005           type: string
39006         - name: in-maint
39007           in: query
39008           required: false
39009           type: boolean
39010         - name: is-closed-loop-disabled
39011           in: query
39012           required: false
39013           type: boolean
39014         - name: model-invariant-id
39015           in: query
39016           description: the ASDC model id for this resource or service model.
39017           required: false
39018           type: string
39019         - name: model-version-id
39020           in: query
39021           description: the ASDC model version for this resource or service model.
39022           required: false
39023           type: string
39024         - name: widget-model-id
39025           in: query
39026           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39027           required: false
39028           type: string
39029         - name: widget-model-version
39030           in: query
39031           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39032           required: false
39033           type: string
39034         - name: nf-type
39035           in: query
39036           description: Generic description of the type of NF
39037           required: false
39038           type: string
39039         - name: nf-function
39040           in: query
39041           description: English description of Network function that the specific VNF deployment is providing
39042           required: false
39043           type: string
39044         - name: nf-role
39045           in: query
39046           description: role in the network that this model will be providing
39047           required: false
39048           type: string
39049         - name: nf-naming-code
39050           in: query
39051           description: string assigned to this model used for naming purposes
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: interface-role
39060           in: query
39061           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39062           required: false
39063           type: string
39064         - name: interface-id
39065           in: query
39066           description: ID of interface
39067           required: false
39068           type: string
39069         - name: macaddr
39070           in: query
39071           description: MAC address for the interface
39072           required: false
39073           type: string
39074         - name: network-name
39075           in: query
39076           description: Name of the network
39077           required: false
39078           type: string
39079         - name: vlan-id-inner
39080           in: query
39081           description: Inner VLAN tag
39082           required: false
39083           type: integer
39084           format: int64
39085         - name: vpn-key
39086           in: query
39087           description: This indicates the customers VPN ID associated with this vlan
39088           required: false
39089           type: string
39090         - name: vlan-id-inner
39091           in: query
39092           description: Inner VLAN tag
39093           required: false
39094           type: integer
39095           format: int64
39096         - name: neutron-network-id
39097           in: query
39098           description: Neutron network id of the interface that address belongs to
39099           required: false
39100           type: string
39101         - name: neutron-subnet-id
39102           in: query
39103           description: Neutron id of subnet that address belongs to
39104           required: false
39105           type: string
39106     put:
39107       tags:
39108         - Network
39109       summary: create or update an existing l3-interface-ipv6-address-list
39110       description: |
39111         Create or update an existing l3-interface-ipv6-address-list.
39112         #
39113         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39114       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39115       consumes:
39116         - application/json
39117         - application/xml
39118       produces:
39119         - application/json
39120         - application/xml
39121       responses:
39122         "default":
39123           description: Response codes found in [response codes](https://wiki.onap.org/).
39124       parameters:
39125         - name: vnf-id
39126           in: path
39127           description: Unique id of VNF.  This is unique across the graph.
39128           required: true
39129           type: string
39130           example: __VNF-ID__
39131         - name: interface-name
39132           in: path
39133           description: Name that identifies the link aggregate interface
39134           required: true
39135           type: string
39136           example: __INTERFACE-NAME__
39137         - name: interface-name
39138           in: path
39139           description: Name given to the interface
39140           required: true
39141           type: string
39142           example: __INTERFACE-NAME__
39143         - name: vlan-interface
39144           in: path
39145           description: String that identifies the interface
39146           required: true
39147           type: string
39148           example: __VLAN-INTERFACE__
39149         - name: l3-interface-ipv6-address
39150           in: path
39151           description: IP address
39152           required: true
39153           type: string
39154           example: __L3-INTERFACE-IPV6-ADDRESS__
39155         - name: body
39156           in: body
39157           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39158           required: true
39159           schema:
39160             $ref: "#/definitions/l3-interface-ipv6-address-list"
39161     patch:
39162       tags:
39163         - Network
39164       summary: update an existing l3-interface-ipv6-address-list
39165       description: |
39166         Update an existing l3-interface-ipv6-address-list
39167         #
39168         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39169         The PUT operation will entirely replace an existing object.
39170         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39171         #
39172         Other differences between PUT and PATCH are:
39173         #
39174         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39175         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39176         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39177       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39178       consumes:
39179         - application/json
39180         - application/xml
39181       produces:
39182         - application/json
39183         - application/xml
39184       responses:
39185         "default":
39186           description: Response codes found in [response codes](https://wiki.onap.org/).
39187       parameters:
39188         - name: vnf-id
39189           in: path
39190           description: Unique id of VNF.  This is unique across the graph.
39191           required: true
39192           type: string
39193           example: __VNF-ID__
39194         - name: interface-name
39195           in: path
39196           description: Name that identifies the link aggregate interface
39197           required: true
39198           type: string
39199           example: __INTERFACE-NAME__
39200         - name: interface-name
39201           in: path
39202           description: Name given to the interface
39203           required: true
39204           type: string
39205           example: __INTERFACE-NAME__
39206         - name: vlan-interface
39207           in: path
39208           description: String that identifies the interface
39209           required: true
39210           type: string
39211           example: __VLAN-INTERFACE__
39212         - name: l3-interface-ipv6-address
39213           in: path
39214           description: IP address
39215           required: true
39216           type: string
39217           example: __L3-INTERFACE-IPV6-ADDRESS__
39218         - name: body
39219           in: body
39220           description: l3-interface-ipv6-address-list object that needs to be created or updated.
39221           required: true
39222           schema:
39223             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39224     delete:
39225       tags:
39226         - Network
39227       summary: delete an existing l3-interface-ipv6-address-list
39228       description: delete an existing l3-interface-ipv6-address-list
39229       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39230       consumes:
39231         - application/json
39232         - application/xml
39233       produces:
39234         - application/json
39235         - application/xml
39236       responses:
39237         "default":
39238           description: Response codes found in [response codes](https://wiki.onap.org/).
39239       parameters:
39240         - name: vnf-id
39241           in: path
39242           description: Unique id of VNF.  This is unique across the graph.
39243           required: true
39244           type: string
39245           example: __VNF-ID__
39246         - name: interface-name
39247           in: path
39248           description: Name that identifies the link aggregate interface
39249           required: true
39250           type: string
39251           example: __INTERFACE-NAME__
39252         - name: interface-name
39253           in: path
39254           description: Name given to the interface
39255           required: true
39256           type: string
39257           example: __INTERFACE-NAME__
39258         - name: vlan-interface
39259           in: path
39260           description: String that identifies the interface
39261           required: true
39262           type: string
39263           example: __VLAN-INTERFACE__
39264         - name: l3-interface-ipv6-address
39265           in: path
39266           description: IP address
39267           required: true
39268           type: string
39269           example: __L3-INTERFACE-IPV6-ADDRESS__
39270         - name: resource-version
39271           in: query
39272           description: resource-version for concurrency
39273           required: true
39274           type: string
39275   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
39276     get:
39277       tags:
39278         - Network
39279       summary: returns vlan
39280       description: returns vlan
39281       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39282       produces:
39283         - application/json
39284         - application/xml
39285       responses:
39286         "200":
39287           description: successful operation
39288           schema:
39289               $ref: "#/getDefinitions/vlan"
39290         "default":
39291           description: Response codes found in [response codes](https://wiki.onap.org/).
39292       parameters:
39293         - name: vnf-id
39294           in: path
39295           description: Unique id of VNF.  This is unique across the graph.
39296           required: true
39297           type: string
39298           example: __VNF-ID__
39299         - name: interface-name
39300           in: path
39301           description: Name that identifies the link aggregate interface
39302           required: true
39303           type: string
39304           example: __INTERFACE-NAME__
39305         - name: interface-name
39306           in: path
39307           description: Name given to the interface
39308           required: true
39309           type: string
39310           example: __INTERFACE-NAME__
39311         - name: vlan-interface
39312           in: path
39313           description: String that identifies the interface
39314           required: true
39315           type: string
39316           example: __VLAN-INTERFACE__
39317         - name: vnf-name
39318           in: query
39319           description: Name of VNF.
39320           required: false
39321           type: string
39322         - name: vnf-name2
39323           in: query
39324           description: Alternate name of VNF.
39325           required: false
39326           type: string
39327         - name: vnf-type
39328           in: query
39329           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.
39330           required: false
39331           type: string
39332         - name: service-id
39333           in: query
39334           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39335           required: false
39336           type: string
39337         - name: regional-resource-zone
39338           in: query
39339           description: Regional way of organizing pservers, source of truth should define values
39340           required: false
39341           type: string
39342         - name: prov-status
39343           in: query
39344           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39345           required: false
39346           type: string
39347         - name: heat-stack-id
39348           in: query
39349           description: Heat stack id corresponding to this instance, managed by MSO
39350           required: false
39351           type: string
39352         - name: in-maint
39353           in: query
39354           required: false
39355           type: boolean
39356         - name: is-closed-loop-disabled
39357           in: query
39358           required: false
39359           type: boolean
39360         - name: model-invariant-id
39361           in: query
39362           description: the ASDC model id for this resource or service model.
39363           required: false
39364           type: string
39365         - name: model-version-id
39366           in: query
39367           description: the ASDC model version for this resource or service model.
39368           required: false
39369           type: string
39370         - name: widget-model-id
39371           in: query
39372           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39373           required: false
39374           type: string
39375         - name: widget-model-version
39376           in: query
39377           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39378           required: false
39379           type: string
39380         - name: nf-type
39381           in: query
39382           description: Generic description of the type of NF
39383           required: false
39384           type: string
39385         - name: nf-function
39386           in: query
39387           description: English description of Network function that the specific VNF deployment is providing
39388           required: false
39389           type: string
39390         - name: nf-role
39391           in: query
39392           description: role in the network that this model will be providing
39393           required: false
39394           type: string
39395         - name: nf-naming-code
39396           in: query
39397           description: string assigned to this model used for naming purposes
39398           required: false
39399           type: string
39400         - name: interface-id
39401           in: query
39402           description: ID of interface
39403           required: false
39404           type: string
39405         - name: interface-role
39406           in: query
39407           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39408           required: false
39409           type: string
39410         - name: interface-id
39411           in: query
39412           description: ID of interface
39413           required: false
39414           type: string
39415         - name: macaddr
39416           in: query
39417           description: MAC address for the interface
39418           required: false
39419           type: string
39420         - name: network-name
39421           in: query
39422           description: Name of the network
39423           required: false
39424           type: string
39425         - name: vlan-id-inner
39426           in: query
39427           description: Inner VLAN tag
39428           required: false
39429           type: integer
39430           format: int64
39431         - name: vpn-key
39432           in: query
39433           description: This indicates the customers VPN ID associated with this vlan
39434           required: false
39435           type: string
39436     put:
39437       tags:
39438         - Network
39439       summary: create or update an existing vlan
39440       description: |
39441         Create or update an existing vlan.
39442         #
39443         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39444       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39445       consumes:
39446         - application/json
39447         - application/xml
39448       produces:
39449         - application/json
39450         - application/xml
39451       responses:
39452         "default":
39453           description: Response codes found in [response codes](https://wiki.onap.org/).
39454       parameters:
39455         - name: vnf-id
39456           in: path
39457           description: Unique id of VNF.  This is unique across the graph.
39458           required: true
39459           type: string
39460           example: __VNF-ID__
39461         - name: interface-name
39462           in: path
39463           description: Name that identifies the link aggregate interface
39464           required: true
39465           type: string
39466           example: __INTERFACE-NAME__
39467         - name: interface-name
39468           in: path
39469           description: Name given to the interface
39470           required: true
39471           type: string
39472           example: __INTERFACE-NAME__
39473         - name: vlan-interface
39474           in: path
39475           description: String that identifies the interface
39476           required: true
39477           type: string
39478           example: __VLAN-INTERFACE__
39479         - name: body
39480           in: body
39481           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
39482           required: true
39483           schema:
39484             $ref: "#/definitions/vlan"
39485     patch:
39486       tags:
39487         - Network
39488       summary: update an existing vlan
39489       description: |
39490         Update an existing vlan
39491         #
39492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39493         The PUT operation will entirely replace an existing object.
39494         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39495         #
39496         Other differences between PUT and PATCH are:
39497         #
39498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39501       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39502       consumes:
39503         - application/json
39504         - application/xml
39505       produces:
39506         - application/json
39507         - application/xml
39508       responses:
39509         "default":
39510           description: Response codes found in [response codes](https://wiki.onap.org/).
39511       parameters:
39512         - name: vnf-id
39513           in: path
39514           description: Unique id of VNF.  This is unique across the graph.
39515           required: true
39516           type: string
39517           example: __VNF-ID__
39518         - name: interface-name
39519           in: path
39520           description: Name that identifies the link aggregate interface
39521           required: true
39522           type: string
39523           example: __INTERFACE-NAME__
39524         - name: interface-name
39525           in: path
39526           description: Name given to the interface
39527           required: true
39528           type: string
39529           example: __INTERFACE-NAME__
39530         - name: vlan-interface
39531           in: path
39532           description: String that identifies the interface
39533           required: true
39534           type: string
39535           example: __VLAN-INTERFACE__
39536         - name: body
39537           in: body
39538           description: vlan object that needs to be created or updated.
39539           required: true
39540           schema:
39541             $ref: "#/patchDefinitions/vlan"
39542     delete:
39543       tags:
39544         - Network
39545       summary: delete an existing vlan
39546       description: delete an existing vlan
39547       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39548       consumes:
39549         - application/json
39550         - application/xml
39551       produces:
39552         - application/json
39553         - application/xml
39554       responses:
39555         "default":
39556           description: Response codes found in [response codes](https://wiki.onap.org/).
39557       parameters:
39558         - name: vnf-id
39559           in: path
39560           description: Unique id of VNF.  This is unique across the graph.
39561           required: true
39562           type: string
39563           example: __VNF-ID__
39564         - name: interface-name
39565           in: path
39566           description: Name that identifies the link aggregate interface
39567           required: true
39568           type: string
39569           example: __INTERFACE-NAME__
39570         - name: interface-name
39571           in: path
39572           description: Name given to the interface
39573           required: true
39574           type: string
39575           example: __INTERFACE-NAME__
39576         - name: vlan-interface
39577           in: path
39578           description: String that identifies the interface
39579           required: true
39580           type: string
39581           example: __VLAN-INTERFACE__
39582         - name: resource-version
39583           in: query
39584           description: resource-version for concurrency
39585           required: true
39586           type: string
39587   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
39588     get:
39589       tags:
39590         - Network
39591       summary: returns vlans
39592       description: returns vlans
39593       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
39594       produces:
39595         - application/json
39596         - application/xml
39597       responses:
39598         "200":
39599           description: successful operation
39600           schema:
39601               $ref: "#/getDefinitions/vlans"
39602         "default":
39603           description: Response codes found in [response codes](https://wiki.onap.org/).
39604       parameters:
39605         - name: vnf-id
39606           in: path
39607           description: Unique id of VNF.  This is unique across the graph.
39608           required: true
39609           type: string
39610           example: __VNF-ID__
39611         - name: interface-name
39612           in: path
39613           description: Name that identifies the link aggregate interface
39614           required: true
39615           type: string
39616           example: __INTERFACE-NAME__
39617         - name: interface-name
39618           in: path
39619           description: Name given to the interface
39620           required: true
39621           type: string
39622           example: __INTERFACE-NAME__
39623         - name: vnf-name
39624           in: query
39625           description: Name of VNF.
39626           required: false
39627           type: string
39628         - name: vnf-name2
39629           in: query
39630           description: Alternate name of VNF.
39631           required: false
39632           type: string
39633         - name: vnf-type
39634           in: query
39635           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.
39636           required: false
39637           type: string
39638         - name: service-id
39639           in: query
39640           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39641           required: false
39642           type: string
39643         - name: regional-resource-zone
39644           in: query
39645           description: Regional way of organizing pservers, source of truth should define values
39646           required: false
39647           type: string
39648         - name: prov-status
39649           in: query
39650           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39651           required: false
39652           type: string
39653         - name: heat-stack-id
39654           in: query
39655           description: Heat stack id corresponding to this instance, managed by MSO
39656           required: false
39657           type: string
39658         - name: in-maint
39659           in: query
39660           required: false
39661           type: boolean
39662         - name: is-closed-loop-disabled
39663           in: query
39664           required: false
39665           type: boolean
39666         - name: model-invariant-id
39667           in: query
39668           description: the ASDC model id for this resource or service model.
39669           required: false
39670           type: string
39671         - name: model-version-id
39672           in: query
39673           description: the ASDC model version for this resource or service model.
39674           required: false
39675           type: string
39676         - name: widget-model-id
39677           in: query
39678           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39679           required: false
39680           type: string
39681         - name: widget-model-version
39682           in: query
39683           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39684           required: false
39685           type: string
39686         - name: nf-type
39687           in: query
39688           description: Generic description of the type of NF
39689           required: false
39690           type: string
39691         - name: nf-function
39692           in: query
39693           description: English description of Network function that the specific VNF deployment is providing
39694           required: false
39695           type: string
39696         - name: nf-role
39697           in: query
39698           description: role in the network that this model will be providing
39699           required: false
39700           type: string
39701         - name: nf-naming-code
39702           in: query
39703           description: string assigned to this model used for naming purposes
39704           required: false
39705           type: string
39706         - name: interface-id
39707           in: query
39708           description: ID of interface
39709           required: false
39710           type: string
39711         - name: interface-role
39712           in: query
39713           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39714           required: false
39715           type: string
39716         - name: interface-id
39717           in: query
39718           description: ID of interface
39719           required: false
39720           type: string
39721         - name: macaddr
39722           in: query
39723           description: MAC address for the interface
39724           required: false
39725           type: string
39726         - name: network-name
39727           in: query
39728           description: Name of the network
39729           required: false
39730           type: string
39731   /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:
39732     put:
39733       tags:
39734         - Network
39735       summary: see node definition for valid relationships
39736       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39737       consumes:
39738         - application/json
39739         - application/xml
39740       produces:
39741         - application/json
39742         - application/xml
39743       responses:
39744         "default":
39745           description: Response codes found in [response codes](https://wiki.onap.org/).
39746       parameters:
39747         - name: vnf-id
39748           in: path
39749           description: Unique id of VNF.  This is unique across the graph.
39750           required: true
39751           type: string
39752           example: __VNF-ID__
39753         - name: interface-name
39754           in: path
39755           description: Name that identifies the link aggregate interface
39756           required: true
39757           type: string
39758           example: __INTERFACE-NAME__
39759         - name: interface-name
39760           in: path
39761           description: Name given to the interface
39762           required: true
39763           type: string
39764           example: __INTERFACE-NAME__
39765         - name: pci-id
39766           in: path
39767           description: PCI ID used to identify the sriov-vf
39768           required: true
39769           type: string
39770           example: __PCI-ID__
39771         - name: body
39772           in: body
39773           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39774           required: true
39775           schema:
39776             $ref: "#/definitions/relationship"
39777     delete:
39778       tags:
39779         - Network
39780       summary: delete an existing relationship
39781       description: delete an existing relationship
39782       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39783       consumes:
39784         - application/json
39785         - application/xml
39786       produces:
39787         - application/json
39788         - application/xml
39789       responses:
39790         "default":
39791           description: Response codes found in [response codes](https://wiki.onap.org/).
39792       parameters:
39793         - name: vnf-id
39794           in: path
39795           description: Unique id of VNF.  This is unique across the graph.
39796           required: true
39797           type: string
39798           example: __VNF-ID__
39799         - name: interface-name
39800           in: path
39801           description: Name that identifies the link aggregate interface
39802           required: true
39803           type: string
39804           example: __INTERFACE-NAME__
39805         - name: interface-name
39806           in: path
39807           description: Name given to the interface
39808           required: true
39809           type: string
39810           example: __INTERFACE-NAME__
39811         - name: pci-id
39812           in: path
39813           description: PCI ID used to identify the sriov-vf
39814           required: true
39815           type: string
39816           example: __PCI-ID__
39817   /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}:
39818     get:
39819       tags:
39820         - Network
39821       summary: returns sriov-vf
39822       description: returns sriov-vf
39823       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39824       produces:
39825         - application/json
39826         - application/xml
39827       responses:
39828         "200":
39829           description: successful operation
39830           schema:
39831               $ref: "#/getDefinitions/sriov-vf"
39832         "default":
39833           description: Response codes found in [response codes](https://wiki.onap.org/).
39834       parameters:
39835         - name: vnf-id
39836           in: path
39837           description: Unique id of VNF.  This is unique across the graph.
39838           required: true
39839           type: string
39840           example: __VNF-ID__
39841         - name: interface-name
39842           in: path
39843           description: Name that identifies the link aggregate interface
39844           required: true
39845           type: string
39846           example: __INTERFACE-NAME__
39847         - name: interface-name
39848           in: path
39849           description: Name given to the interface
39850           required: true
39851           type: string
39852           example: __INTERFACE-NAME__
39853         - name: pci-id
39854           in: path
39855           description: PCI ID used to identify the sriov-vf
39856           required: true
39857           type: string
39858           example: __PCI-ID__
39859         - name: vnf-name
39860           in: query
39861           description: Name of VNF.
39862           required: false
39863           type: string
39864         - name: vnf-name2
39865           in: query
39866           description: Alternate name of VNF.
39867           required: false
39868           type: string
39869         - name: vnf-type
39870           in: query
39871           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.
39872           required: false
39873           type: string
39874         - name: service-id
39875           in: query
39876           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39877           required: false
39878           type: string
39879         - name: regional-resource-zone
39880           in: query
39881           description: Regional way of organizing pservers, source of truth should define values
39882           required: false
39883           type: string
39884         - name: prov-status
39885           in: query
39886           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39887           required: false
39888           type: string
39889         - name: heat-stack-id
39890           in: query
39891           description: Heat stack id corresponding to this instance, managed by MSO
39892           required: false
39893           type: string
39894         - name: in-maint
39895           in: query
39896           required: false
39897           type: boolean
39898         - name: is-closed-loop-disabled
39899           in: query
39900           required: false
39901           type: boolean
39902         - name: model-invariant-id
39903           in: query
39904           description: the ASDC model id for this resource or service model.
39905           required: false
39906           type: string
39907         - name: model-version-id
39908           in: query
39909           description: the ASDC model version for this resource or service model.
39910           required: false
39911           type: string
39912         - name: widget-model-id
39913           in: query
39914           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39915           required: false
39916           type: string
39917         - name: widget-model-version
39918           in: query
39919           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39920           required: false
39921           type: string
39922         - name: nf-type
39923           in: query
39924           description: Generic description of the type of NF
39925           required: false
39926           type: string
39927         - name: nf-function
39928           in: query
39929           description: English description of Network function that the specific VNF deployment is providing
39930           required: false
39931           type: string
39932         - name: nf-role
39933           in: query
39934           description: role in the network that this model will be providing
39935           required: false
39936           type: string
39937         - name: nf-naming-code
39938           in: query
39939           description: string assigned to this model used for naming purposes
39940           required: false
39941           type: string
39942         - name: interface-id
39943           in: query
39944           description: ID of interface
39945           required: false
39946           type: string
39947         - name: interface-role
39948           in: query
39949           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39950           required: false
39951           type: string
39952         - name: interface-id
39953           in: query
39954           description: ID of interface
39955           required: false
39956           type: string
39957         - name: macaddr
39958           in: query
39959           description: MAC address for the interface
39960           required: false
39961           type: string
39962         - name: network-name
39963           in: query
39964           description: Name of the network
39965           required: false
39966           type: string
39967         - name: vf-vlan-filter
39968           in: query
39969           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
39970           required: false
39971           type: string
39972         - name: vf-mac-filter
39973           in: query
39974           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
39975           required: false
39976           type: string
39977         - name: vf-vlan-strip
39978           in: query
39979           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
39980           required: false
39981           type: boolean
39982         - name: neutron-network-id
39983           in: query
39984           description: Neutron network id of the interface
39985           required: false
39986           type: string
39987     put:
39988       tags:
39989         - Network
39990       summary: create or update an existing sriov-vf
39991       description: |
39992         Create or update an existing sriov-vf.
39993         #
39994         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39995       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39996       consumes:
39997         - application/json
39998         - application/xml
39999       produces:
40000         - application/json
40001         - application/xml
40002       responses:
40003         "default":
40004           description: Response codes found in [response codes](https://wiki.onap.org/).
40005       parameters:
40006         - name: vnf-id
40007           in: path
40008           description: Unique id of VNF.  This is unique across the graph.
40009           required: true
40010           type: string
40011           example: __VNF-ID__
40012         - name: interface-name
40013           in: path
40014           description: Name that identifies the link aggregate interface
40015           required: true
40016           type: string
40017           example: __INTERFACE-NAME__
40018         - name: interface-name
40019           in: path
40020           description: Name given to the interface
40021           required: true
40022           type: string
40023           example: __INTERFACE-NAME__
40024         - name: pci-id
40025           in: path
40026           description: PCI ID used to identify the sriov-vf
40027           required: true
40028           type: string
40029           example: __PCI-ID__
40030         - name: body
40031           in: body
40032           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40033           required: true
40034           schema:
40035             $ref: "#/definitions/sriov-vf"
40036     patch:
40037       tags:
40038         - Network
40039       summary: update an existing sriov-vf
40040       description: |
40041         Update an existing sriov-vf
40042         #
40043         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40044         The PUT operation will entirely replace an existing object.
40045         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40046         #
40047         Other differences between PUT and PATCH are:
40048         #
40049         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40050         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40051         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40052       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40053       consumes:
40054         - application/json
40055         - application/xml
40056       produces:
40057         - application/json
40058         - application/xml
40059       responses:
40060         "default":
40061           description: Response codes found in [response codes](https://wiki.onap.org/).
40062       parameters:
40063         - name: vnf-id
40064           in: path
40065           description: Unique id of VNF.  This is unique across the graph.
40066           required: true
40067           type: string
40068           example: __VNF-ID__
40069         - name: interface-name
40070           in: path
40071           description: Name that identifies the link aggregate interface
40072           required: true
40073           type: string
40074           example: __INTERFACE-NAME__
40075         - name: interface-name
40076           in: path
40077           description: Name given to the interface
40078           required: true
40079           type: string
40080           example: __INTERFACE-NAME__
40081         - name: pci-id
40082           in: path
40083           description: PCI ID used to identify the sriov-vf
40084           required: true
40085           type: string
40086           example: __PCI-ID__
40087         - name: body
40088           in: body
40089           description: sriov-vf object that needs to be created or updated.
40090           required: true
40091           schema:
40092             $ref: "#/patchDefinitions/sriov-vf"
40093     delete:
40094       tags:
40095         - Network
40096       summary: delete an existing sriov-vf
40097       description: delete an existing sriov-vf
40098       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40099       consumes:
40100         - application/json
40101         - application/xml
40102       produces:
40103         - application/json
40104         - application/xml
40105       responses:
40106         "default":
40107           description: Response codes found in [response codes](https://wiki.onap.org/).
40108       parameters:
40109         - name: vnf-id
40110           in: path
40111           description: Unique id of VNF.  This is unique across the graph.
40112           required: true
40113           type: string
40114           example: __VNF-ID__
40115         - name: interface-name
40116           in: path
40117           description: Name that identifies the link aggregate interface
40118           required: true
40119           type: string
40120           example: __INTERFACE-NAME__
40121         - name: interface-name
40122           in: path
40123           description: Name given to the interface
40124           required: true
40125           type: string
40126           example: __INTERFACE-NAME__
40127         - name: pci-id
40128           in: path
40129           description: PCI ID used to identify the sriov-vf
40130           required: true
40131           type: string
40132           example: __PCI-ID__
40133         - name: resource-version
40134           in: query
40135           description: resource-version for concurrency
40136           required: true
40137           type: string
40138   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40139     get:
40140       tags:
40141         - Network
40142       summary: returns sriov-vfs
40143       description: returns sriov-vfs
40144       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
40145       produces:
40146         - application/json
40147         - application/xml
40148       responses:
40149         "200":
40150           description: successful operation
40151           schema:
40152               $ref: "#/getDefinitions/sriov-vfs"
40153         "default":
40154           description: Response codes found in [response codes](https://wiki.onap.org/).
40155       parameters:
40156         - name: vnf-id
40157           in: path
40158           description: Unique id of VNF.  This is unique across the graph.
40159           required: true
40160           type: string
40161           example: __VNF-ID__
40162         - name: interface-name
40163           in: path
40164           description: Name that identifies the link aggregate interface
40165           required: true
40166           type: string
40167           example: __INTERFACE-NAME__
40168         - name: interface-name
40169           in: path
40170           description: Name given to the interface
40171           required: true
40172           type: string
40173           example: __INTERFACE-NAME__
40174         - name: vnf-name
40175           in: query
40176           description: Name of VNF.
40177           required: false
40178           type: string
40179         - name: vnf-name2
40180           in: query
40181           description: Alternate name of VNF.
40182           required: false
40183           type: string
40184         - name: vnf-type
40185           in: query
40186           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.
40187           required: false
40188           type: string
40189         - name: service-id
40190           in: query
40191           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40192           required: false
40193           type: string
40194         - name: regional-resource-zone
40195           in: query
40196           description: Regional way of organizing pservers, source of truth should define values
40197           required: false
40198           type: string
40199         - name: prov-status
40200           in: query
40201           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40202           required: false
40203           type: string
40204         - name: heat-stack-id
40205           in: query
40206           description: Heat stack id corresponding to this instance, managed by MSO
40207           required: false
40208           type: string
40209         - name: in-maint
40210           in: query
40211           required: false
40212           type: boolean
40213         - name: is-closed-loop-disabled
40214           in: query
40215           required: false
40216           type: boolean
40217         - name: model-invariant-id
40218           in: query
40219           description: the ASDC model id for this resource or service model.
40220           required: false
40221           type: string
40222         - name: model-version-id
40223           in: query
40224           description: the ASDC model version for this resource or service model.
40225           required: false
40226           type: string
40227         - name: widget-model-id
40228           in: query
40229           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40230           required: false
40231           type: string
40232         - name: widget-model-version
40233           in: query
40234           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40235           required: false
40236           type: string
40237         - name: nf-type
40238           in: query
40239           description: Generic description of the type of NF
40240           required: false
40241           type: string
40242         - name: nf-function
40243           in: query
40244           description: English description of Network function that the specific VNF deployment is providing
40245           required: false
40246           type: string
40247         - name: nf-role
40248           in: query
40249           description: role in the network that this model will be providing
40250           required: false
40251           type: string
40252         - name: nf-naming-code
40253           in: query
40254           description: string assigned to this model used for naming purposes
40255           required: false
40256           type: string
40257         - name: interface-id
40258           in: query
40259           description: ID of interface
40260           required: false
40261           type: string
40262         - name: interface-role
40263           in: query
40264           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40265           required: false
40266           type: string
40267         - name: interface-id
40268           in: query
40269           description: ID of interface
40270           required: false
40271           type: string
40272         - name: macaddr
40273           in: query
40274           description: MAC address for the interface
40275           required: false
40276           type: string
40277         - name: network-name
40278           in: query
40279           description: Name of the network
40280           required: false
40281           type: string
40282   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40283     put:
40284       tags:
40285         - Network
40286       summary: see node definition for valid relationships
40287       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
40288       consumes:
40289         - application/json
40290         - application/xml
40291       produces:
40292         - application/json
40293         - application/xml
40294       responses:
40295         "default":
40296           description: Response codes found in [response codes](https://wiki.onap.org/).
40297       parameters:
40298         - name: vnf-id
40299           in: path
40300           description: Unique id of VNF.  This is unique across the graph.
40301           required: true
40302           type: string
40303           example: __VNF-ID__
40304         - name: interface-name
40305           in: path
40306           description: Name that identifies the link aggregate interface
40307           required: true
40308           type: string
40309           example: __INTERFACE-NAME__
40310         - name: interface-name
40311           in: path
40312           description: Name given to the interface
40313           required: true
40314           type: string
40315           example: __INTERFACE-NAME__
40316         - name: body
40317           in: body
40318           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
40319           required: true
40320           schema:
40321             $ref: "#/definitions/relationship"
40322     delete:
40323       tags:
40324         - Network
40325       summary: delete an existing relationship
40326       description: delete an existing relationship
40327       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
40328       consumes:
40329         - application/json
40330         - application/xml
40331       produces:
40332         - application/json
40333         - application/xml
40334       responses:
40335         "default":
40336           description: Response codes found in [response codes](https://wiki.onap.org/).
40337       parameters:
40338         - name: vnf-id
40339           in: path
40340           description: Unique id of VNF.  This is unique across the graph.
40341           required: true
40342           type: string
40343           example: __VNF-ID__
40344         - name: interface-name
40345           in: path
40346           description: Name that identifies the link aggregate interface
40347           required: true
40348           type: string
40349           example: __INTERFACE-NAME__
40350         - name: interface-name
40351           in: path
40352           description: Name given to the interface
40353           required: true
40354           type: string
40355           example: __INTERFACE-NAME__
40356   /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:
40357     put:
40358       tags:
40359         - Network
40360       summary: see node definition for valid relationships
40361       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40362       consumes:
40363         - application/json
40364         - application/xml
40365       produces:
40366         - application/json
40367         - application/xml
40368       responses:
40369         "default":
40370           description: Response codes found in [response codes](https://wiki.onap.org/).
40371       parameters:
40372         - name: vnf-id
40373           in: path
40374           description: Unique id of VNF.  This is unique across the graph.
40375           required: true
40376           type: string
40377           example: __VNF-ID__
40378         - name: interface-name
40379           in: path
40380           description: Name that identifies the link aggregate interface
40381           required: true
40382           type: string
40383           example: __INTERFACE-NAME__
40384         - name: interface-name
40385           in: path
40386           description: Name given to the interface
40387           required: true
40388           type: string
40389           example: __INTERFACE-NAME__
40390         - name: l3-interface-ipv4-address
40391           in: path
40392           description: IP address
40393           required: true
40394           type: string
40395           example: __L3-INTERFACE-IPV4-ADDRESS__
40396         - name: body
40397           in: body
40398           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40399           required: true
40400           schema:
40401             $ref: "#/definitions/relationship"
40402     delete:
40403       tags:
40404         - Network
40405       summary: delete an existing relationship
40406       description: delete an existing relationship
40407       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40408       consumes:
40409         - application/json
40410         - application/xml
40411       produces:
40412         - application/json
40413         - application/xml
40414       responses:
40415         "default":
40416           description: Response codes found in [response codes](https://wiki.onap.org/).
40417       parameters:
40418         - name: vnf-id
40419           in: path
40420           description: Unique id of VNF.  This is unique across the graph.
40421           required: true
40422           type: string
40423           example: __VNF-ID__
40424         - name: interface-name
40425           in: path
40426           description: Name that identifies the link aggregate interface
40427           required: true
40428           type: string
40429           example: __INTERFACE-NAME__
40430         - name: interface-name
40431           in: path
40432           description: Name given to the interface
40433           required: true
40434           type: string
40435           example: __INTERFACE-NAME__
40436         - name: l3-interface-ipv4-address
40437           in: path
40438           description: IP address
40439           required: true
40440           type: string
40441           example: __L3-INTERFACE-IPV4-ADDRESS__
40442   /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}:
40443     get:
40444       tags:
40445         - Network
40446       summary: returns l3-interface-ipv4-address-list
40447       description: returns l3-interface-ipv4-address-list
40448       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40449       produces:
40450         - application/json
40451         - application/xml
40452       responses:
40453         "200":
40454           description: successful operation
40455           schema:
40456               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40457         "default":
40458           description: Response codes found in [response codes](https://wiki.onap.org/).
40459       parameters:
40460         - name: vnf-id
40461           in: path
40462           description: Unique id of VNF.  This is unique across the graph.
40463           required: true
40464           type: string
40465           example: __VNF-ID__
40466         - name: interface-name
40467           in: path
40468           description: Name that identifies the link aggregate interface
40469           required: true
40470           type: string
40471           example: __INTERFACE-NAME__
40472         - name: interface-name
40473           in: path
40474           description: Name given to the interface
40475           required: true
40476           type: string
40477           example: __INTERFACE-NAME__
40478         - name: l3-interface-ipv4-address
40479           in: path
40480           description: IP address
40481           required: true
40482           type: string
40483           example: __L3-INTERFACE-IPV4-ADDRESS__
40484         - name: vnf-name
40485           in: query
40486           description: Name of VNF.
40487           required: false
40488           type: string
40489         - name: vnf-name2
40490           in: query
40491           description: Alternate name of VNF.
40492           required: false
40493           type: string
40494         - name: vnf-type
40495           in: query
40496           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.
40497           required: false
40498           type: string
40499         - name: service-id
40500           in: query
40501           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40502           required: false
40503           type: string
40504         - name: regional-resource-zone
40505           in: query
40506           description: Regional way of organizing pservers, source of truth should define values
40507           required: false
40508           type: string
40509         - name: prov-status
40510           in: query
40511           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40512           required: false
40513           type: string
40514         - name: heat-stack-id
40515           in: query
40516           description: Heat stack id corresponding to this instance, managed by MSO
40517           required: false
40518           type: string
40519         - name: in-maint
40520           in: query
40521           required: false
40522           type: boolean
40523         - name: is-closed-loop-disabled
40524           in: query
40525           required: false
40526           type: boolean
40527         - name: model-invariant-id
40528           in: query
40529           description: the ASDC model id for this resource or service model.
40530           required: false
40531           type: string
40532         - name: model-version-id
40533           in: query
40534           description: the ASDC model version for this resource or service model.
40535           required: false
40536           type: string
40537         - name: widget-model-id
40538           in: query
40539           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40540           required: false
40541           type: string
40542         - name: widget-model-version
40543           in: query
40544           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40545           required: false
40546           type: string
40547         - name: nf-type
40548           in: query
40549           description: Generic description of the type of NF
40550           required: false
40551           type: string
40552         - name: nf-function
40553           in: query
40554           description: English description of Network function that the specific VNF deployment is providing
40555           required: false
40556           type: string
40557         - name: nf-role
40558           in: query
40559           description: role in the network that this model will be providing
40560           required: false
40561           type: string
40562         - name: nf-naming-code
40563           in: query
40564           description: string assigned to this model used for naming purposes
40565           required: false
40566           type: string
40567         - name: interface-id
40568           in: query
40569           description: ID of interface
40570           required: false
40571           type: string
40572         - name: interface-role
40573           in: query
40574           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40575           required: false
40576           type: string
40577         - name: interface-id
40578           in: query
40579           description: ID of interface
40580           required: false
40581           type: string
40582         - name: macaddr
40583           in: query
40584           description: MAC address for the interface
40585           required: false
40586           type: string
40587         - name: network-name
40588           in: query
40589           description: Name of the network
40590           required: false
40591           type: string
40592         - name: vlan-id-inner
40593           in: query
40594           description: Inner VLAN tag
40595           required: false
40596           type: integer
40597           format: int64
40598         - name: neutron-network-id
40599           in: query
40600           description: Neutron network id of the interface that address belongs to
40601           required: false
40602           type: string
40603         - name: neutron-subnet-id
40604           in: query
40605           description: Neutron id of subnet that address belongs to
40606           required: false
40607           type: string
40608     put:
40609       tags:
40610         - Network
40611       summary: create or update an existing l3-interface-ipv4-address-list
40612       description: |
40613         Create or update an existing l3-interface-ipv4-address-list.
40614         #
40615         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40616       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40617       consumes:
40618         - application/json
40619         - application/xml
40620       produces:
40621         - application/json
40622         - application/xml
40623       responses:
40624         "default":
40625           description: Response codes found in [response codes](https://wiki.onap.org/).
40626       parameters:
40627         - name: vnf-id
40628           in: path
40629           description: Unique id of VNF.  This is unique across the graph.
40630           required: true
40631           type: string
40632           example: __VNF-ID__
40633         - name: interface-name
40634           in: path
40635           description: Name that identifies the link aggregate interface
40636           required: true
40637           type: string
40638           example: __INTERFACE-NAME__
40639         - name: interface-name
40640           in: path
40641           description: Name given to the interface
40642           required: true
40643           type: string
40644           example: __INTERFACE-NAME__
40645         - name: l3-interface-ipv4-address
40646           in: path
40647           description: IP address
40648           required: true
40649           type: string
40650           example: __L3-INTERFACE-IPV4-ADDRESS__
40651         - name: body
40652           in: body
40653           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40654           required: true
40655           schema:
40656             $ref: "#/definitions/l3-interface-ipv4-address-list"
40657     patch:
40658       tags:
40659         - Network
40660       summary: update an existing l3-interface-ipv4-address-list
40661       description: |
40662         Update an existing l3-interface-ipv4-address-list
40663         #
40664         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40665         The PUT operation will entirely replace an existing object.
40666         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40667         #
40668         Other differences between PUT and PATCH are:
40669         #
40670         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40671         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40672         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40673       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40674       consumes:
40675         - application/json
40676         - application/xml
40677       produces:
40678         - application/json
40679         - application/xml
40680       responses:
40681         "default":
40682           description: Response codes found in [response codes](https://wiki.onap.org/).
40683       parameters:
40684         - name: vnf-id
40685           in: path
40686           description: Unique id of VNF.  This is unique across the graph.
40687           required: true
40688           type: string
40689           example: __VNF-ID__
40690         - name: interface-name
40691           in: path
40692           description: Name that identifies the link aggregate interface
40693           required: true
40694           type: string
40695           example: __INTERFACE-NAME__
40696         - name: interface-name
40697           in: path
40698           description: Name given to the interface
40699           required: true
40700           type: string
40701           example: __INTERFACE-NAME__
40702         - name: l3-interface-ipv4-address
40703           in: path
40704           description: IP address
40705           required: true
40706           type: string
40707           example: __L3-INTERFACE-IPV4-ADDRESS__
40708         - name: body
40709           in: body
40710           description: l3-interface-ipv4-address-list object that needs to be created or updated.
40711           required: true
40712           schema:
40713             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40714     delete:
40715       tags:
40716         - Network
40717       summary: delete an existing l3-interface-ipv4-address-list
40718       description: delete an existing l3-interface-ipv4-address-list
40719       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40720       consumes:
40721         - application/json
40722         - application/xml
40723       produces:
40724         - application/json
40725         - application/xml
40726       responses:
40727         "default":
40728           description: Response codes found in [response codes](https://wiki.onap.org/).
40729       parameters:
40730         - name: vnf-id
40731           in: path
40732           description: Unique id of VNF.  This is unique across the graph.
40733           required: true
40734           type: string
40735           example: __VNF-ID__
40736         - name: interface-name
40737           in: path
40738           description: Name that identifies the link aggregate interface
40739           required: true
40740           type: string
40741           example: __INTERFACE-NAME__
40742         - name: interface-name
40743           in: path
40744           description: Name given to the interface
40745           required: true
40746           type: string
40747           example: __INTERFACE-NAME__
40748         - name: l3-interface-ipv4-address
40749           in: path
40750           description: IP address
40751           required: true
40752           type: string
40753           example: __L3-INTERFACE-IPV4-ADDRESS__
40754         - name: resource-version
40755           in: query
40756           description: resource-version for concurrency
40757           required: true
40758           type: string
40759   /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:
40760     put:
40761       tags:
40762         - Network
40763       summary: see node definition for valid relationships
40764       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40765       consumes:
40766         - application/json
40767         - application/xml
40768       produces:
40769         - application/json
40770         - application/xml
40771       responses:
40772         "default":
40773           description: Response codes found in [response codes](https://wiki.onap.org/).
40774       parameters:
40775         - name: vnf-id
40776           in: path
40777           description: Unique id of VNF.  This is unique across the graph.
40778           required: true
40779           type: string
40780           example: __VNF-ID__
40781         - name: interface-name
40782           in: path
40783           description: Name that identifies the link aggregate interface
40784           required: true
40785           type: string
40786           example: __INTERFACE-NAME__
40787         - name: interface-name
40788           in: path
40789           description: Name given to the interface
40790           required: true
40791           type: string
40792           example: __INTERFACE-NAME__
40793         - name: l3-interface-ipv6-address
40794           in: path
40795           description: IP address
40796           required: true
40797           type: string
40798           example: __L3-INTERFACE-IPV6-ADDRESS__
40799         - name: body
40800           in: body
40801           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40802           required: true
40803           schema:
40804             $ref: "#/definitions/relationship"
40805     delete:
40806       tags:
40807         - Network
40808       summary: delete an existing relationship
40809       description: delete an existing relationship
40810       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40811       consumes:
40812         - application/json
40813         - application/xml
40814       produces:
40815         - application/json
40816         - application/xml
40817       responses:
40818         "default":
40819           description: Response codes found in [response codes](https://wiki.onap.org/).
40820       parameters:
40821         - name: vnf-id
40822           in: path
40823           description: Unique id of VNF.  This is unique across the graph.
40824           required: true
40825           type: string
40826           example: __VNF-ID__
40827         - name: interface-name
40828           in: path
40829           description: Name that identifies the link aggregate interface
40830           required: true
40831           type: string
40832           example: __INTERFACE-NAME__
40833         - name: interface-name
40834           in: path
40835           description: Name given to the interface
40836           required: true
40837           type: string
40838           example: __INTERFACE-NAME__
40839         - name: l3-interface-ipv6-address
40840           in: path
40841           description: IP address
40842           required: true
40843           type: string
40844           example: __L3-INTERFACE-IPV6-ADDRESS__
40845   /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}:
40846     get:
40847       tags:
40848         - Network
40849       summary: returns l3-interface-ipv6-address-list
40850       description: returns l3-interface-ipv6-address-list
40851       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40852       produces:
40853         - application/json
40854         - application/xml
40855       responses:
40856         "200":
40857           description: successful operation
40858           schema:
40859               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40860         "default":
40861           description: Response codes found in [response codes](https://wiki.onap.org/).
40862       parameters:
40863         - name: vnf-id
40864           in: path
40865           description: Unique id of VNF.  This is unique across the graph.
40866           required: true
40867           type: string
40868           example: __VNF-ID__
40869         - name: interface-name
40870           in: path
40871           description: Name that identifies the link aggregate interface
40872           required: true
40873           type: string
40874           example: __INTERFACE-NAME__
40875         - name: interface-name
40876           in: path
40877           description: Name given to the interface
40878           required: true
40879           type: string
40880           example: __INTERFACE-NAME__
40881         - name: l3-interface-ipv6-address
40882           in: path
40883           description: IP address
40884           required: true
40885           type: string
40886           example: __L3-INTERFACE-IPV6-ADDRESS__
40887         - name: vnf-name
40888           in: query
40889           description: Name of VNF.
40890           required: false
40891           type: string
40892         - name: vnf-name2
40893           in: query
40894           description: Alternate name of VNF.
40895           required: false
40896           type: string
40897         - name: vnf-type
40898           in: query
40899           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.
40900           required: false
40901           type: string
40902         - name: service-id
40903           in: query
40904           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40905           required: false
40906           type: string
40907         - name: regional-resource-zone
40908           in: query
40909           description: Regional way of organizing pservers, source of truth should define values
40910           required: false
40911           type: string
40912         - name: prov-status
40913           in: query
40914           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40915           required: false
40916           type: string
40917         - name: heat-stack-id
40918           in: query
40919           description: Heat stack id corresponding to this instance, managed by MSO
40920           required: false
40921           type: string
40922         - name: in-maint
40923           in: query
40924           required: false
40925           type: boolean
40926         - name: is-closed-loop-disabled
40927           in: query
40928           required: false
40929           type: boolean
40930         - name: model-invariant-id
40931           in: query
40932           description: the ASDC model id for this resource or service model.
40933           required: false
40934           type: string
40935         - name: model-version-id
40936           in: query
40937           description: the ASDC model version for this resource or service model.
40938           required: false
40939           type: string
40940         - name: widget-model-id
40941           in: query
40942           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40943           required: false
40944           type: string
40945         - name: widget-model-version
40946           in: query
40947           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40948           required: false
40949           type: string
40950         - name: nf-type
40951           in: query
40952           description: Generic description of the type of NF
40953           required: false
40954           type: string
40955         - name: nf-function
40956           in: query
40957           description: English description of Network function that the specific VNF deployment is providing
40958           required: false
40959           type: string
40960         - name: nf-role
40961           in: query
40962           description: role in the network that this model will be providing
40963           required: false
40964           type: string
40965         - name: nf-naming-code
40966           in: query
40967           description: string assigned to this model used for naming purposes
40968           required: false
40969           type: string
40970         - name: interface-id
40971           in: query
40972           description: ID of interface
40973           required: false
40974           type: string
40975         - name: interface-role
40976           in: query
40977           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40978           required: false
40979           type: string
40980         - name: interface-id
40981           in: query
40982           description: ID of interface
40983           required: false
40984           type: string
40985         - name: macaddr
40986           in: query
40987           description: MAC address for the interface
40988           required: false
40989           type: string
40990         - name: network-name
40991           in: query
40992           description: Name of the network
40993           required: false
40994           type: string
40995         - name: vlan-id-inner
40996           in: query
40997           description: Inner VLAN tag
40998           required: false
40999           type: integer
41000           format: int64
41001         - name: neutron-network-id
41002           in: query
41003           description: Neutron network id of the interface that address belongs to
41004           required: false
41005           type: string
41006         - name: neutron-subnet-id
41007           in: query
41008           description: Neutron id of subnet that address belongs to
41009           required: false
41010           type: string
41011     put:
41012       tags:
41013         - Network
41014       summary: create or update an existing l3-interface-ipv6-address-list
41015       description: |
41016         Create or update an existing l3-interface-ipv6-address-list.
41017         #
41018         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41019       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41020       consumes:
41021         - application/json
41022         - application/xml
41023       produces:
41024         - application/json
41025         - application/xml
41026       responses:
41027         "default":
41028           description: Response codes found in [response codes](https://wiki.onap.org/).
41029       parameters:
41030         - name: vnf-id
41031           in: path
41032           description: Unique id of VNF.  This is unique across the graph.
41033           required: true
41034           type: string
41035           example: __VNF-ID__
41036         - name: interface-name
41037           in: path
41038           description: Name that identifies the link aggregate interface
41039           required: true
41040           type: string
41041           example: __INTERFACE-NAME__
41042         - name: interface-name
41043           in: path
41044           description: Name given to the interface
41045           required: true
41046           type: string
41047           example: __INTERFACE-NAME__
41048         - name: l3-interface-ipv6-address
41049           in: path
41050           description: IP address
41051           required: true
41052           type: string
41053           example: __L3-INTERFACE-IPV6-ADDRESS__
41054         - name: body
41055           in: body
41056           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41057           required: true
41058           schema:
41059             $ref: "#/definitions/l3-interface-ipv6-address-list"
41060     patch:
41061       tags:
41062         - Network
41063       summary: update an existing l3-interface-ipv6-address-list
41064       description: |
41065         Update an existing l3-interface-ipv6-address-list
41066         #
41067         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41068         The PUT operation will entirely replace an existing object.
41069         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41070         #
41071         Other differences between PUT and PATCH are:
41072         #
41073         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41074         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41075         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41076       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41077       consumes:
41078         - application/json
41079         - application/xml
41080       produces:
41081         - application/json
41082         - application/xml
41083       responses:
41084         "default":
41085           description: Response codes found in [response codes](https://wiki.onap.org/).
41086       parameters:
41087         - name: vnf-id
41088           in: path
41089           description: Unique id of VNF.  This is unique across the graph.
41090           required: true
41091           type: string
41092           example: __VNF-ID__
41093         - name: interface-name
41094           in: path
41095           description: Name that identifies the link aggregate interface
41096           required: true
41097           type: string
41098           example: __INTERFACE-NAME__
41099         - name: interface-name
41100           in: path
41101           description: Name given to the interface
41102           required: true
41103           type: string
41104           example: __INTERFACE-NAME__
41105         - name: l3-interface-ipv6-address
41106           in: path
41107           description: IP address
41108           required: true
41109           type: string
41110           example: __L3-INTERFACE-IPV6-ADDRESS__
41111         - name: body
41112           in: body
41113           description: l3-interface-ipv6-address-list object that needs to be created or updated.
41114           required: true
41115           schema:
41116             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41117     delete:
41118       tags:
41119         - Network
41120       summary: delete an existing l3-interface-ipv6-address-list
41121       description: delete an existing l3-interface-ipv6-address-list
41122       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41123       consumes:
41124         - application/json
41125         - application/xml
41126       produces:
41127         - application/json
41128         - application/xml
41129       responses:
41130         "default":
41131           description: Response codes found in [response codes](https://wiki.onap.org/).
41132       parameters:
41133         - name: vnf-id
41134           in: path
41135           description: Unique id of VNF.  This is unique across the graph.
41136           required: true
41137           type: string
41138           example: __VNF-ID__
41139         - name: interface-name
41140           in: path
41141           description: Name that identifies the link aggregate interface
41142           required: true
41143           type: string
41144           example: __INTERFACE-NAME__
41145         - name: interface-name
41146           in: path
41147           description: Name given to the interface
41148           required: true
41149           type: string
41150           example: __INTERFACE-NAME__
41151         - name: l3-interface-ipv6-address
41152           in: path
41153           description: IP address
41154           required: true
41155           type: string
41156           example: __L3-INTERFACE-IPV6-ADDRESS__
41157         - name: resource-version
41158           in: query
41159           description: resource-version for concurrency
41160           required: true
41161           type: string
41162   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
41163     get:
41164       tags:
41165         - Network
41166       summary: returns l-interface
41167       description: returns l-interface
41168       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
41169       produces:
41170         - application/json
41171         - application/xml
41172       responses:
41173         "200":
41174           description: successful operation
41175           schema:
41176               $ref: "#/getDefinitions/l-interface"
41177         "default":
41178           description: Response codes found in [response codes](https://wiki.onap.org/).
41179       parameters:
41180         - name: vnf-id
41181           in: path
41182           description: Unique id of VNF.  This is unique across the graph.
41183           required: true
41184           type: string
41185           example: __VNF-ID__
41186         - name: interface-name
41187           in: path
41188           description: Name that identifies the link aggregate interface
41189           required: true
41190           type: string
41191           example: __INTERFACE-NAME__
41192         - name: interface-name
41193           in: path
41194           description: Name given to the interface
41195           required: true
41196           type: string
41197           example: __INTERFACE-NAME__
41198         - name: vnf-name
41199           in: query
41200           description: Name of VNF.
41201           required: false
41202           type: string
41203         - name: vnf-name2
41204           in: query
41205           description: Alternate name of VNF.
41206           required: false
41207           type: string
41208         - name: vnf-type
41209           in: query
41210           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.
41211           required: false
41212           type: string
41213         - name: service-id
41214           in: query
41215           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41216           required: false
41217           type: string
41218         - name: regional-resource-zone
41219           in: query
41220           description: Regional way of organizing pservers, source of truth should define values
41221           required: false
41222           type: string
41223         - name: prov-status
41224           in: query
41225           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41226           required: false
41227           type: string
41228         - name: heat-stack-id
41229           in: query
41230           description: Heat stack id corresponding to this instance, managed by MSO
41231           required: false
41232           type: string
41233         - name: in-maint
41234           in: query
41235           required: false
41236           type: boolean
41237         - name: is-closed-loop-disabled
41238           in: query
41239           required: false
41240           type: boolean
41241         - name: model-invariant-id
41242           in: query
41243           description: the ASDC model id for this resource or service model.
41244           required: false
41245           type: string
41246         - name: model-version-id
41247           in: query
41248           description: the ASDC model version for this resource or service model.
41249           required: false
41250           type: string
41251         - name: widget-model-id
41252           in: query
41253           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41254           required: false
41255           type: string
41256         - name: widget-model-version
41257           in: query
41258           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41259           required: false
41260           type: string
41261         - name: nf-type
41262           in: query
41263           description: Generic description of the type of NF
41264           required: false
41265           type: string
41266         - name: nf-function
41267           in: query
41268           description: English description of Network function that the specific VNF deployment is providing
41269           required: false
41270           type: string
41271         - name: nf-role
41272           in: query
41273           description: role in the network that this model will be providing
41274           required: false
41275           type: string
41276         - name: nf-naming-code
41277           in: query
41278           description: string assigned to this model used for naming purposes
41279           required: false
41280           type: string
41281         - name: interface-id
41282           in: query
41283           description: ID of interface
41284           required: false
41285           type: string
41286         - name: interface-role
41287           in: query
41288           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41289           required: false
41290           type: string
41291         - name: interface-id
41292           in: query
41293           description: ID of interface
41294           required: false
41295           type: string
41296         - name: macaddr
41297           in: query
41298           description: MAC address for the interface
41299           required: false
41300           type: string
41301         - name: network-name
41302           in: query
41303           description: Name of the network
41304           required: false
41305           type: string
41306     put:
41307       tags:
41308         - Network
41309       summary: create or update an existing l-interface
41310       description: |
41311         Create or update an existing l-interface.
41312         #
41313         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41314       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
41315       consumes:
41316         - application/json
41317         - application/xml
41318       produces:
41319         - application/json
41320         - application/xml
41321       responses:
41322         "default":
41323           description: Response codes found in [response codes](https://wiki.onap.org/).
41324       parameters:
41325         - name: vnf-id
41326           in: path
41327           description: Unique id of VNF.  This is unique across the graph.
41328           required: true
41329           type: string
41330           example: __VNF-ID__
41331         - name: interface-name
41332           in: path
41333           description: Name that identifies the link aggregate interface
41334           required: true
41335           type: string
41336           example: __INTERFACE-NAME__
41337         - name: interface-name
41338           in: path
41339           description: Name given to the interface
41340           required: true
41341           type: string
41342           example: __INTERFACE-NAME__
41343         - name: body
41344           in: body
41345           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
41346           required: true
41347           schema:
41348             $ref: "#/definitions/l-interface"
41349     patch:
41350       tags:
41351         - Network
41352       summary: update an existing l-interface
41353       description: |
41354         Update an existing l-interface
41355         #
41356         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41357         The PUT operation will entirely replace an existing object.
41358         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41359         #
41360         Other differences between PUT and PATCH are:
41361         #
41362         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41363         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41364         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41365       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
41366       consumes:
41367         - application/json
41368         - application/xml
41369       produces:
41370         - application/json
41371         - application/xml
41372       responses:
41373         "default":
41374           description: Response codes found in [response codes](https://wiki.onap.org/).
41375       parameters:
41376         - name: vnf-id
41377           in: path
41378           description: Unique id of VNF.  This is unique across the graph.
41379           required: true
41380           type: string
41381           example: __VNF-ID__
41382         - name: interface-name
41383           in: path
41384           description: Name that identifies the link aggregate interface
41385           required: true
41386           type: string
41387           example: __INTERFACE-NAME__
41388         - name: interface-name
41389           in: path
41390           description: Name given to the interface
41391           required: true
41392           type: string
41393           example: __INTERFACE-NAME__
41394         - name: body
41395           in: body
41396           description: l-interface object that needs to be created or updated.
41397           required: true
41398           schema:
41399             $ref: "#/patchDefinitions/l-interface"
41400     delete:
41401       tags:
41402         - Network
41403       summary: delete an existing l-interface
41404       description: delete an existing l-interface
41405       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
41406       consumes:
41407         - application/json
41408         - application/xml
41409       produces:
41410         - application/json
41411         - application/xml
41412       responses:
41413         "default":
41414           description: Response codes found in [response codes](https://wiki.onap.org/).
41415       parameters:
41416         - name: vnf-id
41417           in: path
41418           description: Unique id of VNF.  This is unique across the graph.
41419           required: true
41420           type: string
41421           example: __VNF-ID__
41422         - name: interface-name
41423           in: path
41424           description: Name that identifies the link aggregate interface
41425           required: true
41426           type: string
41427           example: __INTERFACE-NAME__
41428         - name: interface-name
41429           in: path
41430           description: Name given to the interface
41431           required: true
41432           type: string
41433           example: __INTERFACE-NAME__
41434         - name: resource-version
41435           in: query
41436           description: resource-version for concurrency
41437           required: true
41438           type: string
41439   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
41440     get:
41441       tags:
41442         - Network
41443       summary: returns l-interfaces
41444       description: returns l-interfaces
41445       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
41446       produces:
41447         - application/json
41448         - application/xml
41449       responses:
41450         "200":
41451           description: successful operation
41452           schema:
41453               $ref: "#/getDefinitions/l-interfaces"
41454         "default":
41455           description: Response codes found in [response codes](https://wiki.onap.org/).
41456       parameters:
41457         - name: vnf-id
41458           in: path
41459           description: Unique id of VNF.  This is unique across the graph.
41460           required: true
41461           type: string
41462           example: __VNF-ID__
41463         - name: interface-name
41464           in: path
41465           description: Name that identifies the link aggregate interface
41466           required: true
41467           type: string
41468           example: __INTERFACE-NAME__
41469         - name: vnf-name
41470           in: query
41471           description: Name of VNF.
41472           required: false
41473           type: string
41474         - name: vnf-name2
41475           in: query
41476           description: Alternate name of VNF.
41477           required: false
41478           type: string
41479         - name: vnf-type
41480           in: query
41481           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.
41482           required: false
41483           type: string
41484         - name: service-id
41485           in: query
41486           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41487           required: false
41488           type: string
41489         - name: regional-resource-zone
41490           in: query
41491           description: Regional way of organizing pservers, source of truth should define values
41492           required: false
41493           type: string
41494         - name: prov-status
41495           in: query
41496           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41497           required: false
41498           type: string
41499         - name: heat-stack-id
41500           in: query
41501           description: Heat stack id corresponding to this instance, managed by MSO
41502           required: false
41503           type: string
41504         - name: in-maint
41505           in: query
41506           required: false
41507           type: boolean
41508         - name: is-closed-loop-disabled
41509           in: query
41510           required: false
41511           type: boolean
41512         - name: model-invariant-id
41513           in: query
41514           description: the ASDC model id for this resource or service model.
41515           required: false
41516           type: string
41517         - name: model-version-id
41518           in: query
41519           description: the ASDC model version for this resource or service model.
41520           required: false
41521           type: string
41522         - name: widget-model-id
41523           in: query
41524           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41525           required: false
41526           type: string
41527         - name: widget-model-version
41528           in: query
41529           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41530           required: false
41531           type: string
41532         - name: nf-type
41533           in: query
41534           description: Generic description of the type of NF
41535           required: false
41536           type: string
41537         - name: nf-function
41538           in: query
41539           description: English description of Network function that the specific VNF deployment is providing
41540           required: false
41541           type: string
41542         - name: nf-role
41543           in: query
41544           description: role in the network that this model will be providing
41545           required: false
41546           type: string
41547         - name: nf-naming-code
41548           in: query
41549           description: string assigned to this model used for naming purposes
41550           required: false
41551           type: string
41552         - name: interface-id
41553           in: query
41554           description: ID of interface
41555           required: false
41556           type: string
41557         - name: interface-role
41558           in: query
41559           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41560           required: false
41561           type: string
41562   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
41563     get:
41564       tags:
41565         - Network
41566       summary: returns lag-interface
41567       description: returns lag-interface
41568       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41569       produces:
41570         - application/json
41571         - application/xml
41572       responses:
41573         "200":
41574           description: successful operation
41575           schema:
41576               $ref: "#/getDefinitions/lag-interface"
41577         "default":
41578           description: Response codes found in [response codes](https://wiki.onap.org/).
41579       parameters:
41580         - name: vnf-id
41581           in: path
41582           description: Unique id of VNF.  This is unique across the graph.
41583           required: true
41584           type: string
41585           example: __VNF-ID__
41586         - name: interface-name
41587           in: path
41588           description: Name that identifies the link aggregate interface
41589           required: true
41590           type: string
41591           example: __INTERFACE-NAME__
41592         - name: vnf-name
41593           in: query
41594           description: Name of VNF.
41595           required: false
41596           type: string
41597         - name: vnf-name2
41598           in: query
41599           description: Alternate name of VNF.
41600           required: false
41601           type: string
41602         - name: vnf-type
41603           in: query
41604           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.
41605           required: false
41606           type: string
41607         - name: service-id
41608           in: query
41609           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41610           required: false
41611           type: string
41612         - name: regional-resource-zone
41613           in: query
41614           description: Regional way of organizing pservers, source of truth should define values
41615           required: false
41616           type: string
41617         - name: prov-status
41618           in: query
41619           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41620           required: false
41621           type: string
41622         - name: heat-stack-id
41623           in: query
41624           description: Heat stack id corresponding to this instance, managed by MSO
41625           required: false
41626           type: string
41627         - name: in-maint
41628           in: query
41629           required: false
41630           type: boolean
41631         - name: is-closed-loop-disabled
41632           in: query
41633           required: false
41634           type: boolean
41635         - name: model-invariant-id
41636           in: query
41637           description: the ASDC model id for this resource or service model.
41638           required: false
41639           type: string
41640         - name: model-version-id
41641           in: query
41642           description: the ASDC model version for this resource or service model.
41643           required: false
41644           type: string
41645         - name: widget-model-id
41646           in: query
41647           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41648           required: false
41649           type: string
41650         - name: widget-model-version
41651           in: query
41652           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41653           required: false
41654           type: string
41655         - name: nf-type
41656           in: query
41657           description: Generic description of the type of NF
41658           required: false
41659           type: string
41660         - name: nf-function
41661           in: query
41662           description: English description of Network function that the specific VNF deployment is providing
41663           required: false
41664           type: string
41665         - name: nf-role
41666           in: query
41667           description: role in the network that this model will be providing
41668           required: false
41669           type: string
41670         - name: nf-naming-code
41671           in: query
41672           description: string assigned to this model used for naming purposes
41673           required: false
41674           type: string
41675         - name: interface-id
41676           in: query
41677           description: ID of interface
41678           required: false
41679           type: string
41680         - name: interface-role
41681           in: query
41682           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41683           required: false
41684           type: string
41685     put:
41686       tags:
41687         - Network
41688       summary: create or update an existing lag-interface
41689       description: |
41690         Create or update an existing lag-interface.
41691         #
41692         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41693       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41694       consumes:
41695         - application/json
41696         - application/xml
41697       produces:
41698         - application/json
41699         - application/xml
41700       responses:
41701         "default":
41702           description: Response codes found in [response codes](https://wiki.onap.org/).
41703       parameters:
41704         - name: vnf-id
41705           in: path
41706           description: Unique id of VNF.  This is unique across the graph.
41707           required: true
41708           type: string
41709           example: __VNF-ID__
41710         - name: interface-name
41711           in: path
41712           description: Name that identifies the link aggregate interface
41713           required: true
41714           type: string
41715           example: __INTERFACE-NAME__
41716         - name: body
41717           in: body
41718           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
41719           required: true
41720           schema:
41721             $ref: "#/definitions/lag-interface"
41722     patch:
41723       tags:
41724         - Network
41725       summary: update an existing lag-interface
41726       description: |
41727         Update an existing lag-interface
41728         #
41729         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41730         The PUT operation will entirely replace an existing object.
41731         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41732         #
41733         Other differences between PUT and PATCH are:
41734         #
41735         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41736         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41737         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41738       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41739       consumes:
41740         - application/json
41741         - application/xml
41742       produces:
41743         - application/json
41744         - application/xml
41745       responses:
41746         "default":
41747           description: Response codes found in [response codes](https://wiki.onap.org/).
41748       parameters:
41749         - name: vnf-id
41750           in: path
41751           description: Unique id of VNF.  This is unique across the graph.
41752           required: true
41753           type: string
41754           example: __VNF-ID__
41755         - name: interface-name
41756           in: path
41757           description: Name that identifies the link aggregate interface
41758           required: true
41759           type: string
41760           example: __INTERFACE-NAME__
41761         - name: body
41762           in: body
41763           description: lag-interface object that needs to be created or updated.
41764           required: true
41765           schema:
41766             $ref: "#/patchDefinitions/lag-interface"
41767     delete:
41768       tags:
41769         - Network
41770       summary: delete an existing lag-interface
41771       description: delete an existing lag-interface
41772       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41773       consumes:
41774         - application/json
41775         - application/xml
41776       produces:
41777         - application/json
41778         - application/xml
41779       responses:
41780         "default":
41781           description: Response codes found in [response codes](https://wiki.onap.org/).
41782       parameters:
41783         - name: vnf-id
41784           in: path
41785           description: Unique id of VNF.  This is unique across the graph.
41786           required: true
41787           type: string
41788           example: __VNF-ID__
41789         - name: interface-name
41790           in: path
41791           description: Name that identifies the link aggregate interface
41792           required: true
41793           type: string
41794           example: __INTERFACE-NAME__
41795         - name: resource-version
41796           in: query
41797           description: resource-version for concurrency
41798           required: true
41799           type: string
41800   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
41801     get:
41802       tags:
41803         - Network
41804       summary: returns lag-interfaces
41805       description: returns lag-interfaces
41806       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
41807       produces:
41808         - application/json
41809         - application/xml
41810       responses:
41811         "200":
41812           description: successful operation
41813           schema:
41814               $ref: "#/getDefinitions/lag-interfaces"
41815         "default":
41816           description: Response codes found in [response codes](https://wiki.onap.org/).
41817       parameters:
41818         - name: vnf-id
41819           in: path
41820           description: Unique id of VNF.  This is unique across the graph.
41821           required: true
41822           type: string
41823           example: __VNF-ID__
41824         - name: vnf-name
41825           in: query
41826           description: Name of VNF.
41827           required: false
41828           type: string
41829         - name: vnf-name2
41830           in: query
41831           description: Alternate name of VNF.
41832           required: false
41833           type: string
41834         - name: vnf-type
41835           in: query
41836           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.
41837           required: false
41838           type: string
41839         - name: service-id
41840           in: query
41841           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41842           required: false
41843           type: string
41844         - name: regional-resource-zone
41845           in: query
41846           description: Regional way of organizing pservers, source of truth should define values
41847           required: false
41848           type: string
41849         - name: prov-status
41850           in: query
41851           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41852           required: false
41853           type: string
41854         - name: heat-stack-id
41855           in: query
41856           description: Heat stack id corresponding to this instance, managed by MSO
41857           required: false
41858           type: string
41859         - name: in-maint
41860           in: query
41861           required: false
41862           type: boolean
41863         - name: is-closed-loop-disabled
41864           in: query
41865           required: false
41866           type: boolean
41867         - name: model-invariant-id
41868           in: query
41869           description: the ASDC model id for this resource or service model.
41870           required: false
41871           type: string
41872         - name: model-version-id
41873           in: query
41874           description: the ASDC model version for this resource or service model.
41875           required: false
41876           type: string
41877         - name: widget-model-id
41878           in: query
41879           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41880           required: false
41881           type: string
41882         - name: widget-model-version
41883           in: query
41884           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41885           required: false
41886           type: string
41887         - name: nf-type
41888           in: query
41889           description: Generic description of the type of NF
41890           required: false
41891           type: string
41892         - name: nf-function
41893           in: query
41894           description: English description of Network function that the specific VNF deployment is providing
41895           required: false
41896           type: string
41897         - name: nf-role
41898           in: query
41899           description: role in the network that this model will be providing
41900           required: false
41901           type: string
41902         - name: nf-naming-code
41903           in: query
41904           description: string assigned to this model used for naming purposes
41905           required: false
41906           type: string
41907   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
41908     put:
41909       tags:
41910         - Network
41911       summary: see node definition for valid relationships
41912       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
41913       consumes:
41914         - application/json
41915         - application/xml
41916       produces:
41917         - application/json
41918         - application/xml
41919       responses:
41920         "default":
41921           description: Response codes found in [response codes](https://wiki.onap.org/).
41922       parameters:
41923         - name: vnf-id
41924           in: path
41925           description: Unique id of VNF.  This is unique across the graph.
41926           required: true
41927           type: string
41928           example: __VNF-ID__
41929         - name: vf-module-id
41930           in: path
41931           description: Unique ID of vf-module.
41932           required: true
41933           type: string
41934           example: __VF-MODULE-ID__
41935         - name: body
41936           in: body
41937           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
41938           required: true
41939           schema:
41940             $ref: "#/definitions/relationship"
41941     delete:
41942       tags:
41943         - Network
41944       summary: delete an existing relationship
41945       description: delete an existing relationship
41946       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
41947       consumes:
41948         - application/json
41949         - application/xml
41950       produces:
41951         - application/json
41952         - application/xml
41953       responses:
41954         "default":
41955           description: Response codes found in [response codes](https://wiki.onap.org/).
41956       parameters:
41957         - name: vnf-id
41958           in: path
41959           description: Unique id of VNF.  This is unique across the graph.
41960           required: true
41961           type: string
41962           example: __VNF-ID__
41963         - name: vf-module-id
41964           in: path
41965           description: Unique ID of vf-module.
41966           required: true
41967           type: string
41968           example: __VF-MODULE-ID__
41969   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
41970     get:
41971       tags:
41972         - Network
41973       summary: returns vf-module
41974       description: returns vf-module
41975       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
41976       produces:
41977         - application/json
41978         - application/xml
41979       responses:
41980         "200":
41981           description: successful operation
41982           schema:
41983               $ref: "#/getDefinitions/vf-module"
41984         "default":
41985           description: Response codes found in [response codes](https://wiki.onap.org/).
41986       parameters:
41987         - name: vnf-id
41988           in: path
41989           description: Unique id of VNF.  This is unique across the graph.
41990           required: true
41991           type: string
41992           example: __VNF-ID__
41993         - name: vf-module-id
41994           in: path
41995           description: Unique ID of vf-module.
41996           required: true
41997           type: string
41998           example: __VF-MODULE-ID__
41999         - name: vnf-name
42000           in: query
42001           description: Name of VNF.
42002           required: false
42003           type: string
42004         - name: vnf-name2
42005           in: query
42006           description: Alternate name of VNF.
42007           required: false
42008           type: string
42009         - name: vnf-type
42010           in: query
42011           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.
42012           required: false
42013           type: string
42014         - name: service-id
42015           in: query
42016           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42017           required: false
42018           type: string
42019         - name: regional-resource-zone
42020           in: query
42021           description: Regional way of organizing pservers, source of truth should define values
42022           required: false
42023           type: string
42024         - name: prov-status
42025           in: query
42026           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42027           required: false
42028           type: string
42029         - name: heat-stack-id
42030           in: query
42031           description: Heat stack id corresponding to this instance, managed by MSO
42032           required: false
42033           type: string
42034         - name: in-maint
42035           in: query
42036           required: false
42037           type: boolean
42038         - name: is-closed-loop-disabled
42039           in: query
42040           required: false
42041           type: boolean
42042         - name: model-invariant-id
42043           in: query
42044           description: the ASDC model id for this resource or service model.
42045           required: false
42046           type: string
42047         - name: model-version-id
42048           in: query
42049           description: the ASDC model version for this resource or service model.
42050           required: false
42051           type: string
42052         - name: widget-model-id
42053           in: query
42054           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42055           required: false
42056           type: string
42057         - name: widget-model-version
42058           in: query
42059           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42060           required: false
42061           type: string
42062         - name: nf-type
42063           in: query
42064           description: Generic description of the type of NF
42065           required: false
42066           type: string
42067         - name: nf-function
42068           in: query
42069           description: English description of Network function that the specific VNF deployment is providing
42070           required: false
42071           type: string
42072         - name: nf-role
42073           in: query
42074           description: role in the network that this model will be providing
42075           required: false
42076           type: string
42077         - name: nf-naming-code
42078           in: query
42079           description: string assigned to this model used for naming purposes
42080           required: false
42081           type: string
42082         - name: vf-module-name
42083           in: query
42084           description: Name of vf-module
42085           required: false
42086           type: string
42087         - name: heat-stack-id
42088           in: query
42089           description: Heat stack id corresponding to this instance.
42090           required: false
42091           type: string
42092         - name: model-invariant-id
42093           in: query
42094           description: the ASDC model id for this resource or service model.
42095           required: false
42096           type: string
42097         - name: model-version-id
42098           in: query
42099           description: the ASDC model version for this resource or service model.
42100           required: false
42101           type: string
42102         - name: widget-model-id
42103           in: query
42104           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42105           required: false
42106           type: string
42107         - name: widget-model-version
42108           in: query
42109           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42110           required: false
42111           type: string
42112         - name: contrail-service-instance-fqdn
42113           in: query
42114           description: the Contrail unique ID for a service-instance
42115           required: false
42116           type: string
42117     put:
42118       tags:
42119         - Network
42120       summary: create or update an existing vf-module
42121       description: |
42122         Create or update an existing vf-module.
42123         #
42124         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42125       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
42126       consumes:
42127         - application/json
42128         - application/xml
42129       produces:
42130         - application/json
42131         - application/xml
42132       responses:
42133         "default":
42134           description: Response codes found in [response codes](https://wiki.onap.org/).
42135       parameters:
42136         - name: vnf-id
42137           in: path
42138           description: Unique id of VNF.  This is unique across the graph.
42139           required: true
42140           type: string
42141           example: __VNF-ID__
42142         - name: vf-module-id
42143           in: path
42144           description: Unique ID of vf-module.
42145           required: true
42146           type: string
42147           example: __VF-MODULE-ID__
42148         - name: body
42149           in: body
42150           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
42151           required: true
42152           schema:
42153             $ref: "#/definitions/vf-module"
42154     patch:
42155       tags:
42156         - Network
42157       summary: update an existing vf-module
42158       description: |
42159         Update an existing vf-module
42160         #
42161         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42162         The PUT operation will entirely replace an existing object.
42163         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42164         #
42165         Other differences between PUT and PATCH are:
42166         #
42167         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42168         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42169         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42170       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
42171       consumes:
42172         - application/json
42173         - application/xml
42174       produces:
42175         - application/json
42176         - application/xml
42177       responses:
42178         "default":
42179           description: Response codes found in [response codes](https://wiki.onap.org/).
42180       parameters:
42181         - name: vnf-id
42182           in: path
42183           description: Unique id of VNF.  This is unique across the graph.
42184           required: true
42185           type: string
42186           example: __VNF-ID__
42187         - name: vf-module-id
42188           in: path
42189           description: Unique ID of vf-module.
42190           required: true
42191           type: string
42192           example: __VF-MODULE-ID__
42193         - name: body
42194           in: body
42195           description: vf-module object that needs to be created or updated.
42196           required: true
42197           schema:
42198             $ref: "#/patchDefinitions/vf-module"
42199     delete:
42200       tags:
42201         - Network
42202       summary: delete an existing vf-module
42203       description: delete an existing vf-module
42204       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
42205       consumes:
42206         - application/json
42207         - application/xml
42208       produces:
42209         - application/json
42210         - application/xml
42211       responses:
42212         "default":
42213           description: Response codes found in [response codes](https://wiki.onap.org/).
42214       parameters:
42215         - name: vnf-id
42216           in: path
42217           description: Unique id of VNF.  This is unique across the graph.
42218           required: true
42219           type: string
42220           example: __VNF-ID__
42221         - name: vf-module-id
42222           in: path
42223           description: Unique ID of vf-module.
42224           required: true
42225           type: string
42226           example: __VF-MODULE-ID__
42227         - name: resource-version
42228           in: query
42229           description: resource-version for concurrency
42230           required: true
42231           type: string
42232   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
42233     get:
42234       tags:
42235         - Network
42236       summary: returns vf-modules
42237       description: returns vf-modules
42238       operationId: getNetworkGenericVnfsGenericVnfVfModules
42239       produces:
42240         - application/json
42241         - application/xml
42242       responses:
42243         "200":
42244           description: successful operation
42245           schema:
42246               $ref: "#/getDefinitions/vf-modules"
42247         "default":
42248           description: Response codes found in [response codes](https://wiki.onap.org/).
42249       parameters:
42250         - name: vnf-id
42251           in: path
42252           description: Unique id of VNF.  This is unique across the graph.
42253           required: true
42254           type: string
42255           example: __VNF-ID__
42256         - name: vnf-name
42257           in: query
42258           description: Name of VNF.
42259           required: false
42260           type: string
42261         - name: vnf-name2
42262           in: query
42263           description: Alternate name of VNF.
42264           required: false
42265           type: string
42266         - name: vnf-type
42267           in: query
42268           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.
42269           required: false
42270           type: string
42271         - name: service-id
42272           in: query
42273           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42274           required: false
42275           type: string
42276         - name: regional-resource-zone
42277           in: query
42278           description: Regional way of organizing pservers, source of truth should define values
42279           required: false
42280           type: string
42281         - name: prov-status
42282           in: query
42283           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42284           required: false
42285           type: string
42286         - name: heat-stack-id
42287           in: query
42288           description: Heat stack id corresponding to this instance, managed by MSO
42289           required: false
42290           type: string
42291         - name: in-maint
42292           in: query
42293           required: false
42294           type: boolean
42295         - name: is-closed-loop-disabled
42296           in: query
42297           required: false
42298           type: boolean
42299         - name: model-invariant-id
42300           in: query
42301           description: the ASDC model id for this resource or service model.
42302           required: false
42303           type: string
42304         - name: model-version-id
42305           in: query
42306           description: the ASDC model version for this resource or service model.
42307           required: false
42308           type: string
42309         - name: widget-model-id
42310           in: query
42311           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42312           required: false
42313           type: string
42314         - name: widget-model-version
42315           in: query
42316           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42317           required: false
42318           type: string
42319         - name: nf-type
42320           in: query
42321           description: Generic description of the type of NF
42322           required: false
42323           type: string
42324         - name: nf-function
42325           in: query
42326           description: English description of Network function that the specific VNF deployment is providing
42327           required: false
42328           type: string
42329         - name: nf-role
42330           in: query
42331           description: role in the network that this model will be providing
42332           required: false
42333           type: string
42334         - name: nf-naming-code
42335           in: query
42336           description: string assigned to this model used for naming purposes
42337           required: false
42338           type: string
42339   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
42340     put:
42341       tags:
42342         - Network
42343       summary: see node definition for valid relationships
42344       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
42345       consumes:
42346         - application/json
42347         - application/xml
42348       produces:
42349         - application/json
42350         - application/xml
42351       responses:
42352         "default":
42353           description: Response codes found in [response codes](https://wiki.onap.org/).
42354       parameters:
42355         - name: vnf-id
42356           in: path
42357           description: Unique id of VNF.  This is unique across the graph.
42358           required: true
42359           type: string
42360           example: __VNF-ID__
42361         - name: group-uuid
42362           in: path
42363           description: Unique ID for the license group the resource belongs to, should be uuid.
42364           required: true
42365           type: string
42366           example: __GROUP-UUID__
42367         - name: resource-uuid
42368           in: path
42369           description: Unique ID of a license resource.
42370           required: true
42371           type: string
42372           example: __RESOURCE-UUID__
42373         - name: body
42374           in: body
42375           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
42376           required: true
42377           schema:
42378             $ref: "#/definitions/relationship"
42379     delete:
42380       tags:
42381         - Network
42382       summary: delete an existing relationship
42383       description: delete an existing relationship
42384       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
42385       consumes:
42386         - application/json
42387         - application/xml
42388       produces:
42389         - application/json
42390         - application/xml
42391       responses:
42392         "default":
42393           description: Response codes found in [response codes](https://wiki.onap.org/).
42394       parameters:
42395         - name: vnf-id
42396           in: path
42397           description: Unique id of VNF.  This is unique across the graph.
42398           required: true
42399           type: string
42400           example: __VNF-ID__
42401         - name: group-uuid
42402           in: path
42403           description: Unique ID for the license group the resource belongs to, should be uuid.
42404           required: true
42405           type: string
42406           example: __GROUP-UUID__
42407         - name: resource-uuid
42408           in: path
42409           description: Unique ID of a license resource.
42410           required: true
42411           type: string
42412           example: __RESOURCE-UUID__
42413   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
42414     get:
42415       tags:
42416         - Network
42417       summary: returns license
42418       description: returns license
42419       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
42420       produces:
42421         - application/json
42422         - application/xml
42423       responses:
42424         "200":
42425           description: successful operation
42426           schema:
42427               $ref: "#/getDefinitions/license"
42428         "default":
42429           description: Response codes found in [response codes](https://wiki.onap.org/).
42430       parameters:
42431         - name: vnf-id
42432           in: path
42433           description: Unique id of VNF.  This is unique across the graph.
42434           required: true
42435           type: string
42436           example: __VNF-ID__
42437         - name: group-uuid
42438           in: path
42439           description: Unique ID for the license group the resource belongs to, should be uuid.
42440           required: true
42441           type: string
42442           example: __GROUP-UUID__
42443         - name: resource-uuid
42444           in: path
42445           description: Unique ID of a license resource.
42446           required: true
42447           type: string
42448           example: __RESOURCE-UUID__
42449         - name: vnf-name
42450           in: query
42451           description: Name of VNF.
42452           required: false
42453           type: string
42454         - name: vnf-name2
42455           in: query
42456           description: Alternate name of VNF.
42457           required: false
42458           type: string
42459         - name: vnf-type
42460           in: query
42461           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.
42462           required: false
42463           type: string
42464         - name: service-id
42465           in: query
42466           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42467           required: false
42468           type: string
42469         - name: regional-resource-zone
42470           in: query
42471           description: Regional way of organizing pservers, source of truth should define values
42472           required: false
42473           type: string
42474         - name: prov-status
42475           in: query
42476           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42477           required: false
42478           type: string
42479         - name: heat-stack-id
42480           in: query
42481           description: Heat stack id corresponding to this instance, managed by MSO
42482           required: false
42483           type: string
42484         - name: in-maint
42485           in: query
42486           required: false
42487           type: boolean
42488         - name: is-closed-loop-disabled
42489           in: query
42490           required: false
42491           type: boolean
42492         - name: model-invariant-id
42493           in: query
42494           description: the ASDC model id for this resource or service model.
42495           required: false
42496           type: string
42497         - name: model-version-id
42498           in: query
42499           description: the ASDC model version for this resource or service model.
42500           required: false
42501           type: string
42502         - name: widget-model-id
42503           in: query
42504           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42505           required: false
42506           type: string
42507         - name: widget-model-version
42508           in: query
42509           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42510           required: false
42511           type: string
42512         - name: nf-type
42513           in: query
42514           description: Generic description of the type of NF
42515           required: false
42516           type: string
42517         - name: nf-function
42518           in: query
42519           description: English description of Network function that the specific VNF deployment is providing
42520           required: false
42521           type: string
42522         - name: nf-role
42523           in: query
42524           description: role in the network that this model will be providing
42525           required: false
42526           type: string
42527         - name: nf-naming-code
42528           in: query
42529           description: string assigned to this model used for naming purposes
42530           required: false
42531           type: string
42532     put:
42533       tags:
42534         - Network
42535       summary: create or update an existing license
42536       description: |
42537         Create or update an existing license.
42538         #
42539         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42540       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
42541       consumes:
42542         - application/json
42543         - application/xml
42544       produces:
42545         - application/json
42546         - application/xml
42547       responses:
42548         "default":
42549           description: Response codes found in [response codes](https://wiki.onap.org/).
42550       parameters:
42551         - name: vnf-id
42552           in: path
42553           description: Unique id of VNF.  This is unique across the graph.
42554           required: true
42555           type: string
42556           example: __VNF-ID__
42557         - name: group-uuid
42558           in: path
42559           description: Unique ID for the license group the resource belongs to, should be uuid.
42560           required: true
42561           type: string
42562           example: __GROUP-UUID__
42563         - name: resource-uuid
42564           in: path
42565           description: Unique ID of a license resource.
42566           required: true
42567           type: string
42568           example: __RESOURCE-UUID__
42569         - name: body
42570           in: body
42571           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
42572           required: true
42573           schema:
42574             $ref: "#/definitions/license"
42575     patch:
42576       tags:
42577         - Network
42578       summary: update an existing license
42579       description: |
42580         Update an existing license
42581         #
42582         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42583         The PUT operation will entirely replace an existing object.
42584         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42585         #
42586         Other differences between PUT and PATCH are:
42587         #
42588         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42589         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42590         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42591       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
42592       consumes:
42593         - application/json
42594         - application/xml
42595       produces:
42596         - application/json
42597         - application/xml
42598       responses:
42599         "default":
42600           description: Response codes found in [response codes](https://wiki.onap.org/).
42601       parameters:
42602         - name: vnf-id
42603           in: path
42604           description: Unique id of VNF.  This is unique across the graph.
42605           required: true
42606           type: string
42607           example: __VNF-ID__
42608         - name: group-uuid
42609           in: path
42610           description: Unique ID for the license group the resource belongs to, should be uuid.
42611           required: true
42612           type: string
42613           example: __GROUP-UUID__
42614         - name: resource-uuid
42615           in: path
42616           description: Unique ID of a license resource.
42617           required: true
42618           type: string
42619           example: __RESOURCE-UUID__
42620         - name: body
42621           in: body
42622           description: license object that needs to be created or updated.
42623           required: true
42624           schema:
42625             $ref: "#/patchDefinitions/license"
42626     delete:
42627       tags:
42628         - Network
42629       summary: delete an existing license
42630       description: delete an existing license
42631       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
42632       consumes:
42633         - application/json
42634         - application/xml
42635       produces:
42636         - application/json
42637         - application/xml
42638       responses:
42639         "default":
42640           description: Response codes found in [response codes](https://wiki.onap.org/).
42641       parameters:
42642         - name: vnf-id
42643           in: path
42644           description: Unique id of VNF.  This is unique across the graph.
42645           required: true
42646           type: string
42647           example: __VNF-ID__
42648         - name: group-uuid
42649           in: path
42650           description: Unique ID for the license group the resource belongs to, should be uuid.
42651           required: true
42652           type: string
42653           example: __GROUP-UUID__
42654         - name: resource-uuid
42655           in: path
42656           description: Unique ID of a license resource.
42657           required: true
42658           type: string
42659           example: __RESOURCE-UUID__
42660         - name: resource-version
42661           in: query
42662           description: resource-version for concurrency
42663           required: true
42664           type: string
42665   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
42666     get:
42667       tags:
42668         - Network
42669       summary: returns licenses
42670       description: returns licenses
42671       operationId: getNetworkGenericVnfsGenericVnfLicenses
42672       produces:
42673         - application/json
42674         - application/xml
42675       responses:
42676         "200":
42677           description: successful operation
42678           schema:
42679               $ref: "#/getDefinitions/licenses"
42680         "default":
42681           description: Response codes found in [response codes](https://wiki.onap.org/).
42682       parameters:
42683         - name: vnf-id
42684           in: path
42685           description: Unique id of VNF.  This is unique across the graph.
42686           required: true
42687           type: string
42688           example: __VNF-ID__
42689         - name: vnf-name
42690           in: query
42691           description: Name of VNF.
42692           required: false
42693           type: string
42694         - name: vnf-name2
42695           in: query
42696           description: Alternate name of VNF.
42697           required: false
42698           type: string
42699         - name: vnf-type
42700           in: query
42701           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.
42702           required: false
42703           type: string
42704         - name: service-id
42705           in: query
42706           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42707           required: false
42708           type: string
42709         - name: regional-resource-zone
42710           in: query
42711           description: Regional way of organizing pservers, source of truth should define values
42712           required: false
42713           type: string
42714         - name: prov-status
42715           in: query
42716           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42717           required: false
42718           type: string
42719         - name: heat-stack-id
42720           in: query
42721           description: Heat stack id corresponding to this instance, managed by MSO
42722           required: false
42723           type: string
42724         - name: in-maint
42725           in: query
42726           required: false
42727           type: boolean
42728         - name: is-closed-loop-disabled
42729           in: query
42730           required: false
42731           type: boolean
42732         - name: model-invariant-id
42733           in: query
42734           description: the ASDC model id for this resource or service model.
42735           required: false
42736           type: string
42737         - name: model-version-id
42738           in: query
42739           description: the ASDC model version for this resource or service model.
42740           required: false
42741           type: string
42742         - name: widget-model-id
42743           in: query
42744           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42745           required: false
42746           type: string
42747         - name: widget-model-version
42748           in: query
42749           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42750           required: false
42751           type: string
42752         - name: nf-type
42753           in: query
42754           description: Generic description of the type of NF
42755           required: false
42756           type: string
42757         - name: nf-function
42758           in: query
42759           description: English description of Network function that the specific VNF deployment is providing
42760           required: false
42761           type: string
42762         - name: nf-role
42763           in: query
42764           description: role in the network that this model will be providing
42765           required: false
42766           type: string
42767         - name: nf-naming-code
42768           in: query
42769           description: string assigned to this model used for naming purposes
42770           required: false
42771           type: string
42772   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
42773     put:
42774       tags:
42775         - Network
42776       summary: see node definition for valid relationships
42777       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
42778       consumes:
42779         - application/json
42780         - application/xml
42781       produces:
42782         - application/json
42783         - application/xml
42784       responses:
42785         "default":
42786           description: Response codes found in [response codes](https://wiki.onap.org/).
42787       parameters:
42788         - name: vnf-id
42789           in: path
42790           description: Unique id of VNF.  This is unique across the graph.
42791           required: true
42792           type: string
42793           example: __VNF-ID__
42794         - name: group-uuid
42795           in: path
42796           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42797           required: true
42798           type: string
42799           example: __GROUP-UUID__
42800         - name: resource-uuid
42801           in: path
42802           description: Unique ID of an entitlement resource.
42803           required: true
42804           type: string
42805           example: __RESOURCE-UUID__
42806         - name: body
42807           in: body
42808           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
42809           required: true
42810           schema:
42811             $ref: "#/definitions/relationship"
42812     delete:
42813       tags:
42814         - Network
42815       summary: delete an existing relationship
42816       description: delete an existing relationship
42817       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
42818       consumes:
42819         - application/json
42820         - application/xml
42821       produces:
42822         - application/json
42823         - application/xml
42824       responses:
42825         "default":
42826           description: Response codes found in [response codes](https://wiki.onap.org/).
42827       parameters:
42828         - name: vnf-id
42829           in: path
42830           description: Unique id of VNF.  This is unique across the graph.
42831           required: true
42832           type: string
42833           example: __VNF-ID__
42834         - name: group-uuid
42835           in: path
42836           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42837           required: true
42838           type: string
42839           example: __GROUP-UUID__
42840         - name: resource-uuid
42841           in: path
42842           description: Unique ID of an entitlement resource.
42843           required: true
42844           type: string
42845           example: __RESOURCE-UUID__
42846   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
42847     get:
42848       tags:
42849         - Network
42850       summary: returns entitlement
42851       description: returns entitlement
42852       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
42853       produces:
42854         - application/json
42855         - application/xml
42856       responses:
42857         "200":
42858           description: successful operation
42859           schema:
42860               $ref: "#/getDefinitions/entitlement"
42861         "default":
42862           description: Response codes found in [response codes](https://wiki.onap.org/).
42863       parameters:
42864         - name: vnf-id
42865           in: path
42866           description: Unique id of VNF.  This is unique across the graph.
42867           required: true
42868           type: string
42869           example: __VNF-ID__
42870         - name: group-uuid
42871           in: path
42872           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42873           required: true
42874           type: string
42875           example: __GROUP-UUID__
42876         - name: resource-uuid
42877           in: path
42878           description: Unique ID of an entitlement resource.
42879           required: true
42880           type: string
42881           example: __RESOURCE-UUID__
42882         - name: vnf-name
42883           in: query
42884           description: Name of VNF.
42885           required: false
42886           type: string
42887         - name: vnf-name2
42888           in: query
42889           description: Alternate name of VNF.
42890           required: false
42891           type: string
42892         - name: vnf-type
42893           in: query
42894           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.
42895           required: false
42896           type: string
42897         - name: service-id
42898           in: query
42899           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42900           required: false
42901           type: string
42902         - name: regional-resource-zone
42903           in: query
42904           description: Regional way of organizing pservers, source of truth should define values
42905           required: false
42906           type: string
42907         - name: prov-status
42908           in: query
42909           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42910           required: false
42911           type: string
42912         - name: heat-stack-id
42913           in: query
42914           description: Heat stack id corresponding to this instance, managed by MSO
42915           required: false
42916           type: string
42917         - name: in-maint
42918           in: query
42919           required: false
42920           type: boolean
42921         - name: is-closed-loop-disabled
42922           in: query
42923           required: false
42924           type: boolean
42925         - name: model-invariant-id
42926           in: query
42927           description: the ASDC model id for this resource or service model.
42928           required: false
42929           type: string
42930         - name: model-version-id
42931           in: query
42932           description: the ASDC model version for this resource or service model.
42933           required: false
42934           type: string
42935         - name: widget-model-id
42936           in: query
42937           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42938           required: false
42939           type: string
42940         - name: widget-model-version
42941           in: query
42942           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42943           required: false
42944           type: string
42945         - name: nf-type
42946           in: query
42947           description: Generic description of the type of NF
42948           required: false
42949           type: string
42950         - name: nf-function
42951           in: query
42952           description: English description of Network function that the specific VNF deployment is providing
42953           required: false
42954           type: string
42955         - name: nf-role
42956           in: query
42957           description: role in the network that this model will be providing
42958           required: false
42959           type: string
42960         - name: nf-naming-code
42961           in: query
42962           description: string assigned to this model used for naming purposes
42963           required: false
42964           type: string
42965     put:
42966       tags:
42967         - Network
42968       summary: create or update an existing entitlement
42969       description: |
42970         Create or update an existing entitlement.
42971         #
42972         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42973       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
42974       consumes:
42975         - application/json
42976         - application/xml
42977       produces:
42978         - application/json
42979         - application/xml
42980       responses:
42981         "default":
42982           description: Response codes found in [response codes](https://wiki.onap.org/).
42983       parameters:
42984         - name: vnf-id
42985           in: path
42986           description: Unique id of VNF.  This is unique across the graph.
42987           required: true
42988           type: string
42989           example: __VNF-ID__
42990         - name: group-uuid
42991           in: path
42992           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42993           required: true
42994           type: string
42995           example: __GROUP-UUID__
42996         - name: resource-uuid
42997           in: path
42998           description: Unique ID of an entitlement resource.
42999           required: true
43000           type: string
43001           example: __RESOURCE-UUID__
43002         - name: body
43003           in: body
43004           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
43005           required: true
43006           schema:
43007             $ref: "#/definitions/entitlement"
43008     patch:
43009       tags:
43010         - Network
43011       summary: update an existing entitlement
43012       description: |
43013         Update an existing entitlement
43014         #
43015         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43016         The PUT operation will entirely replace an existing object.
43017         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43018         #
43019         Other differences between PUT and PATCH are:
43020         #
43021         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43022         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43023         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43024       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
43025       consumes:
43026         - application/json
43027         - application/xml
43028       produces:
43029         - application/json
43030         - application/xml
43031       responses:
43032         "default":
43033           description: Response codes found in [response codes](https://wiki.onap.org/).
43034       parameters:
43035         - name: vnf-id
43036           in: path
43037           description: Unique id of VNF.  This is unique across the graph.
43038           required: true
43039           type: string
43040           example: __VNF-ID__
43041         - name: group-uuid
43042           in: path
43043           description: Unique ID for the entitlement group the resource comes from, should be uuid.
43044           required: true
43045           type: string
43046           example: __GROUP-UUID__
43047         - name: resource-uuid
43048           in: path
43049           description: Unique ID of an entitlement resource.
43050           required: true
43051           type: string
43052           example: __RESOURCE-UUID__
43053         - name: body
43054           in: body
43055           description: entitlement object that needs to be created or updated.
43056           required: true
43057           schema:
43058             $ref: "#/patchDefinitions/entitlement"
43059     delete:
43060       tags:
43061         - Network
43062       summary: delete an existing entitlement
43063       description: delete an existing entitlement
43064       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
43065       consumes:
43066         - application/json
43067         - application/xml
43068       produces:
43069         - application/json
43070         - application/xml
43071       responses:
43072         "default":
43073           description: Response codes found in [response codes](https://wiki.onap.org/).
43074       parameters:
43075         - name: vnf-id
43076           in: path
43077           description: Unique id of VNF.  This is unique across the graph.
43078           required: true
43079           type: string
43080           example: __VNF-ID__
43081         - name: group-uuid
43082           in: path
43083           description: Unique ID for the entitlement group the resource comes from, should be uuid.
43084           required: true
43085           type: string
43086           example: __GROUP-UUID__
43087         - name: resource-uuid
43088           in: path
43089           description: Unique ID of an entitlement resource.
43090           required: true
43091           type: string
43092           example: __RESOURCE-UUID__
43093         - name: resource-version
43094           in: query
43095           description: resource-version for concurrency
43096           required: true
43097           type: string
43098   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
43099     get:
43100       tags:
43101         - Network
43102       summary: returns entitlements
43103       description: returns entitlements
43104       operationId: getNetworkGenericVnfsGenericVnfEntitlements
43105       produces:
43106         - application/json
43107         - application/xml
43108       responses:
43109         "200":
43110           description: successful operation
43111           schema:
43112               $ref: "#/getDefinitions/entitlements"
43113         "default":
43114           description: Response codes found in [response codes](https://wiki.onap.org/).
43115       parameters:
43116         - name: vnf-id
43117           in: path
43118           description: Unique id of VNF.  This is unique across the graph.
43119           required: true
43120           type: string
43121           example: __VNF-ID__
43122         - name: vnf-name
43123           in: query
43124           description: Name of VNF.
43125           required: false
43126           type: string
43127         - name: vnf-name2
43128           in: query
43129           description: Alternate name of VNF.
43130           required: false
43131           type: string
43132         - name: vnf-type
43133           in: query
43134           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.
43135           required: false
43136           type: string
43137         - name: service-id
43138           in: query
43139           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
43140           required: false
43141           type: string
43142         - name: regional-resource-zone
43143           in: query
43144           description: Regional way of organizing pservers, source of truth should define values
43145           required: false
43146           type: string
43147         - name: prov-status
43148           in: query
43149           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43150           required: false
43151           type: string
43152         - name: heat-stack-id
43153           in: query
43154           description: Heat stack id corresponding to this instance, managed by MSO
43155           required: false
43156           type: string
43157         - name: in-maint
43158           in: query
43159           required: false
43160           type: boolean
43161         - name: is-closed-loop-disabled
43162           in: query
43163           required: false
43164           type: boolean
43165         - name: model-invariant-id
43166           in: query
43167           description: the ASDC model id for this resource or service model.
43168           required: false
43169           type: string
43170         - name: model-version-id
43171           in: query
43172           description: the ASDC model version for this resource or service model.
43173           required: false
43174           type: string
43175         - name: widget-model-id
43176           in: query
43177           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43178           required: false
43179           type: string
43180         - name: widget-model-version
43181           in: query
43182           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43183           required: false
43184           type: string
43185         - name: nf-type
43186           in: query
43187           description: Generic description of the type of NF
43188           required: false
43189           type: string
43190         - name: nf-function
43191           in: query
43192           description: English description of Network function that the specific VNF deployment is providing
43193           required: false
43194           type: string
43195         - name: nf-role
43196           in: query
43197           description: role in the network that this model will be providing
43198           required: false
43199           type: string
43200         - name: nf-naming-code
43201           in: query
43202           description: string assigned to this model used for naming purposes
43203           required: false
43204           type: string
43205   /network/generic-vnfs/generic-vnf/{vnf-id}:
43206     get:
43207       tags:
43208         - Network
43209       summary: returns generic-vnf
43210       description: returns generic-vnf
43211       operationId: getNetworkGenericVnfsGenericVnf
43212       produces:
43213         - application/json
43214         - application/xml
43215       responses:
43216         "200":
43217           description: successful operation
43218           schema:
43219               $ref: "#/getDefinitions/generic-vnf"
43220         "default":
43221           description: Response codes found in [response codes](https://wiki.onap.org/).
43222       parameters:
43223         - name: vnf-id
43224           in: path
43225           description: Unique id of VNF.  This is unique across the graph.
43226           required: true
43227           type: string
43228           example: __VNF-ID__
43229         - name: vnf-name
43230           in: query
43231           description: Name of VNF.
43232           required: false
43233           type: string
43234         - name: vnf-name2
43235           in: query
43236           description: Alternate name of VNF.
43237           required: false
43238           type: string
43239         - name: vnf-type
43240           in: query
43241           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.
43242           required: false
43243           type: string
43244         - name: service-id
43245           in: query
43246           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
43247           required: false
43248           type: string
43249         - name: regional-resource-zone
43250           in: query
43251           description: Regional way of organizing pservers, source of truth should define values
43252           required: false
43253           type: string
43254         - name: prov-status
43255           in: query
43256           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43257           required: false
43258           type: string
43259         - name: heat-stack-id
43260           in: query
43261           description: Heat stack id corresponding to this instance, managed by MSO
43262           required: false
43263           type: string
43264         - name: in-maint
43265           in: query
43266           required: false
43267           type: boolean
43268         - name: is-closed-loop-disabled
43269           in: query
43270           required: false
43271           type: boolean
43272         - name: model-invariant-id
43273           in: query
43274           description: the ASDC model id for this resource or service model.
43275           required: false
43276           type: string
43277         - name: model-version-id
43278           in: query
43279           description: the ASDC model version for this resource or service model.
43280           required: false
43281           type: string
43282         - name: widget-model-id
43283           in: query
43284           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43285           required: false
43286           type: string
43287         - name: widget-model-version
43288           in: query
43289           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43290           required: false
43291           type: string
43292         - name: nf-type
43293           in: query
43294           description: Generic description of the type of NF
43295           required: false
43296           type: string
43297         - name: nf-function
43298           in: query
43299           description: English description of Network function that the specific VNF deployment is providing
43300           required: false
43301           type: string
43302         - name: nf-role
43303           in: query
43304           description: role in the network that this model will be providing
43305           required: false
43306           type: string
43307         - name: nf-naming-code
43308           in: query
43309           description: string assigned to this model used for naming purposes
43310           required: false
43311           type: string
43312     put:
43313       tags:
43314         - Network
43315       summary: create or update an existing generic-vnf
43316       description: |
43317         Create or update an existing generic-vnf.
43318         #
43319         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43320       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
43321       consumes:
43322         - application/json
43323         - application/xml
43324       produces:
43325         - application/json
43326         - application/xml
43327       responses:
43328         "default":
43329           description: Response codes found in [response codes](https://wiki.onap.org/).
43330       parameters:
43331         - name: vnf-id
43332           in: path
43333           description: Unique id of VNF.  This is unique across the graph.
43334           required: true
43335           type: string
43336           example: __VNF-ID__
43337         - name: body
43338           in: body
43339           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
43340           required: true
43341           schema:
43342             $ref: "#/definitions/generic-vnf"
43343     patch:
43344       tags:
43345         - Network
43346       summary: update an existing generic-vnf
43347       description: |
43348         Update an existing generic-vnf
43349         #
43350         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43351         The PUT operation will entirely replace an existing object.
43352         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43353         #
43354         Other differences between PUT and PATCH are:
43355         #
43356         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43357         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43358         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43359       operationId: UpdateNetworkGenericVnfsGenericVnf
43360       consumes:
43361         - application/json
43362         - application/xml
43363       produces:
43364         - application/json
43365         - application/xml
43366       responses:
43367         "default":
43368           description: Response codes found in [response codes](https://wiki.onap.org/).
43369       parameters:
43370         - name: vnf-id
43371           in: path
43372           description: Unique id of VNF.  This is unique across the graph.
43373           required: true
43374           type: string
43375           example: __VNF-ID__
43376         - name: body
43377           in: body
43378           description: generic-vnf object that needs to be created or updated.
43379           required: true
43380           schema:
43381             $ref: "#/patchDefinitions/generic-vnf"
43382     delete:
43383       tags:
43384         - Network
43385       summary: delete an existing generic-vnf
43386       description: delete an existing generic-vnf
43387       operationId: deleteNetworkGenericVnfsGenericVnf
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-id
43399           in: path
43400           description: Unique id of VNF.  This is unique across the graph.
43401           required: true
43402           type: string
43403           example: __VNF-ID__
43404         - name: resource-version
43405           in: query
43406           description: resource-version for concurrency
43407           required: true
43408           type: string
43409   /network/generic-vnfs:
43410     get:
43411       tags:
43412         - Network
43413       summary: returns generic-vnfs
43414       description: returns generic-vnfs
43415       operationId: getNetworkGenericVnfs
43416       produces:
43417         - application/json
43418         - application/xml
43419       responses:
43420         "200":
43421           description: successful operation
43422           schema:
43423               $ref: "#/getDefinitions/generic-vnfs"
43424         "default":
43425           description: Response codes found in [response codes](https://wiki.onap.org/).
43426   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
43427     put:
43428       tags:
43429         - Network
43430       summary: see node definition for valid relationships
43431       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
43432       consumes:
43433         - application/json
43434         - application/xml
43435       produces:
43436         - application/json
43437         - application/xml
43438       responses:
43439         "default":
43440           description: Response codes found in [response codes](https://wiki.onap.org/).
43441       parameters:
43442         - name: link-name
43443           in: path
43444           description: Alphabetical concatenation of lag-interface names
43445           required: true
43446           type: string
43447           example: __LINK-NAME__
43448         - name: body
43449           in: body
43450           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
43451           required: true
43452           schema:
43453             $ref: "#/definitions/relationship"
43454     delete:
43455       tags:
43456         - Network
43457       summary: delete an existing relationship
43458       description: delete an existing relationship
43459       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
43460       consumes:
43461         - application/json
43462         - application/xml
43463       produces:
43464         - application/json
43465         - application/xml
43466       responses:
43467         "default":
43468           description: Response codes found in [response codes](https://wiki.onap.org/).
43469       parameters:
43470         - name: link-name
43471           in: path
43472           description: Alphabetical concatenation of lag-interface names
43473           required: true
43474           type: string
43475           example: __LINK-NAME__
43476   /network/lag-links/lag-link/{link-name}:
43477     get:
43478       tags:
43479         - Network
43480       summary: returns lag-link
43481       description: returns lag-link
43482       operationId: getNetworkLagLinksLagLink
43483       produces:
43484         - application/json
43485         - application/xml
43486       responses:
43487         "200":
43488           description: successful operation
43489           schema:
43490               $ref: "#/getDefinitions/lag-link"
43491         "default":
43492           description: Response codes found in [response codes](https://wiki.onap.org/).
43493       parameters:
43494         - name: link-name
43495           in: path
43496           description: Alphabetical concatenation of lag-interface names
43497           required: true
43498           type: string
43499           example: __LINK-NAME__
43500     put:
43501       tags:
43502         - Network
43503       summary: create or update an existing lag-link
43504       description: |
43505         Create or update an existing lag-link.
43506         #
43507         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43508       operationId: createOrUpdateNetworkLagLinksLagLink
43509       consumes:
43510         - application/json
43511         - application/xml
43512       produces:
43513         - application/json
43514         - application/xml
43515       responses:
43516         "default":
43517           description: Response codes found in [response codes](https://wiki.onap.org/).
43518       parameters:
43519         - name: link-name
43520           in: path
43521           description: Alphabetical concatenation of lag-interface names
43522           required: true
43523           type: string
43524           example: __LINK-NAME__
43525         - name: body
43526           in: body
43527           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
43528           required: true
43529           schema:
43530             $ref: "#/definitions/lag-link"
43531     patch:
43532       tags:
43533         - Network
43534       summary: update an existing lag-link
43535       description: |
43536         Update an existing lag-link
43537         #
43538         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43539         The PUT operation will entirely replace an existing object.
43540         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43541         #
43542         Other differences between PUT and PATCH are:
43543         #
43544         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43545         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43546         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43547       operationId: UpdateNetworkLagLinksLagLink
43548       consumes:
43549         - application/json
43550         - application/xml
43551       produces:
43552         - application/json
43553         - application/xml
43554       responses:
43555         "default":
43556           description: Response codes found in [response codes](https://wiki.onap.org/).
43557       parameters:
43558         - name: link-name
43559           in: path
43560           description: Alphabetical concatenation of lag-interface names
43561           required: true
43562           type: string
43563           example: __LINK-NAME__
43564         - name: body
43565           in: body
43566           description: lag-link object that needs to be created or updated.
43567           required: true
43568           schema:
43569             $ref: "#/patchDefinitions/lag-link"
43570     delete:
43571       tags:
43572         - Network
43573       summary: delete an existing lag-link
43574       description: delete an existing lag-link
43575       operationId: deleteNetworkLagLinksLagLink
43576       consumes:
43577         - application/json
43578         - application/xml
43579       produces:
43580         - application/json
43581         - application/xml
43582       responses:
43583         "default":
43584           description: Response codes found in [response codes](https://wiki.onap.org/).
43585       parameters:
43586         - name: link-name
43587           in: path
43588           description: Alphabetical concatenation of lag-interface names
43589           required: true
43590           type: string
43591           example: __LINK-NAME__
43592         - name: resource-version
43593           in: query
43594           description: resource-version for concurrency
43595           required: true
43596           type: string
43597   /network/lag-links:
43598     get:
43599       tags:
43600         - Network
43601       summary: returns lag-links
43602       description: returns lag-links
43603       operationId: getNetworkLagLinks
43604       produces:
43605         - application/json
43606         - application/xml
43607       responses:
43608         "200":
43609           description: successful operation
43610           schema:
43611               $ref: "#/getDefinitions/lag-links"
43612         "default":
43613           description: Response codes found in [response codes](https://wiki.onap.org/).
43614   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
43615     put:
43616       tags:
43617         - Network
43618       summary: see node definition for valid relationships
43619       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
43620       consumes:
43621         - application/json
43622         - application/xml
43623       produces:
43624         - application/json
43625         - application/xml
43626       responses:
43627         "default":
43628           description: Response codes found in [response codes](https://wiki.onap.org/).
43629       parameters:
43630         - name: vnf-id2
43631           in: path
43632           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43633           required: true
43634           type: string
43635           example: __VNF-ID2__
43636         - name: body
43637           in: body
43638           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
43639           required: true
43640           schema:
43641             $ref: "#/definitions/relationship"
43642     delete:
43643       tags:
43644         - Network
43645       summary: delete an existing relationship
43646       description: delete an existing relationship
43647       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
43648       consumes:
43649         - application/json
43650         - application/xml
43651       produces:
43652         - application/json
43653         - application/xml
43654       responses:
43655         "default":
43656           description: Response codes found in [response codes](https://wiki.onap.org/).
43657       parameters:
43658         - name: vnf-id2
43659           in: path
43660           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43661           required: true
43662           type: string
43663           example: __VNF-ID2__
43664   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
43665     put:
43666       tags:
43667         - Network
43668       summary: see node definition for valid relationships
43669       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43670       consumes:
43671         - application/json
43672         - application/xml
43673       produces:
43674         - application/json
43675         - application/xml
43676       responses:
43677         "default":
43678           description: Response codes found in [response codes](https://wiki.onap.org/).
43679       parameters:
43680         - name: vnf-id2
43681           in: path
43682           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43683           required: true
43684           type: string
43685           example: __VNF-ID2__
43686         - name: interface-name
43687           in: path
43688           description: Name given to the interface
43689           required: true
43690           type: string
43691           example: __INTERFACE-NAME__
43692         - name: vlan-interface
43693           in: path
43694           description: String that identifies the interface
43695           required: true
43696           type: string
43697           example: __VLAN-INTERFACE__
43698         - name: body
43699           in: body
43700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
43701           required: true
43702           schema:
43703             $ref: "#/definitions/relationship"
43704     delete:
43705       tags:
43706         - Network
43707       summary: delete an existing relationship
43708       description: delete an existing relationship
43709       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43710       consumes:
43711         - application/json
43712         - application/xml
43713       produces:
43714         - application/json
43715         - application/xml
43716       responses:
43717         "default":
43718           description: Response codes found in [response codes](https://wiki.onap.org/).
43719       parameters:
43720         - name: vnf-id2
43721           in: path
43722           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43723           required: true
43724           type: string
43725           example: __VNF-ID2__
43726         - name: interface-name
43727           in: path
43728           description: Name given to the interface
43729           required: true
43730           type: string
43731           example: __INTERFACE-NAME__
43732         - name: vlan-interface
43733           in: path
43734           description: String that identifies the interface
43735           required: true
43736           type: string
43737           example: __VLAN-INTERFACE__
43738   /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:
43739     put:
43740       tags:
43741         - Network
43742       summary: see node definition for valid relationships
43743       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43744       consumes:
43745         - application/json
43746         - application/xml
43747       produces:
43748         - application/json
43749         - application/xml
43750       responses:
43751         "default":
43752           description: Response codes found in [response codes](https://wiki.onap.org/).
43753       parameters:
43754         - name: vnf-id2
43755           in: path
43756           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43757           required: true
43758           type: string
43759           example: __VNF-ID2__
43760         - name: interface-name
43761           in: path
43762           description: Name given to the interface
43763           required: true
43764           type: string
43765           example: __INTERFACE-NAME__
43766         - name: vlan-interface
43767           in: path
43768           description: String that identifies the interface
43769           required: true
43770           type: string
43771           example: __VLAN-INTERFACE__
43772         - name: l3-interface-ipv4-address
43773           in: path
43774           description: IP address
43775           required: true
43776           type: string
43777           example: __L3-INTERFACE-IPV4-ADDRESS__
43778         - name: body
43779           in: body
43780           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43781           required: true
43782           schema:
43783             $ref: "#/definitions/relationship"
43784     delete:
43785       tags:
43786         - Network
43787       summary: delete an existing relationship
43788       description: delete an existing relationship
43789       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43790       consumes:
43791         - application/json
43792         - application/xml
43793       produces:
43794         - application/json
43795         - application/xml
43796       responses:
43797         "default":
43798           description: Response codes found in [response codes](https://wiki.onap.org/).
43799       parameters:
43800         - name: vnf-id2
43801           in: path
43802           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43803           required: true
43804           type: string
43805           example: __VNF-ID2__
43806         - name: interface-name
43807           in: path
43808           description: Name given to the interface
43809           required: true
43810           type: string
43811           example: __INTERFACE-NAME__
43812         - name: vlan-interface
43813           in: path
43814           description: String that identifies the interface
43815           required: true
43816           type: string
43817           example: __VLAN-INTERFACE__
43818         - name: l3-interface-ipv4-address
43819           in: path
43820           description: IP address
43821           required: true
43822           type: string
43823           example: __L3-INTERFACE-IPV4-ADDRESS__
43824   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43825     get:
43826       tags:
43827         - Network
43828       summary: returns l3-interface-ipv4-address-list
43829       description: returns l3-interface-ipv4-address-list
43830       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43831       produces:
43832         - application/json
43833         - application/xml
43834       responses:
43835         "200":
43836           description: successful operation
43837           schema:
43838               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43839         "default":
43840           description: Response codes found in [response codes](https://wiki.onap.org/).
43841       parameters:
43842         - name: vnf-id2
43843           in: path
43844           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43845           required: true
43846           type: string
43847           example: __VNF-ID2__
43848         - name: interface-name
43849           in: path
43850           description: Name given to the interface
43851           required: true
43852           type: string
43853           example: __INTERFACE-NAME__
43854         - name: vlan-interface
43855           in: path
43856           description: String that identifies the interface
43857           required: true
43858           type: string
43859           example: __VLAN-INTERFACE__
43860         - name: l3-interface-ipv4-address
43861           in: path
43862           description: IP address
43863           required: true
43864           type: string
43865           example: __L3-INTERFACE-IPV4-ADDRESS__
43866         - name: vnf-name
43867           in: query
43868           description: Name of VNF.
43869           required: false
43870           type: string
43871         - name: vnf-name2
43872           in: query
43873           description: Alternate name of VNF.
43874           required: false
43875           type: string
43876         - name: vnf-type
43877           in: query
43878           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.
43879           required: false
43880           type: string
43881         - name: prov-status
43882           in: query
43883           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43884           required: false
43885           type: string
43886         - name: heat-stack-id
43887           in: query
43888           description: Heat stack id corresponding to this instance, managed by MSO
43889           required: false
43890           type: string
43891         - name: interface-id
43892           in: query
43893           description: ID of interface
43894           required: false
43895           type: string
43896         - name: macaddr
43897           in: query
43898           description: MAC address for the interface
43899           required: false
43900           type: string
43901         - name: network-name
43902           in: query
43903           description: Name of the network
43904           required: false
43905           type: string
43906         - name: vlan-id-inner
43907           in: query
43908           description: Inner VLAN tag
43909           required: false
43910           type: integer
43911           format: int64
43912         - name: vpn-key
43913           in: query
43914           description: This indicates the customers VPN ID associated with this vlan
43915           required: false
43916           type: string
43917         - name: vlan-id-inner
43918           in: query
43919           description: Inner VLAN tag
43920           required: false
43921           type: integer
43922           format: int64
43923         - name: neutron-network-id
43924           in: query
43925           description: Neutron network id of the interface that address belongs to
43926           required: false
43927           type: string
43928         - name: neutron-subnet-id
43929           in: query
43930           description: Neutron id of subnet that address belongs to
43931           required: false
43932           type: string
43933     put:
43934       tags:
43935         - Network
43936       summary: create or update an existing l3-interface-ipv4-address-list
43937       description: |
43938         Create or update an existing l3-interface-ipv4-address-list.
43939         #
43940         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43941       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43942       consumes:
43943         - application/json
43944         - application/xml
43945       produces:
43946         - application/json
43947         - application/xml
43948       responses:
43949         "default":
43950           description: Response codes found in [response codes](https://wiki.onap.org/).
43951       parameters:
43952         - name: vnf-id2
43953           in: path
43954           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43955           required: true
43956           type: string
43957           example: __VNF-ID2__
43958         - name: interface-name
43959           in: path
43960           description: Name given to the interface
43961           required: true
43962           type: string
43963           example: __INTERFACE-NAME__
43964         - name: vlan-interface
43965           in: path
43966           description: String that identifies the interface
43967           required: true
43968           type: string
43969           example: __VLAN-INTERFACE__
43970         - name: l3-interface-ipv4-address
43971           in: path
43972           description: IP address
43973           required: true
43974           type: string
43975           example: __L3-INTERFACE-IPV4-ADDRESS__
43976         - name: body
43977           in: body
43978           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43979           required: true
43980           schema:
43981             $ref: "#/definitions/l3-interface-ipv4-address-list"
43982     patch:
43983       tags:
43984         - Network
43985       summary: update an existing l3-interface-ipv4-address-list
43986       description: |
43987         Update an existing l3-interface-ipv4-address-list
43988         #
43989         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43990         The PUT operation will entirely replace an existing object.
43991         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43992         #
43993         Other differences between PUT and PATCH are:
43994         #
43995         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43996         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43997         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43998       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43999       consumes:
44000         - application/json
44001         - application/xml
44002       produces:
44003         - application/json
44004         - application/xml
44005       responses:
44006         "default":
44007           description: Response codes found in [response codes](https://wiki.onap.org/).
44008       parameters:
44009         - name: vnf-id2
44010           in: path
44011           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44012           required: true
44013           type: string
44014           example: __VNF-ID2__
44015         - name: interface-name
44016           in: path
44017           description: Name given to the interface
44018           required: true
44019           type: string
44020           example: __INTERFACE-NAME__
44021         - name: vlan-interface
44022           in: path
44023           description: String that identifies the interface
44024           required: true
44025           type: string
44026           example: __VLAN-INTERFACE__
44027         - name: l3-interface-ipv4-address
44028           in: path
44029           description: IP address
44030           required: true
44031           type: string
44032           example: __L3-INTERFACE-IPV4-ADDRESS__
44033         - name: body
44034           in: body
44035           description: l3-interface-ipv4-address-list object that needs to be created or updated.
44036           required: true
44037           schema:
44038             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
44039     delete:
44040       tags:
44041         - Network
44042       summary: delete an existing l3-interface-ipv4-address-list
44043       description: delete an existing l3-interface-ipv4-address-list
44044       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44045       consumes:
44046         - application/json
44047         - application/xml
44048       produces:
44049         - application/json
44050         - application/xml
44051       responses:
44052         "default":
44053           description: Response codes found in [response codes](https://wiki.onap.org/).
44054       parameters:
44055         - name: vnf-id2
44056           in: path
44057           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44058           required: true
44059           type: string
44060           example: __VNF-ID2__
44061         - name: interface-name
44062           in: path
44063           description: Name given to the interface
44064           required: true
44065           type: string
44066           example: __INTERFACE-NAME__
44067         - name: vlan-interface
44068           in: path
44069           description: String that identifies the interface
44070           required: true
44071           type: string
44072           example: __VLAN-INTERFACE__
44073         - name: l3-interface-ipv4-address
44074           in: path
44075           description: IP address
44076           required: true
44077           type: string
44078           example: __L3-INTERFACE-IPV4-ADDRESS__
44079         - name: resource-version
44080           in: query
44081           description: resource-version for concurrency
44082           required: true
44083           type: string
44084   /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:
44085     put:
44086       tags:
44087         - Network
44088       summary: see node definition for valid relationships
44089       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44090       consumes:
44091         - application/json
44092         - application/xml
44093       produces:
44094         - application/json
44095         - application/xml
44096       responses:
44097         "default":
44098           description: Response codes found in [response codes](https://wiki.onap.org/).
44099       parameters:
44100         - name: vnf-id2
44101           in: path
44102           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44103           required: true
44104           type: string
44105           example: __VNF-ID2__
44106         - name: interface-name
44107           in: path
44108           description: Name given to the interface
44109           required: true
44110           type: string
44111           example: __INTERFACE-NAME__
44112         - name: vlan-interface
44113           in: path
44114           description: String that identifies the interface
44115           required: true
44116           type: string
44117           example: __VLAN-INTERFACE__
44118         - name: l3-interface-ipv6-address
44119           in: path
44120           description: IP address
44121           required: true
44122           type: string
44123           example: __L3-INTERFACE-IPV6-ADDRESS__
44124         - name: body
44125           in: body
44126           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44127           required: true
44128           schema:
44129             $ref: "#/definitions/relationship"
44130     delete:
44131       tags:
44132         - Network
44133       summary: delete an existing relationship
44134       description: delete an existing relationship
44135       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44136       consumes:
44137         - application/json
44138         - application/xml
44139       produces:
44140         - application/json
44141         - application/xml
44142       responses:
44143         "default":
44144           description: Response codes found in [response codes](https://wiki.onap.org/).
44145       parameters:
44146         - name: vnf-id2
44147           in: path
44148           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44149           required: true
44150           type: string
44151           example: __VNF-ID2__
44152         - name: interface-name
44153           in: path
44154           description: Name given to the interface
44155           required: true
44156           type: string
44157           example: __INTERFACE-NAME__
44158         - name: vlan-interface
44159           in: path
44160           description: String that identifies the interface
44161           required: true
44162           type: string
44163           example: __VLAN-INTERFACE__
44164         - name: l3-interface-ipv6-address
44165           in: path
44166           description: IP address
44167           required: true
44168           type: string
44169           example: __L3-INTERFACE-IPV6-ADDRESS__
44170   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
44171     get:
44172       tags:
44173         - Network
44174       summary: returns l3-interface-ipv6-address-list
44175       description: returns l3-interface-ipv6-address-list
44176       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44177       produces:
44178         - application/json
44179         - application/xml
44180       responses:
44181         "200":
44182           description: successful operation
44183           schema:
44184               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
44185         "default":
44186           description: Response codes found in [response codes](https://wiki.onap.org/).
44187       parameters:
44188         - name: vnf-id2
44189           in: path
44190           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44191           required: true
44192           type: string
44193           example: __VNF-ID2__
44194         - name: interface-name
44195           in: path
44196           description: Name given to the interface
44197           required: true
44198           type: string
44199           example: __INTERFACE-NAME__
44200         - name: vlan-interface
44201           in: path
44202           description: String that identifies the interface
44203           required: true
44204           type: string
44205           example: __VLAN-INTERFACE__
44206         - name: l3-interface-ipv6-address
44207           in: path
44208           description: IP address
44209           required: true
44210           type: string
44211           example: __L3-INTERFACE-IPV6-ADDRESS__
44212         - name: vnf-name
44213           in: query
44214           description: Name of VNF.
44215           required: false
44216           type: string
44217         - name: vnf-name2
44218           in: query
44219           description: Alternate name of VNF.
44220           required: false
44221           type: string
44222         - name: vnf-type
44223           in: query
44224           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.
44225           required: false
44226           type: string
44227         - name: prov-status
44228           in: query
44229           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44230           required: false
44231           type: string
44232         - name: heat-stack-id
44233           in: query
44234           description: Heat stack id corresponding to this instance, managed by MSO
44235           required: false
44236           type: string
44237         - name: interface-id
44238           in: query
44239           description: ID of interface
44240           required: false
44241           type: string
44242         - name: macaddr
44243           in: query
44244           description: MAC address for the interface
44245           required: false
44246           type: string
44247         - name: network-name
44248           in: query
44249           description: Name of the network
44250           required: false
44251           type: string
44252         - name: vlan-id-inner
44253           in: query
44254           description: Inner VLAN tag
44255           required: false
44256           type: integer
44257           format: int64
44258         - name: vpn-key
44259           in: query
44260           description: This indicates the customers VPN ID associated with this vlan
44261           required: false
44262           type: string
44263         - name: vlan-id-inner
44264           in: query
44265           description: Inner VLAN tag
44266           required: false
44267           type: integer
44268           format: int64
44269         - name: neutron-network-id
44270           in: query
44271           description: Neutron network id of the interface that address belongs to
44272           required: false
44273           type: string
44274         - name: neutron-subnet-id
44275           in: query
44276           description: Neutron id of subnet that address belongs to
44277           required: false
44278           type: string
44279     put:
44280       tags:
44281         - Network
44282       summary: create or update an existing l3-interface-ipv6-address-list
44283       description: |
44284         Create or update an existing l3-interface-ipv6-address-list.
44285         #
44286         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44287       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44288       consumes:
44289         - application/json
44290         - application/xml
44291       produces:
44292         - application/json
44293         - application/xml
44294       responses:
44295         "default":
44296           description: Response codes found in [response codes](https://wiki.onap.org/).
44297       parameters:
44298         - name: vnf-id2
44299           in: path
44300           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44301           required: true
44302           type: string
44303           example: __VNF-ID2__
44304         - name: interface-name
44305           in: path
44306           description: Name given to the interface
44307           required: true
44308           type: string
44309           example: __INTERFACE-NAME__
44310         - name: vlan-interface
44311           in: path
44312           description: String that identifies the interface
44313           required: true
44314           type: string
44315           example: __VLAN-INTERFACE__
44316         - name: l3-interface-ipv6-address
44317           in: path
44318           description: IP address
44319           required: true
44320           type: string
44321           example: __L3-INTERFACE-IPV6-ADDRESS__
44322         - name: body
44323           in: body
44324           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44325           required: true
44326           schema:
44327             $ref: "#/definitions/l3-interface-ipv6-address-list"
44328     patch:
44329       tags:
44330         - Network
44331       summary: update an existing l3-interface-ipv6-address-list
44332       description: |
44333         Update an existing l3-interface-ipv6-address-list
44334         #
44335         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44336         The PUT operation will entirely replace an existing object.
44337         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44338         #
44339         Other differences between PUT and PATCH are:
44340         #
44341         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44342         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44343         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44344       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44345       consumes:
44346         - application/json
44347         - application/xml
44348       produces:
44349         - application/json
44350         - application/xml
44351       responses:
44352         "default":
44353           description: Response codes found in [response codes](https://wiki.onap.org/).
44354       parameters:
44355         - name: vnf-id2
44356           in: path
44357           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44358           required: true
44359           type: string
44360           example: __VNF-ID2__
44361         - name: interface-name
44362           in: path
44363           description: Name given to the interface
44364           required: true
44365           type: string
44366           example: __INTERFACE-NAME__
44367         - name: vlan-interface
44368           in: path
44369           description: String that identifies the interface
44370           required: true
44371           type: string
44372           example: __VLAN-INTERFACE__
44373         - name: l3-interface-ipv6-address
44374           in: path
44375           description: IP address
44376           required: true
44377           type: string
44378           example: __L3-INTERFACE-IPV6-ADDRESS__
44379         - name: body
44380           in: body
44381           description: l3-interface-ipv6-address-list object that needs to be created or updated.
44382           required: true
44383           schema:
44384             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44385     delete:
44386       tags:
44387         - Network
44388       summary: delete an existing l3-interface-ipv6-address-list
44389       description: delete an existing l3-interface-ipv6-address-list
44390       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44391       consumes:
44392         - application/json
44393         - application/xml
44394       produces:
44395         - application/json
44396         - application/xml
44397       responses:
44398         "default":
44399           description: Response codes found in [response codes](https://wiki.onap.org/).
44400       parameters:
44401         - name: vnf-id2
44402           in: path
44403           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44404           required: true
44405           type: string
44406           example: __VNF-ID2__
44407         - name: interface-name
44408           in: path
44409           description: Name given to the interface
44410           required: true
44411           type: string
44412           example: __INTERFACE-NAME__
44413         - name: vlan-interface
44414           in: path
44415           description: String that identifies the interface
44416           required: true
44417           type: string
44418           example: __VLAN-INTERFACE__
44419         - name: l3-interface-ipv6-address
44420           in: path
44421           description: IP address
44422           required: true
44423           type: string
44424           example: __L3-INTERFACE-IPV6-ADDRESS__
44425         - name: resource-version
44426           in: query
44427           description: resource-version for concurrency
44428           required: true
44429           type: string
44430   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
44431     get:
44432       tags:
44433         - Network
44434       summary: returns vlan
44435       description: returns vlan
44436       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44437       produces:
44438         - application/json
44439         - application/xml
44440       responses:
44441         "200":
44442           description: successful operation
44443           schema:
44444               $ref: "#/getDefinitions/vlan"
44445         "default":
44446           description: Response codes found in [response codes](https://wiki.onap.org/).
44447       parameters:
44448         - name: vnf-id2
44449           in: path
44450           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44451           required: true
44452           type: string
44453           example: __VNF-ID2__
44454         - name: interface-name
44455           in: path
44456           description: Name given to the interface
44457           required: true
44458           type: string
44459           example: __INTERFACE-NAME__
44460         - name: vlan-interface
44461           in: path
44462           description: String that identifies the interface
44463           required: true
44464           type: string
44465           example: __VLAN-INTERFACE__
44466         - name: vnf-name
44467           in: query
44468           description: Name of VNF.
44469           required: false
44470           type: string
44471         - name: vnf-name2
44472           in: query
44473           description: Alternate name of VNF.
44474           required: false
44475           type: string
44476         - name: vnf-type
44477           in: query
44478           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.
44479           required: false
44480           type: string
44481         - name: prov-status
44482           in: query
44483           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44484           required: false
44485           type: string
44486         - name: heat-stack-id
44487           in: query
44488           description: Heat stack id corresponding to this instance, managed by MSO
44489           required: false
44490           type: string
44491         - name: interface-id
44492           in: query
44493           description: ID of interface
44494           required: false
44495           type: string
44496         - name: macaddr
44497           in: query
44498           description: MAC address for the interface
44499           required: false
44500           type: string
44501         - name: network-name
44502           in: query
44503           description: Name of the network
44504           required: false
44505           type: string
44506         - name: vlan-id-inner
44507           in: query
44508           description: Inner VLAN tag
44509           required: false
44510           type: integer
44511           format: int64
44512         - name: vpn-key
44513           in: query
44514           description: This indicates the customers VPN ID associated with this vlan
44515           required: false
44516           type: string
44517     put:
44518       tags:
44519         - Network
44520       summary: create or update an existing vlan
44521       description: |
44522         Create or update an existing vlan.
44523         #
44524         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44525       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44526       consumes:
44527         - application/json
44528         - application/xml
44529       produces:
44530         - application/json
44531         - application/xml
44532       responses:
44533         "default":
44534           description: Response codes found in [response codes](https://wiki.onap.org/).
44535       parameters:
44536         - name: vnf-id2
44537           in: path
44538           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44539           required: true
44540           type: string
44541           example: __VNF-ID2__
44542         - name: interface-name
44543           in: path
44544           description: Name given to the interface
44545           required: true
44546           type: string
44547           example: __INTERFACE-NAME__
44548         - name: vlan-interface
44549           in: path
44550           description: String that identifies the interface
44551           required: true
44552           type: string
44553           example: __VLAN-INTERFACE__
44554         - name: body
44555           in: body
44556           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
44557           required: true
44558           schema:
44559             $ref: "#/definitions/vlan"
44560     patch:
44561       tags:
44562         - Network
44563       summary: update an existing vlan
44564       description: |
44565         Update an existing vlan
44566         #
44567         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44568         The PUT operation will entirely replace an existing object.
44569         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44570         #
44571         Other differences between PUT and PATCH are:
44572         #
44573         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44574         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44575         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44576       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44577       consumes:
44578         - application/json
44579         - application/xml
44580       produces:
44581         - application/json
44582         - application/xml
44583       responses:
44584         "default":
44585           description: Response codes found in [response codes](https://wiki.onap.org/).
44586       parameters:
44587         - name: vnf-id2
44588           in: path
44589           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44590           required: true
44591           type: string
44592           example: __VNF-ID2__
44593         - name: interface-name
44594           in: path
44595           description: Name given to the interface
44596           required: true
44597           type: string
44598           example: __INTERFACE-NAME__
44599         - name: vlan-interface
44600           in: path
44601           description: String that identifies the interface
44602           required: true
44603           type: string
44604           example: __VLAN-INTERFACE__
44605         - name: body
44606           in: body
44607           description: vlan object that needs to be created or updated.
44608           required: true
44609           schema:
44610             $ref: "#/patchDefinitions/vlan"
44611     delete:
44612       tags:
44613         - Network
44614       summary: delete an existing vlan
44615       description: delete an existing vlan
44616       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44617       consumes:
44618         - application/json
44619         - application/xml
44620       produces:
44621         - application/json
44622         - application/xml
44623       responses:
44624         "default":
44625           description: Response codes found in [response codes](https://wiki.onap.org/).
44626       parameters:
44627         - name: vnf-id2
44628           in: path
44629           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44630           required: true
44631           type: string
44632           example: __VNF-ID2__
44633         - name: interface-name
44634           in: path
44635           description: Name given to the interface
44636           required: true
44637           type: string
44638           example: __INTERFACE-NAME__
44639         - name: vlan-interface
44640           in: path
44641           description: String that identifies the interface
44642           required: true
44643           type: string
44644           example: __VLAN-INTERFACE__
44645         - name: resource-version
44646           in: query
44647           description: resource-version for concurrency
44648           required: true
44649           type: string
44650   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
44651     get:
44652       tags:
44653         - Network
44654       summary: returns vlans
44655       description: returns vlans
44656       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
44657       produces:
44658         - application/json
44659         - application/xml
44660       responses:
44661         "200":
44662           description: successful operation
44663           schema:
44664               $ref: "#/getDefinitions/vlans"
44665         "default":
44666           description: Response codes found in [response codes](https://wiki.onap.org/).
44667       parameters:
44668         - name: vnf-id2
44669           in: path
44670           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44671           required: true
44672           type: string
44673           example: __VNF-ID2__
44674         - name: interface-name
44675           in: path
44676           description: Name given to the interface
44677           required: true
44678           type: string
44679           example: __INTERFACE-NAME__
44680         - name: vnf-name
44681           in: query
44682           description: Name of VNF.
44683           required: false
44684           type: string
44685         - name: vnf-name2
44686           in: query
44687           description: Alternate name of VNF.
44688           required: false
44689           type: string
44690         - name: vnf-type
44691           in: query
44692           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.
44693           required: false
44694           type: string
44695         - name: prov-status
44696           in: query
44697           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44698           required: false
44699           type: string
44700         - name: heat-stack-id
44701           in: query
44702           description: Heat stack id corresponding to this instance, managed by MSO
44703           required: false
44704           type: string
44705         - name: interface-id
44706           in: query
44707           description: ID of interface
44708           required: false
44709           type: string
44710         - name: macaddr
44711           in: query
44712           description: MAC address for the interface
44713           required: false
44714           type: string
44715         - name: network-name
44716           in: query
44717           description: Name of the network
44718           required: false
44719           type: string
44720   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
44721     put:
44722       tags:
44723         - Network
44724       summary: see node definition for valid relationships
44725       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44726       consumes:
44727         - application/json
44728         - application/xml
44729       produces:
44730         - application/json
44731         - application/xml
44732       responses:
44733         "default":
44734           description: Response codes found in [response codes](https://wiki.onap.org/).
44735       parameters:
44736         - name: vnf-id2
44737           in: path
44738           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44739           required: true
44740           type: string
44741           example: __VNF-ID2__
44742         - name: interface-name
44743           in: path
44744           description: Name given to the interface
44745           required: true
44746           type: string
44747           example: __INTERFACE-NAME__
44748         - name: pci-id
44749           in: path
44750           description: PCI ID used to identify the sriov-vf
44751           required: true
44752           type: string
44753           example: __PCI-ID__
44754         - name: body
44755           in: body
44756           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
44757           required: true
44758           schema:
44759             $ref: "#/definitions/relationship"
44760     delete:
44761       tags:
44762         - Network
44763       summary: delete an existing relationship
44764       description: delete an existing relationship
44765       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44766       consumes:
44767         - application/json
44768         - application/xml
44769       produces:
44770         - application/json
44771         - application/xml
44772       responses:
44773         "default":
44774           description: Response codes found in [response codes](https://wiki.onap.org/).
44775       parameters:
44776         - name: vnf-id2
44777           in: path
44778           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44779           required: true
44780           type: string
44781           example: __VNF-ID2__
44782         - name: interface-name
44783           in: path
44784           description: Name given to the interface
44785           required: true
44786           type: string
44787           example: __INTERFACE-NAME__
44788         - name: pci-id
44789           in: path
44790           description: PCI ID used to identify the sriov-vf
44791           required: true
44792           type: string
44793           example: __PCI-ID__
44794   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
44795     get:
44796       tags:
44797         - Network
44798       summary: returns sriov-vf
44799       description: returns sriov-vf
44800       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44801       produces:
44802         - application/json
44803         - application/xml
44804       responses:
44805         "200":
44806           description: successful operation
44807           schema:
44808               $ref: "#/getDefinitions/sriov-vf"
44809         "default":
44810           description: Response codes found in [response codes](https://wiki.onap.org/).
44811       parameters:
44812         - name: vnf-id2
44813           in: path
44814           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44815           required: true
44816           type: string
44817           example: __VNF-ID2__
44818         - name: interface-name
44819           in: path
44820           description: Name given to the interface
44821           required: true
44822           type: string
44823           example: __INTERFACE-NAME__
44824         - name: pci-id
44825           in: path
44826           description: PCI ID used to identify the sriov-vf
44827           required: true
44828           type: string
44829           example: __PCI-ID__
44830         - name: vnf-name
44831           in: query
44832           description: Name of VNF.
44833           required: false
44834           type: string
44835         - name: vnf-name2
44836           in: query
44837           description: Alternate name of VNF.
44838           required: false
44839           type: string
44840         - name: vnf-type
44841           in: query
44842           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.
44843           required: false
44844           type: string
44845         - name: prov-status
44846           in: query
44847           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44848           required: false
44849           type: string
44850         - name: heat-stack-id
44851           in: query
44852           description: Heat stack id corresponding to this instance, managed by MSO
44853           required: false
44854           type: string
44855         - name: interface-id
44856           in: query
44857           description: ID of interface
44858           required: false
44859           type: string
44860         - name: macaddr
44861           in: query
44862           description: MAC address for the interface
44863           required: false
44864           type: string
44865         - name: network-name
44866           in: query
44867           description: Name of the network
44868           required: false
44869           type: string
44870         - name: vf-vlan-filter
44871           in: query
44872           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
44873           required: false
44874           type: string
44875         - name: vf-mac-filter
44876           in: query
44877           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
44878           required: false
44879           type: string
44880         - name: vf-vlan-strip
44881           in: query
44882           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
44883           required: false
44884           type: boolean
44885         - name: neutron-network-id
44886           in: query
44887           description: Neutron network id of the interface
44888           required: false
44889           type: string
44890     put:
44891       tags:
44892         - Network
44893       summary: create or update an existing sriov-vf
44894       description: |
44895         Create or update an existing sriov-vf.
44896         #
44897         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44898       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44899       consumes:
44900         - application/json
44901         - application/xml
44902       produces:
44903         - application/json
44904         - application/xml
44905       responses:
44906         "default":
44907           description: Response codes found in [response codes](https://wiki.onap.org/).
44908       parameters:
44909         - name: vnf-id2
44910           in: path
44911           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44912           required: true
44913           type: string
44914           example: __VNF-ID2__
44915         - name: interface-name
44916           in: path
44917           description: Name given to the interface
44918           required: true
44919           type: string
44920           example: __INTERFACE-NAME__
44921         - name: pci-id
44922           in: path
44923           description: PCI ID used to identify the sriov-vf
44924           required: true
44925           type: string
44926           example: __PCI-ID__
44927         - name: body
44928           in: body
44929           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
44930           required: true
44931           schema:
44932             $ref: "#/definitions/sriov-vf"
44933     patch:
44934       tags:
44935         - Network
44936       summary: update an existing sriov-vf
44937       description: |
44938         Update an existing sriov-vf
44939         #
44940         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44941         The PUT operation will entirely replace an existing object.
44942         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44943         #
44944         Other differences between PUT and PATCH are:
44945         #
44946         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44947         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44948         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44949       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44950       consumes:
44951         - application/json
44952         - application/xml
44953       produces:
44954         - application/json
44955         - application/xml
44956       responses:
44957         "default":
44958           description: Response codes found in [response codes](https://wiki.onap.org/).
44959       parameters:
44960         - name: vnf-id2
44961           in: path
44962           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44963           required: true
44964           type: string
44965           example: __VNF-ID2__
44966         - name: interface-name
44967           in: path
44968           description: Name given to the interface
44969           required: true
44970           type: string
44971           example: __INTERFACE-NAME__
44972         - name: pci-id
44973           in: path
44974           description: PCI ID used to identify the sriov-vf
44975           required: true
44976           type: string
44977           example: __PCI-ID__
44978         - name: body
44979           in: body
44980           description: sriov-vf object that needs to be created or updated.
44981           required: true
44982           schema:
44983             $ref: "#/patchDefinitions/sriov-vf"
44984     delete:
44985       tags:
44986         - Network
44987       summary: delete an existing sriov-vf
44988       description: delete an existing sriov-vf
44989       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44990       consumes:
44991         - application/json
44992         - application/xml
44993       produces:
44994         - application/json
44995         - application/xml
44996       responses:
44997         "default":
44998           description: Response codes found in [response codes](https://wiki.onap.org/).
44999       parameters:
45000         - name: vnf-id2
45001           in: path
45002           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45003           required: true
45004           type: string
45005           example: __VNF-ID2__
45006         - name: interface-name
45007           in: path
45008           description: Name given to the interface
45009           required: true
45010           type: string
45011           example: __INTERFACE-NAME__
45012         - name: pci-id
45013           in: path
45014           description: PCI ID used to identify the sriov-vf
45015           required: true
45016           type: string
45017           example: __PCI-ID__
45018         - name: resource-version
45019           in: query
45020           description: resource-version for concurrency
45021           required: true
45022           type: string
45023   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
45024     get:
45025       tags:
45026         - Network
45027       summary: returns sriov-vfs
45028       description: returns sriov-vfs
45029       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
45030       produces:
45031         - application/json
45032         - application/xml
45033       responses:
45034         "200":
45035           description: successful operation
45036           schema:
45037               $ref: "#/getDefinitions/sriov-vfs"
45038         "default":
45039           description: Response codes found in [response codes](https://wiki.onap.org/).
45040       parameters:
45041         - name: vnf-id2
45042           in: path
45043           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45044           required: true
45045           type: string
45046           example: __VNF-ID2__
45047         - name: interface-name
45048           in: path
45049           description: Name given to the interface
45050           required: true
45051           type: string
45052           example: __INTERFACE-NAME__
45053         - name: vnf-name
45054           in: query
45055           description: Name of VNF.
45056           required: false
45057           type: string
45058         - name: vnf-name2
45059           in: query
45060           description: Alternate name of VNF.
45061           required: false
45062           type: string
45063         - name: vnf-type
45064           in: query
45065           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.
45066           required: false
45067           type: string
45068         - name: prov-status
45069           in: query
45070           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45071           required: false
45072           type: string
45073         - name: heat-stack-id
45074           in: query
45075           description: Heat stack id corresponding to this instance, managed by MSO
45076           required: false
45077           type: string
45078         - name: interface-id
45079           in: query
45080           description: ID of interface
45081           required: false
45082           type: string
45083         - name: macaddr
45084           in: query
45085           description: MAC address for the interface
45086           required: false
45087           type: string
45088         - name: network-name
45089           in: query
45090           description: Name of the network
45091           required: false
45092           type: string
45093   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
45094     put:
45095       tags:
45096         - Network
45097       summary: see node definition for valid relationships
45098       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
45099       consumes:
45100         - application/json
45101         - application/xml
45102       produces:
45103         - application/json
45104         - application/xml
45105       responses:
45106         "default":
45107           description: Response codes found in [response codes](https://wiki.onap.org/).
45108       parameters:
45109         - name: vnf-id2
45110           in: path
45111           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45112           required: true
45113           type: string
45114           example: __VNF-ID2__
45115         - name: interface-name
45116           in: path
45117           description: Name given to the interface
45118           required: true
45119           type: string
45120           example: __INTERFACE-NAME__
45121         - name: body
45122           in: body
45123           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
45124           required: true
45125           schema:
45126             $ref: "#/definitions/relationship"
45127     delete:
45128       tags:
45129         - Network
45130       summary: delete an existing relationship
45131       description: delete an existing relationship
45132       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
45133       consumes:
45134         - application/json
45135         - application/xml
45136       produces:
45137         - application/json
45138         - application/xml
45139       responses:
45140         "default":
45141           description: Response codes found in [response codes](https://wiki.onap.org/).
45142       parameters:
45143         - name: vnf-id2
45144           in: path
45145           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45146           required: true
45147           type: string
45148           example: __VNF-ID2__
45149         - name: interface-name
45150           in: path
45151           description: Name given to the interface
45152           required: true
45153           type: string
45154           example: __INTERFACE-NAME__
45155   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
45156     put:
45157       tags:
45158         - Network
45159       summary: see node definition for valid relationships
45160       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
45161       consumes:
45162         - application/json
45163         - application/xml
45164       produces:
45165         - application/json
45166         - application/xml
45167       responses:
45168         "default":
45169           description: Response codes found in [response codes](https://wiki.onap.org/).
45170       parameters:
45171         - name: vnf-id2
45172           in: path
45173           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45174           required: true
45175           type: string
45176           example: __VNF-ID2__
45177         - name: interface-name
45178           in: path
45179           description: Name given to the interface
45180           required: true
45181           type: string
45182           example: __INTERFACE-NAME__
45183         - name: l3-interface-ipv4-address
45184           in: path
45185           description: IP address
45186           required: true
45187           type: string
45188           example: __L3-INTERFACE-IPV4-ADDRESS__
45189         - name: body
45190           in: body
45191           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45192           required: true
45193           schema:
45194             $ref: "#/definitions/relationship"
45195     delete:
45196       tags:
45197         - Network
45198       summary: delete an existing relationship
45199       description: delete an existing relationship
45200       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
45201       consumes:
45202         - application/json
45203         - application/xml
45204       produces:
45205         - application/json
45206         - application/xml
45207       responses:
45208         "default":
45209           description: Response codes found in [response codes](https://wiki.onap.org/).
45210       parameters:
45211         - name: vnf-id2
45212           in: path
45213           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45214           required: true
45215           type: string
45216           example: __VNF-ID2__
45217         - name: interface-name
45218           in: path
45219           description: Name given to the interface
45220           required: true
45221           type: string
45222           example: __INTERFACE-NAME__
45223         - name: l3-interface-ipv4-address
45224           in: path
45225           description: IP address
45226           required: true
45227           type: string
45228           example: __L3-INTERFACE-IPV4-ADDRESS__
45229   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
45230     get:
45231       tags:
45232         - Network
45233       summary: returns l3-interface-ipv4-address-list
45234       description: returns l3-interface-ipv4-address-list
45235       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45236       produces:
45237         - application/json
45238         - application/xml
45239       responses:
45240         "200":
45241           description: successful operation
45242           schema:
45243               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
45244         "default":
45245           description: Response codes found in [response codes](https://wiki.onap.org/).
45246       parameters:
45247         - name: vnf-id2
45248           in: path
45249           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45250           required: true
45251           type: string
45252           example: __VNF-ID2__
45253         - name: interface-name
45254           in: path
45255           description: Name given to the interface
45256           required: true
45257           type: string
45258           example: __INTERFACE-NAME__
45259         - name: l3-interface-ipv4-address
45260           in: path
45261           description: IP address
45262           required: true
45263           type: string
45264           example: __L3-INTERFACE-IPV4-ADDRESS__
45265         - name: vnf-name
45266           in: query
45267           description: Name of VNF.
45268           required: false
45269           type: string
45270         - name: vnf-name2
45271           in: query
45272           description: Alternate name of VNF.
45273           required: false
45274           type: string
45275         - name: vnf-type
45276           in: query
45277           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.
45278           required: false
45279           type: string
45280         - name: prov-status
45281           in: query
45282           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45283           required: false
45284           type: string
45285         - name: heat-stack-id
45286           in: query
45287           description: Heat stack id corresponding to this instance, managed by MSO
45288           required: false
45289           type: string
45290         - name: interface-id
45291           in: query
45292           description: ID of interface
45293           required: false
45294           type: string
45295         - name: macaddr
45296           in: query
45297           description: MAC address for the interface
45298           required: false
45299           type: string
45300         - name: network-name
45301           in: query
45302           description: Name of the network
45303           required: false
45304           type: string
45305         - name: vlan-id-inner
45306           in: query
45307           description: Inner VLAN tag
45308           required: false
45309           type: integer
45310           format: int64
45311         - name: neutron-network-id
45312           in: query
45313           description: Neutron network id of the interface that address belongs to
45314           required: false
45315           type: string
45316         - name: neutron-subnet-id
45317           in: query
45318           description: Neutron id of subnet that address belongs to
45319           required: false
45320           type: string
45321     put:
45322       tags:
45323         - Network
45324       summary: create or update an existing l3-interface-ipv4-address-list
45325       description: |
45326         Create or update an existing l3-interface-ipv4-address-list.
45327         #
45328         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45329       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45330       consumes:
45331         - application/json
45332         - application/xml
45333       produces:
45334         - application/json
45335         - application/xml
45336       responses:
45337         "default":
45338           description: Response codes found in [response codes](https://wiki.onap.org/).
45339       parameters:
45340         - name: vnf-id2
45341           in: path
45342           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45343           required: true
45344           type: string
45345           example: __VNF-ID2__
45346         - name: interface-name
45347           in: path
45348           description: Name given to the interface
45349           required: true
45350           type: string
45351           example: __INTERFACE-NAME__
45352         - name: l3-interface-ipv4-address
45353           in: path
45354           description: IP address
45355           required: true
45356           type: string
45357           example: __L3-INTERFACE-IPV4-ADDRESS__
45358         - name: body
45359           in: body
45360           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45361           required: true
45362           schema:
45363             $ref: "#/definitions/l3-interface-ipv4-address-list"
45364     patch:
45365       tags:
45366         - Network
45367       summary: update an existing l3-interface-ipv4-address-list
45368       description: |
45369         Update an existing l3-interface-ipv4-address-list
45370         #
45371         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45372         The PUT operation will entirely replace an existing object.
45373         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45374         #
45375         Other differences between PUT and PATCH are:
45376         #
45377         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45378         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45379         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45380       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45381       consumes:
45382         - application/json
45383         - application/xml
45384       produces:
45385         - application/json
45386         - application/xml
45387       responses:
45388         "default":
45389           description: Response codes found in [response codes](https://wiki.onap.org/).
45390       parameters:
45391         - name: vnf-id2
45392           in: path
45393           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45394           required: true
45395           type: string
45396           example: __VNF-ID2__
45397         - name: interface-name
45398           in: path
45399           description: Name given to the interface
45400           required: true
45401           type: string
45402           example: __INTERFACE-NAME__
45403         - name: l3-interface-ipv4-address
45404           in: path
45405           description: IP address
45406           required: true
45407           type: string
45408           example: __L3-INTERFACE-IPV4-ADDRESS__
45409         - name: body
45410           in: body
45411           description: l3-interface-ipv4-address-list object that needs to be created or updated.
45412           required: true
45413           schema:
45414             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45415     delete:
45416       tags:
45417         - Network
45418       summary: delete an existing l3-interface-ipv4-address-list
45419       description: delete an existing l3-interface-ipv4-address-list
45420       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45421       consumes:
45422         - application/json
45423         - application/xml
45424       produces:
45425         - application/json
45426         - application/xml
45427       responses:
45428         "default":
45429           description: Response codes found in [response codes](https://wiki.onap.org/).
45430       parameters:
45431         - name: vnf-id2
45432           in: path
45433           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45434           required: true
45435           type: string
45436           example: __VNF-ID2__
45437         - name: interface-name
45438           in: path
45439           description: Name given to the interface
45440           required: true
45441           type: string
45442           example: __INTERFACE-NAME__
45443         - name: l3-interface-ipv4-address
45444           in: path
45445           description: IP address
45446           required: true
45447           type: string
45448           example: __L3-INTERFACE-IPV4-ADDRESS__
45449         - name: resource-version
45450           in: query
45451           description: resource-version for concurrency
45452           required: true
45453           type: string
45454   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
45455     put:
45456       tags:
45457         - Network
45458       summary: see node definition for valid relationships
45459       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45460       consumes:
45461         - application/json
45462         - application/xml
45463       produces:
45464         - application/json
45465         - application/xml
45466       responses:
45467         "default":
45468           description: Response codes found in [response codes](https://wiki.onap.org/).
45469       parameters:
45470         - name: vnf-id2
45471           in: path
45472           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45473           required: true
45474           type: string
45475           example: __VNF-ID2__
45476         - name: interface-name
45477           in: path
45478           description: Name given to the interface
45479           required: true
45480           type: string
45481           example: __INTERFACE-NAME__
45482         - name: l3-interface-ipv6-address
45483           in: path
45484           description: IP address
45485           required: true
45486           type: string
45487           example: __L3-INTERFACE-IPV6-ADDRESS__
45488         - name: body
45489           in: body
45490           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45491           required: true
45492           schema:
45493             $ref: "#/definitions/relationship"
45494     delete:
45495       tags:
45496         - Network
45497       summary: delete an existing relationship
45498       description: delete an existing relationship
45499       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45500       consumes:
45501         - application/json
45502         - application/xml
45503       produces:
45504         - application/json
45505         - application/xml
45506       responses:
45507         "default":
45508           description: Response codes found in [response codes](https://wiki.onap.org/).
45509       parameters:
45510         - name: vnf-id2
45511           in: path
45512           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45513           required: true
45514           type: string
45515           example: __VNF-ID2__
45516         - name: interface-name
45517           in: path
45518           description: Name given to the interface
45519           required: true
45520           type: string
45521           example: __INTERFACE-NAME__
45522         - name: l3-interface-ipv6-address
45523           in: path
45524           description: IP address
45525           required: true
45526           type: string
45527           example: __L3-INTERFACE-IPV6-ADDRESS__
45528   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
45529     get:
45530       tags:
45531         - Network
45532       summary: returns l3-interface-ipv6-address-list
45533       description: returns l3-interface-ipv6-address-list
45534       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45535       produces:
45536         - application/json
45537         - application/xml
45538       responses:
45539         "200":
45540           description: successful operation
45541           schema:
45542               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45543         "default":
45544           description: Response codes found in [response codes](https://wiki.onap.org/).
45545       parameters:
45546         - name: vnf-id2
45547           in: path
45548           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45549           required: true
45550           type: string
45551           example: __VNF-ID2__
45552         - name: interface-name
45553           in: path
45554           description: Name given to the interface
45555           required: true
45556           type: string
45557           example: __INTERFACE-NAME__
45558         - name: l3-interface-ipv6-address
45559           in: path
45560           description: IP address
45561           required: true
45562           type: string
45563           example: __L3-INTERFACE-IPV6-ADDRESS__
45564         - name: vnf-name
45565           in: query
45566           description: Name of VNF.
45567           required: false
45568           type: string
45569         - name: vnf-name2
45570           in: query
45571           description: Alternate name of VNF.
45572           required: false
45573           type: string
45574         - name: vnf-type
45575           in: query
45576           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.
45577           required: false
45578           type: string
45579         - name: prov-status
45580           in: query
45581           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45582           required: false
45583           type: string
45584         - name: heat-stack-id
45585           in: query
45586           description: Heat stack id corresponding to this instance, managed by MSO
45587           required: false
45588           type: string
45589         - name: interface-id
45590           in: query
45591           description: ID of interface
45592           required: false
45593           type: string
45594         - name: macaddr
45595           in: query
45596           description: MAC address for the interface
45597           required: false
45598           type: string
45599         - name: network-name
45600           in: query
45601           description: Name of the network
45602           required: false
45603           type: string
45604         - name: vlan-id-inner
45605           in: query
45606           description: Inner VLAN tag
45607           required: false
45608           type: integer
45609           format: int64
45610         - name: neutron-network-id
45611           in: query
45612           description: Neutron network id of the interface that address belongs to
45613           required: false
45614           type: string
45615         - name: neutron-subnet-id
45616           in: query
45617           description: Neutron id of subnet that address belongs to
45618           required: false
45619           type: string
45620     put:
45621       tags:
45622         - Network
45623       summary: create or update an existing l3-interface-ipv6-address-list
45624       description: |
45625         Create or update an existing l3-interface-ipv6-address-list.
45626         #
45627         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45628       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45629       consumes:
45630         - application/json
45631         - application/xml
45632       produces:
45633         - application/json
45634         - application/xml
45635       responses:
45636         "default":
45637           description: Response codes found in [response codes](https://wiki.onap.org/).
45638       parameters:
45639         - name: vnf-id2
45640           in: path
45641           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45642           required: true
45643           type: string
45644           example: __VNF-ID2__
45645         - name: interface-name
45646           in: path
45647           description: Name given to the interface
45648           required: true
45649           type: string
45650           example: __INTERFACE-NAME__
45651         - name: l3-interface-ipv6-address
45652           in: path
45653           description: IP address
45654           required: true
45655           type: string
45656           example: __L3-INTERFACE-IPV6-ADDRESS__
45657         - name: body
45658           in: body
45659           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45660           required: true
45661           schema:
45662             $ref: "#/definitions/l3-interface-ipv6-address-list"
45663     patch:
45664       tags:
45665         - Network
45666       summary: update an existing l3-interface-ipv6-address-list
45667       description: |
45668         Update an existing l3-interface-ipv6-address-list
45669         #
45670         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45671         The PUT operation will entirely replace an existing object.
45672         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45673         #
45674         Other differences between PUT and PATCH are:
45675         #
45676         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45677         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45678         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45679       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45680       consumes:
45681         - application/json
45682         - application/xml
45683       produces:
45684         - application/json
45685         - application/xml
45686       responses:
45687         "default":
45688           description: Response codes found in [response codes](https://wiki.onap.org/).
45689       parameters:
45690         - name: vnf-id2
45691           in: path
45692           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45693           required: true
45694           type: string
45695           example: __VNF-ID2__
45696         - name: interface-name
45697           in: path
45698           description: Name given to the interface
45699           required: true
45700           type: string
45701           example: __INTERFACE-NAME__
45702         - name: l3-interface-ipv6-address
45703           in: path
45704           description: IP address
45705           required: true
45706           type: string
45707           example: __L3-INTERFACE-IPV6-ADDRESS__
45708         - name: body
45709           in: body
45710           description: l3-interface-ipv6-address-list object that needs to be created or updated.
45711           required: true
45712           schema:
45713             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
45714     delete:
45715       tags:
45716         - Network
45717       summary: delete an existing l3-interface-ipv6-address-list
45718       description: delete an existing l3-interface-ipv6-address-list
45719       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45720       consumes:
45721         - application/json
45722         - application/xml
45723       produces:
45724         - application/json
45725         - application/xml
45726       responses:
45727         "default":
45728           description: Response codes found in [response codes](https://wiki.onap.org/).
45729       parameters:
45730         - name: vnf-id2
45731           in: path
45732           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45733           required: true
45734           type: string
45735           example: __VNF-ID2__
45736         - name: interface-name
45737           in: path
45738           description: Name given to the interface
45739           required: true
45740           type: string
45741           example: __INTERFACE-NAME__
45742         - name: l3-interface-ipv6-address
45743           in: path
45744           description: IP address
45745           required: true
45746           type: string
45747           example: __L3-INTERFACE-IPV6-ADDRESS__
45748         - name: resource-version
45749           in: query
45750           description: resource-version for concurrency
45751           required: true
45752           type: string
45753   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
45754     get:
45755       tags:
45756         - Network
45757       summary: returns l-interface
45758       description: returns l-interface
45759       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
45760       produces:
45761         - application/json
45762         - application/xml
45763       responses:
45764         "200":
45765           description: successful operation
45766           schema:
45767               $ref: "#/getDefinitions/l-interface"
45768         "default":
45769           description: Response codes found in [response codes](https://wiki.onap.org/).
45770       parameters:
45771         - name: vnf-id2
45772           in: path
45773           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45774           required: true
45775           type: string
45776           example: __VNF-ID2__
45777         - name: interface-name
45778           in: path
45779           description: Name given to the interface
45780           required: true
45781           type: string
45782           example: __INTERFACE-NAME__
45783         - name: vnf-name
45784           in: query
45785           description: Name of VNF.
45786           required: false
45787           type: string
45788         - name: vnf-name2
45789           in: query
45790           description: Alternate name of VNF.
45791           required: false
45792           type: string
45793         - name: vnf-type
45794           in: query
45795           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.
45796           required: false
45797           type: string
45798         - name: prov-status
45799           in: query
45800           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45801           required: false
45802           type: string
45803         - name: heat-stack-id
45804           in: query
45805           description: Heat stack id corresponding to this instance, managed by MSO
45806           required: false
45807           type: string
45808         - name: interface-id
45809           in: query
45810           description: ID of interface
45811           required: false
45812           type: string
45813         - name: macaddr
45814           in: query
45815           description: MAC address for the interface
45816           required: false
45817           type: string
45818         - name: network-name
45819           in: query
45820           description: Name of the network
45821           required: false
45822           type: string
45823     put:
45824       tags:
45825         - Network
45826       summary: create or update an existing l-interface
45827       description: |
45828         Create or update an existing l-interface.
45829         #
45830         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45831       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
45832       consumes:
45833         - application/json
45834         - application/xml
45835       produces:
45836         - application/json
45837         - application/xml
45838       responses:
45839         "default":
45840           description: Response codes found in [response codes](https://wiki.onap.org/).
45841       parameters:
45842         - name: vnf-id2
45843           in: path
45844           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45845           required: true
45846           type: string
45847           example: __VNF-ID2__
45848         - name: interface-name
45849           in: path
45850           description: Name given to the interface
45851           required: true
45852           type: string
45853           example: __INTERFACE-NAME__
45854         - name: body
45855           in: body
45856           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
45857           required: true
45858           schema:
45859             $ref: "#/definitions/l-interface"
45860     patch:
45861       tags:
45862         - Network
45863       summary: update an existing l-interface
45864       description: |
45865         Update an existing l-interface
45866         #
45867         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45868         The PUT operation will entirely replace an existing object.
45869         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45870         #
45871         Other differences between PUT and PATCH are:
45872         #
45873         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45874         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45875         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45876       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
45877       consumes:
45878         - application/json
45879         - application/xml
45880       produces:
45881         - application/json
45882         - application/xml
45883       responses:
45884         "default":
45885           description: Response codes found in [response codes](https://wiki.onap.org/).
45886       parameters:
45887         - name: vnf-id2
45888           in: path
45889           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45890           required: true
45891           type: string
45892           example: __VNF-ID2__
45893         - name: interface-name
45894           in: path
45895           description: Name given to the interface
45896           required: true
45897           type: string
45898           example: __INTERFACE-NAME__
45899         - name: body
45900           in: body
45901           description: l-interface object that needs to be created or updated.
45902           required: true
45903           schema:
45904             $ref: "#/patchDefinitions/l-interface"
45905     delete:
45906       tags:
45907         - Network
45908       summary: delete an existing l-interface
45909       description: delete an existing l-interface
45910       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
45911       consumes:
45912         - application/json
45913         - application/xml
45914       produces:
45915         - application/json
45916         - application/xml
45917       responses:
45918         "default":
45919           description: Response codes found in [response codes](https://wiki.onap.org/).
45920       parameters:
45921         - name: vnf-id2
45922           in: path
45923           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45924           required: true
45925           type: string
45926           example: __VNF-ID2__
45927         - name: interface-name
45928           in: path
45929           description: Name given to the interface
45930           required: true
45931           type: string
45932           example: __INTERFACE-NAME__
45933         - name: resource-version
45934           in: query
45935           description: resource-version for concurrency
45936           required: true
45937           type: string
45938   /network/newvces/newvce/{vnf-id2}/l-interfaces:
45939     get:
45940       tags:
45941         - Network
45942       summary: returns l-interfaces
45943       description: returns l-interfaces
45944       operationId: getNetworkNewvcesNewvceLInterfaces
45945       produces:
45946         - application/json
45947         - application/xml
45948       responses:
45949         "200":
45950           description: successful operation
45951           schema:
45952               $ref: "#/getDefinitions/l-interfaces"
45953         "default":
45954           description: Response codes found in [response codes](https://wiki.onap.org/).
45955       parameters:
45956         - name: vnf-id2
45957           in: path
45958           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45959           required: true
45960           type: string
45961           example: __VNF-ID2__
45962         - name: vnf-name
45963           in: query
45964           description: Name of VNF.
45965           required: false
45966           type: string
45967         - name: vnf-name2
45968           in: query
45969           description: Alternate name of VNF.
45970           required: false
45971           type: string
45972         - name: vnf-type
45973           in: query
45974           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.
45975           required: false
45976           type: string
45977         - name: prov-status
45978           in: query
45979           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45980           required: false
45981           type: string
45982         - name: heat-stack-id
45983           in: query
45984           description: Heat stack id corresponding to this instance, managed by MSO
45985           required: false
45986           type: string
45987   /network/newvces/newvce/{vnf-id2}:
45988     get:
45989       tags:
45990         - Network
45991       summary: returns newvce
45992       description: returns newvce
45993       operationId: getNetworkNewvcesNewvce
45994       produces:
45995         - application/json
45996         - application/xml
45997       responses:
45998         "200":
45999           description: successful operation
46000           schema:
46001               $ref: "#/getDefinitions/newvce"
46002         "default":
46003           description: Response codes found in [response codes](https://wiki.onap.org/).
46004       parameters:
46005         - name: vnf-id2
46006           in: path
46007           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
46008           required: true
46009           type: string
46010           example: __VNF-ID2__
46011         - name: vnf-name
46012           in: query
46013           description: Name of VNF.
46014           required: false
46015           type: string
46016         - name: vnf-name2
46017           in: query
46018           description: Alternate name of VNF.
46019           required: false
46020           type: string
46021         - name: vnf-type
46022           in: query
46023           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.
46024           required: false
46025           type: string
46026         - name: prov-status
46027           in: query
46028           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46029           required: false
46030           type: string
46031         - name: heat-stack-id
46032           in: query
46033           description: Heat stack id corresponding to this instance, managed by MSO
46034           required: false
46035           type: string
46036     put:
46037       tags:
46038         - Network
46039       summary: create or update an existing newvce
46040       description: |
46041         Create or update an existing newvce.
46042         #
46043         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46044       operationId: createOrUpdateNetworkNewvcesNewvce
46045       consumes:
46046         - application/json
46047         - application/xml
46048       produces:
46049         - application/json
46050         - application/xml
46051       responses:
46052         "default":
46053           description: Response codes found in [response codes](https://wiki.onap.org/).
46054       parameters:
46055         - name: vnf-id2
46056           in: path
46057           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
46058           required: true
46059           type: string
46060           example: __VNF-ID2__
46061         - name: body
46062           in: body
46063           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
46064           required: true
46065           schema:
46066             $ref: "#/definitions/newvce"
46067     patch:
46068       tags:
46069         - Network
46070       summary: update an existing newvce
46071       description: |
46072         Update an existing newvce
46073         #
46074         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46075         The PUT operation will entirely replace an existing object.
46076         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46077         #
46078         Other differences between PUT and PATCH are:
46079         #
46080         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46081         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46082         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46083       operationId: UpdateNetworkNewvcesNewvce
46084       consumes:
46085         - application/json
46086         - application/xml
46087       produces:
46088         - application/json
46089         - application/xml
46090       responses:
46091         "default":
46092           description: Response codes found in [response codes](https://wiki.onap.org/).
46093       parameters:
46094         - name: vnf-id2
46095           in: path
46096           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
46097           required: true
46098           type: string
46099           example: __VNF-ID2__
46100         - name: body
46101           in: body
46102           description: newvce object that needs to be created or updated.
46103           required: true
46104           schema:
46105             $ref: "#/patchDefinitions/newvce"
46106     delete:
46107       tags:
46108         - Network
46109       summary: delete an existing newvce
46110       description: delete an existing newvce
46111       operationId: deleteNetworkNewvcesNewvce
46112       consumes:
46113         - application/json
46114         - application/xml
46115       produces:
46116         - application/json
46117         - application/xml
46118       responses:
46119         "default":
46120           description: Response codes found in [response codes](https://wiki.onap.org/).
46121       parameters:
46122         - name: vnf-id2
46123           in: path
46124           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
46125           required: true
46126           type: string
46127           example: __VNF-ID2__
46128         - name: resource-version
46129           in: query
46130           description: resource-version for concurrency
46131           required: true
46132           type: string
46133   /network/newvces:
46134     get:
46135       tags:
46136         - Network
46137       summary: returns newvces
46138       description: returns newvces
46139       operationId: getNetworkNewvces
46140       produces:
46141         - application/json
46142         - application/xml
46143       responses:
46144         "200":
46145           description: successful operation
46146           schema:
46147               $ref: "#/getDefinitions/newvces"
46148         "default":
46149           description: Response codes found in [response codes](https://wiki.onap.org/).
46150   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
46151     put:
46152       tags:
46153         - Network
46154       summary: see node definition for valid relationships
46155       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
46156       consumes:
46157         - application/json
46158         - application/xml
46159       produces:
46160         - application/json
46161         - application/xml
46162       responses:
46163         "default":
46164           description: Response codes found in [response codes](https://wiki.onap.org/).
46165       parameters:
46166         - name: pnf-name
46167           in: path
46168           description: unique name of Physical Network Function.
46169           required: true
46170           type: string
46171           example: __PNF-NAME__
46172         - name: body
46173           in: body
46174           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
46175           required: true
46176           schema:
46177             $ref: "#/definitions/relationship"
46178     delete:
46179       tags:
46180         - Network
46181       summary: delete an existing relationship
46182       description: delete an existing relationship
46183       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
46184       consumes:
46185         - application/json
46186         - application/xml
46187       produces:
46188         - application/json
46189         - application/xml
46190       responses:
46191         "default":
46192           description: Response codes found in [response codes](https://wiki.onap.org/).
46193       parameters:
46194         - name: pnf-name
46195           in: path
46196           description: unique name of Physical Network Function.
46197           required: true
46198           type: string
46199           example: __PNF-NAME__
46200   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
46201     put:
46202       tags:
46203         - Network
46204       summary: see node definition for valid relationships
46205       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
46206       consumes:
46207         - application/json
46208         - application/xml
46209       produces:
46210         - application/json
46211         - application/xml
46212       responses:
46213         "default":
46214           description: Response codes found in [response codes](https://wiki.onap.org/).
46215       parameters:
46216         - name: pnf-name
46217           in: path
46218           description: unique name of Physical Network Function.
46219           required: true
46220           type: string
46221           example: __PNF-NAME__
46222         - name: interface-name
46223           in: path
46224           description: Name that identifies the physical interface
46225           required: true
46226           type: string
46227           example: __INTERFACE-NAME__
46228         - name: body
46229           in: body
46230           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
46231           required: true
46232           schema:
46233             $ref: "#/definitions/relationship"
46234     delete:
46235       tags:
46236         - Network
46237       summary: delete an existing relationship
46238       description: delete an existing relationship
46239       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
46240       consumes:
46241         - application/json
46242         - application/xml
46243       produces:
46244         - application/json
46245         - application/xml
46246       responses:
46247         "default":
46248           description: Response codes found in [response codes](https://wiki.onap.org/).
46249       parameters:
46250         - name: pnf-name
46251           in: path
46252           description: unique name of Physical Network Function.
46253           required: true
46254           type: string
46255           example: __PNF-NAME__
46256         - name: interface-name
46257           in: path
46258           description: Name that identifies the physical interface
46259           required: true
46260           type: string
46261           example: __INTERFACE-NAME__
46262   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
46263     put:
46264       tags:
46265         - Network
46266       summary: see node definition for valid relationships
46267       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
46268       consumes:
46269         - application/json
46270         - application/xml
46271       produces:
46272         - application/json
46273         - application/xml
46274       responses:
46275         "default":
46276           description: Response codes found in [response codes](https://wiki.onap.org/).
46277       parameters:
46278         - name: pnf-name
46279           in: path
46280           description: unique name of Physical Network Function.
46281           required: true
46282           type: string
46283           example: __PNF-NAME__
46284         - name: interface-name
46285           in: path
46286           description: Name that identifies the physical interface
46287           required: true
46288           type: string
46289           example: __INTERFACE-NAME__
46290         - name: pf-pci-id
46291           in: path
46292           description: Identifier for the sriov-pf
46293           required: true
46294           type: string
46295           example: __PF-PCI-ID__
46296         - name: body
46297           in: body
46298           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
46299           required: true
46300           schema:
46301             $ref: "#/definitions/relationship"
46302     delete:
46303       tags:
46304         - Network
46305       summary: delete an existing relationship
46306       description: delete an existing relationship
46307       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
46308       consumes:
46309         - application/json
46310         - application/xml
46311       produces:
46312         - application/json
46313         - application/xml
46314       responses:
46315         "default":
46316           description: Response codes found in [response codes](https://wiki.onap.org/).
46317       parameters:
46318         - name: pnf-name
46319           in: path
46320           description: unique name of Physical Network Function.
46321           required: true
46322           type: string
46323           example: __PNF-NAME__
46324         - name: interface-name
46325           in: path
46326           description: Name that identifies the physical interface
46327           required: true
46328           type: string
46329           example: __INTERFACE-NAME__
46330         - name: pf-pci-id
46331           in: path
46332           description: Identifier for the sriov-pf
46333           required: true
46334           type: string
46335           example: __PF-PCI-ID__
46336   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
46337     get:
46338       tags:
46339         - Network
46340       summary: returns sriov-pf
46341       description: returns sriov-pf
46342       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46343       produces:
46344         - application/json
46345         - application/xml
46346       responses:
46347         "200":
46348           description: successful operation
46349           schema:
46350               $ref: "#/getDefinitions/sriov-pf"
46351         "default":
46352           description: Response codes found in [response codes](https://wiki.onap.org/).
46353       parameters:
46354         - name: pnf-name
46355           in: path
46356           description: unique name of Physical Network Function.
46357           required: true
46358           type: string
46359           example: __PNF-NAME__
46360         - name: interface-name
46361           in: path
46362           description: Name that identifies the physical interface
46363           required: true
46364           type: string
46365           example: __INTERFACE-NAME__
46366         - name: pf-pci-id
46367           in: path
46368           description: Identifier for the sriov-pf
46369           required: true
46370           type: string
46371           example: __PF-PCI-ID__
46372         - name: inv-status
46373           in: query
46374           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46375           required: false
46376           type: string
46377         - name: prov-status
46378           in: query
46379           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46380           required: false
46381           type: string
46382     put:
46383       tags:
46384         - Network
46385       summary: create or update an existing sriov-pf
46386       description: |
46387         Create or update an existing sriov-pf.
46388         #
46389         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46390       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46391       consumes:
46392         - application/json
46393         - application/xml
46394       produces:
46395         - application/json
46396         - application/xml
46397       responses:
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: pf-pci-id
46414           in: path
46415           description: Identifier for the sriov-pf
46416           required: true
46417           type: string
46418           example: __PF-PCI-ID__
46419         - name: body
46420           in: body
46421           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
46422           required: true
46423           schema:
46424             $ref: "#/definitions/sriov-pf"
46425     patch:
46426       tags:
46427         - Network
46428       summary: update an existing sriov-pf
46429       description: |
46430         Update an existing sriov-pf
46431         #
46432         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46433         The PUT operation will entirely replace an existing object.
46434         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46435         #
46436         Other differences between PUT and PATCH are:
46437         #
46438         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46439         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46440         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46441       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46442       consumes:
46443         - application/json
46444         - application/xml
46445       produces:
46446         - application/json
46447         - application/xml
46448       responses:
46449         "default":
46450           description: Response codes found in [response codes](https://wiki.onap.org/).
46451       parameters:
46452         - name: pnf-name
46453           in: path
46454           description: unique name of Physical Network Function.
46455           required: true
46456           type: string
46457           example: __PNF-NAME__
46458         - name: interface-name
46459           in: path
46460           description: Name that identifies the physical interface
46461           required: true
46462           type: string
46463           example: __INTERFACE-NAME__
46464         - name: pf-pci-id
46465           in: path
46466           description: Identifier for the sriov-pf
46467           required: true
46468           type: string
46469           example: __PF-PCI-ID__
46470         - name: body
46471           in: body
46472           description: sriov-pf object that needs to be created or updated.
46473           required: true
46474           schema:
46475             $ref: "#/patchDefinitions/sriov-pf"
46476     delete:
46477       tags:
46478         - Network
46479       summary: delete an existing sriov-pf
46480       description: delete an existing sriov-pf
46481       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46482       consumes:
46483         - application/json
46484         - application/xml
46485       produces:
46486         - application/json
46487         - application/xml
46488       responses:
46489         "default":
46490           description: Response codes found in [response codes](https://wiki.onap.org/).
46491       parameters:
46492         - name: pnf-name
46493           in: path
46494           description: unique name of Physical Network Function.
46495           required: true
46496           type: string
46497           example: __PNF-NAME__
46498         - name: interface-name
46499           in: path
46500           description: Name that identifies the physical interface
46501           required: true
46502           type: string
46503           example: __INTERFACE-NAME__
46504         - name: pf-pci-id
46505           in: path
46506           description: Identifier for the sriov-pf
46507           required: true
46508           type: string
46509           example: __PF-PCI-ID__
46510         - name: resource-version
46511           in: query
46512           description: resource-version for concurrency
46513           required: true
46514           type: string
46515   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
46516     get:
46517       tags:
46518         - Network
46519       summary: returns sriov-pfs
46520       description: returns sriov-pfs
46521       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
46522       produces:
46523         - application/json
46524         - application/xml
46525       responses:
46526         "200":
46527           description: successful operation
46528           schema:
46529               $ref: "#/getDefinitions/sriov-pfs"
46530         "default":
46531           description: Response codes found in [response codes](https://wiki.onap.org/).
46532       parameters:
46533         - name: pnf-name
46534           in: path
46535           description: unique name of Physical Network Function.
46536           required: true
46537           type: string
46538           example: __PNF-NAME__
46539         - name: interface-name
46540           in: path
46541           description: Name that identifies the physical interface
46542           required: true
46543           type: string
46544           example: __INTERFACE-NAME__
46545         - name: inv-status
46546           in: query
46547           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46548           required: false
46549           type: string
46550         - name: prov-status
46551           in: query
46552           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46553           required: false
46554           type: string
46555   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
46556     put:
46557       tags:
46558         - Network
46559       summary: see node definition for valid relationships
46560       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
46561       consumes:
46562         - application/json
46563         - application/xml
46564       produces:
46565         - application/json
46566         - application/xml
46567       responses:
46568         "default":
46569           description: Response codes found in [response codes](https://wiki.onap.org/).
46570       parameters:
46571         - name: pnf-name
46572           in: path
46573           description: unique name of Physical Network Function.
46574           required: true
46575           type: string
46576           example: __PNF-NAME__
46577         - name: interface-name
46578           in: path
46579           description: Name that identifies the physical interface
46580           required: true
46581           type: string
46582           example: __INTERFACE-NAME__
46583         - name: interface-name
46584           in: path
46585           description: Name given to the interface
46586           required: true
46587           type: string
46588           example: __INTERFACE-NAME__
46589         - name: vlan-interface
46590           in: path
46591           description: String that identifies the interface
46592           required: true
46593           type: string
46594           example: __VLAN-INTERFACE__
46595         - name: body
46596           in: body
46597           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
46598           required: true
46599           schema:
46600             $ref: "#/definitions/relationship"
46601     delete:
46602       tags:
46603         - Network
46604       summary: delete an existing relationship
46605       description: delete an existing relationship
46606       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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   /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:
46642     put:
46643       tags:
46644         - Network
46645       summary: see node definition for valid relationships
46646       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
46647       consumes:
46648         - application/json
46649         - application/xml
46650       produces:
46651         - application/json
46652         - application/xml
46653       responses:
46654         "default":
46655           description: Response codes found in [response codes](https://wiki.onap.org/).
46656       parameters:
46657         - name: pnf-name
46658           in: path
46659           description: unique name of Physical Network Function.
46660           required: true
46661           type: string
46662           example: __PNF-NAME__
46663         - name: interface-name
46664           in: path
46665           description: Name that identifies the physical interface
46666           required: true
46667           type: string
46668           example: __INTERFACE-NAME__
46669         - name: interface-name
46670           in: path
46671           description: Name given to the interface
46672           required: true
46673           type: string
46674           example: __INTERFACE-NAME__
46675         - name: vlan-interface
46676           in: path
46677           description: String that identifies the interface
46678           required: true
46679           type: string
46680           example: __VLAN-INTERFACE__
46681         - name: l3-interface-ipv4-address
46682           in: path
46683           description: IP address
46684           required: true
46685           type: string
46686           example: __L3-INTERFACE-IPV4-ADDRESS__
46687         - name: body
46688           in: body
46689           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
46690           required: true
46691           schema:
46692             $ref: "#/definitions/relationship"
46693     delete:
46694       tags:
46695         - Network
46696       summary: delete an existing relationship
46697       description: delete an existing relationship
46698       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
46699       consumes:
46700         - application/json
46701         - application/xml
46702       produces:
46703         - application/json
46704         - application/xml
46705       responses:
46706         "default":
46707           description: Response codes found in [response codes](https://wiki.onap.org/).
46708       parameters:
46709         - name: pnf-name
46710           in: path
46711           description: unique name of Physical Network Function.
46712           required: true
46713           type: string
46714           example: __PNF-NAME__
46715         - name: interface-name
46716           in: path
46717           description: Name that identifies the physical interface
46718           required: true
46719           type: string
46720           example: __INTERFACE-NAME__
46721         - name: interface-name
46722           in: path
46723           description: Name given to the interface
46724           required: true
46725           type: string
46726           example: __INTERFACE-NAME__
46727         - name: vlan-interface
46728           in: path
46729           description: String that identifies the interface
46730           required: true
46731           type: string
46732           example: __VLAN-INTERFACE__
46733         - name: l3-interface-ipv4-address
46734           in: path
46735           description: IP address
46736           required: true
46737           type: string
46738           example: __L3-INTERFACE-IPV4-ADDRESS__
46739   /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}:
46740     get:
46741       tags:
46742         - Network
46743       summary: returns l3-interface-ipv4-address-list
46744       description: returns l3-interface-ipv4-address-list
46745       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46746       produces:
46747         - application/json
46748         - application/xml
46749       responses:
46750         "200":
46751           description: successful operation
46752           schema:
46753               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46754         "default":
46755           description: Response codes found in [response codes](https://wiki.onap.org/).
46756       parameters:
46757         - name: pnf-name
46758           in: path
46759           description: unique name of Physical Network Function.
46760           required: true
46761           type: string
46762           example: __PNF-NAME__
46763         - name: interface-name
46764           in: path
46765           description: Name that identifies the physical interface
46766           required: true
46767           type: string
46768           example: __INTERFACE-NAME__
46769         - name: interface-name
46770           in: path
46771           description: Name given to the interface
46772           required: true
46773           type: string
46774           example: __INTERFACE-NAME__
46775         - name: vlan-interface
46776           in: path
46777           description: String that identifies the interface
46778           required: true
46779           type: string
46780           example: __VLAN-INTERFACE__
46781         - name: l3-interface-ipv4-address
46782           in: path
46783           description: IP address
46784           required: true
46785           type: string
46786           example: __L3-INTERFACE-IPV4-ADDRESS__
46787         - name: inv-status
46788           in: query
46789           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46790           required: false
46791           type: string
46792         - name: prov-status
46793           in: query
46794           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46795           required: false
46796           type: string
46797         - name: interface-id
46798           in: query
46799           description: ID of interface
46800           required: false
46801           type: string
46802         - name: macaddr
46803           in: query
46804           description: MAC address for the interface
46805           required: false
46806           type: string
46807         - name: network-name
46808           in: query
46809           description: Name of the network
46810           required: false
46811           type: string
46812         - name: vlan-id-inner
46813           in: query
46814           description: Inner VLAN tag
46815           required: false
46816           type: integer
46817           format: int64
46818         - name: vpn-key
46819           in: query
46820           description: This indicates the customers VPN ID associated with this vlan
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: neutron-network-id
46830           in: query
46831           description: Neutron network id of the interface that address belongs to
46832           required: false
46833           type: string
46834         - name: neutron-subnet-id
46835           in: query
46836           description: Neutron id of subnet that address belongs to
46837           required: false
46838           type: string
46839     put:
46840       tags:
46841         - Network
46842       summary: create or update an existing l3-interface-ipv4-address-list
46843       description: |
46844         Create or update an existing l3-interface-ipv4-address-list.
46845         #
46846         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46847       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46848       consumes:
46849         - application/json
46850         - application/xml
46851       produces:
46852         - application/json
46853         - application/xml
46854       responses:
46855         "default":
46856           description: Response codes found in [response codes](https://wiki.onap.org/).
46857       parameters:
46858         - name: pnf-name
46859           in: path
46860           description: unique name of Physical Network Function.
46861           required: true
46862           type: string
46863           example: __PNF-NAME__
46864         - name: interface-name
46865           in: path
46866           description: Name that identifies the physical interface
46867           required: true
46868           type: string
46869           example: __INTERFACE-NAME__
46870         - name: interface-name
46871           in: path
46872           description: Name given to the interface
46873           required: true
46874           type: string
46875           example: __INTERFACE-NAME__
46876         - name: vlan-interface
46877           in: path
46878           description: String that identifies the interface
46879           required: true
46880           type: string
46881           example: __VLAN-INTERFACE__
46882         - name: l3-interface-ipv4-address
46883           in: path
46884           description: IP address
46885           required: true
46886           type: string
46887           example: __L3-INTERFACE-IPV4-ADDRESS__
46888         - name: body
46889           in: body
46890           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
46891           required: true
46892           schema:
46893             $ref: "#/definitions/l3-interface-ipv4-address-list"
46894     patch:
46895       tags:
46896         - Network
46897       summary: update an existing l3-interface-ipv4-address-list
46898       description: |
46899         Update an existing l3-interface-ipv4-address-list
46900         #
46901         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46902         The PUT operation will entirely replace an existing object.
46903         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46904         #
46905         Other differences between PUT and PATCH are:
46906         #
46907         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46908         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46909         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46910       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46911       consumes:
46912         - application/json
46913         - application/xml
46914       produces:
46915         - application/json
46916         - application/xml
46917       responses:
46918         "default":
46919           description: Response codes found in [response codes](https://wiki.onap.org/).
46920       parameters:
46921         - name: pnf-name
46922           in: path
46923           description: unique name of Physical Network Function.
46924           required: true
46925           type: string
46926           example: __PNF-NAME__
46927         - name: interface-name
46928           in: path
46929           description: Name that identifies the physical interface
46930           required: true
46931           type: string
46932           example: __INTERFACE-NAME__
46933         - name: interface-name
46934           in: path
46935           description: Name given to the interface
46936           required: true
46937           type: string
46938           example: __INTERFACE-NAME__
46939         - name: vlan-interface
46940           in: path
46941           description: String that identifies the interface
46942           required: true
46943           type: string
46944           example: __VLAN-INTERFACE__
46945         - name: l3-interface-ipv4-address
46946           in: path
46947           description: IP address
46948           required: true
46949           type: string
46950           example: __L3-INTERFACE-IPV4-ADDRESS__
46951         - name: body
46952           in: body
46953           description: l3-interface-ipv4-address-list object that needs to be created or updated.
46954           required: true
46955           schema:
46956             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
46957     delete:
46958       tags:
46959         - Network
46960       summary: delete an existing l3-interface-ipv4-address-list
46961       description: delete an existing l3-interface-ipv4-address-list
46962       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46963       consumes:
46964         - application/json
46965         - application/xml
46966       produces:
46967         - application/json
46968         - application/xml
46969       responses:
46970         "default":
46971           description: Response codes found in [response codes](https://wiki.onap.org/).
46972       parameters:
46973         - name: pnf-name
46974           in: path
46975           description: unique name of Physical Network Function.
46976           required: true
46977           type: string
46978           example: __PNF-NAME__
46979         - name: interface-name
46980           in: path
46981           description: Name that identifies the physical interface
46982           required: true
46983           type: string
46984           example: __INTERFACE-NAME__
46985         - name: interface-name
46986           in: path
46987           description: Name given to the interface
46988           required: true
46989           type: string
46990           example: __INTERFACE-NAME__
46991         - name: vlan-interface
46992           in: path
46993           description: String that identifies the interface
46994           required: true
46995           type: string
46996           example: __VLAN-INTERFACE__
46997         - name: l3-interface-ipv4-address
46998           in: path
46999           description: IP address
47000           required: true
47001           type: string
47002           example: __L3-INTERFACE-IPV4-ADDRESS__
47003         - name: resource-version
47004           in: query
47005           description: resource-version for concurrency
47006           required: true
47007           type: string
47008   /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:
47009     put:
47010       tags:
47011         - Network
47012       summary: see node definition for valid relationships
47013       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
47014       consumes:
47015         - application/json
47016         - application/xml
47017       produces:
47018         - application/json
47019         - application/xml
47020       responses:
47021         "default":
47022           description: Response codes found in [response codes](https://wiki.onap.org/).
47023       parameters:
47024         - name: pnf-name
47025           in: path
47026           description: unique name of Physical Network Function.
47027           required: true
47028           type: string
47029           example: __PNF-NAME__
47030         - name: interface-name
47031           in: path
47032           description: Name that identifies the physical interface
47033           required: true
47034           type: string
47035           example: __INTERFACE-NAME__
47036         - name: interface-name
47037           in: path
47038           description: Name given to the interface
47039           required: true
47040           type: string
47041           example: __INTERFACE-NAME__
47042         - name: vlan-interface
47043           in: path
47044           description: String that identifies the interface
47045           required: true
47046           type: string
47047           example: __VLAN-INTERFACE__
47048         - name: l3-interface-ipv6-address
47049           in: path
47050           description: IP address
47051           required: true
47052           type: string
47053           example: __L3-INTERFACE-IPV6-ADDRESS__
47054         - name: body
47055           in: body
47056           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
47057           required: true
47058           schema:
47059             $ref: "#/definitions/relationship"
47060     delete:
47061       tags:
47062         - Network
47063       summary: delete an existing relationship
47064       description: delete an existing relationship
47065       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
47066       consumes:
47067         - application/json
47068         - application/xml
47069       produces:
47070         - application/json
47071         - application/xml
47072       responses:
47073         "default":
47074           description: Response codes found in [response codes](https://wiki.onap.org/).
47075       parameters:
47076         - name: pnf-name
47077           in: path
47078           description: unique name of Physical Network Function.
47079           required: true
47080           type: string
47081           example: __PNF-NAME__
47082         - name: interface-name
47083           in: path
47084           description: Name that identifies the physical interface
47085           required: true
47086           type: string
47087           example: __INTERFACE-NAME__
47088         - name: interface-name
47089           in: path
47090           description: Name given to the interface
47091           required: true
47092           type: string
47093           example: __INTERFACE-NAME__
47094         - name: vlan-interface
47095           in: path
47096           description: String that identifies the interface
47097           required: true
47098           type: string
47099           example: __VLAN-INTERFACE__
47100         - name: l3-interface-ipv6-address
47101           in: path
47102           description: IP address
47103           required: true
47104           type: string
47105           example: __L3-INTERFACE-IPV6-ADDRESS__
47106   /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}:
47107     get:
47108       tags:
47109         - Network
47110       summary: returns l3-interface-ipv6-address-list
47111       description: returns l3-interface-ipv6-address-list
47112       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
47113       produces:
47114         - application/json
47115         - application/xml
47116       responses:
47117         "200":
47118           description: successful operation
47119           schema:
47120               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
47121         "default":
47122           description: Response codes found in [response codes](https://wiki.onap.org/).
47123       parameters:
47124         - name: pnf-name
47125           in: path
47126           description: unique name of Physical Network Function.
47127           required: true
47128           type: string
47129           example: __PNF-NAME__
47130         - name: interface-name
47131           in: path
47132           description: Name that identifies the physical interface
47133           required: true
47134           type: string
47135           example: __INTERFACE-NAME__
47136         - name: interface-name
47137           in: path
47138           description: Name given to the interface
47139           required: true
47140           type: string
47141           example: __INTERFACE-NAME__
47142         - name: vlan-interface
47143           in: path
47144           description: String that identifies the interface
47145           required: true
47146           type: string
47147           example: __VLAN-INTERFACE__
47148         - name: l3-interface-ipv6-address
47149           in: path
47150           description: IP address
47151           required: true
47152           type: string
47153           example: __L3-INTERFACE-IPV6-ADDRESS__
47154         - name: inv-status
47155           in: query
47156           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47157           required: false
47158           type: string
47159         - name: prov-status
47160           in: query
47161           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47162           required: false
47163           type: string
47164         - name: interface-id
47165           in: query
47166           description: ID of interface
47167           required: false
47168           type: string
47169         - name: macaddr
47170           in: query
47171           description: MAC address for the interface
47172           required: false
47173           type: string
47174         - name: network-name
47175           in: query
47176           description: Name of the network
47177           required: false
47178           type: string
47179         - name: vlan-id-inner
47180           in: query
47181           description: Inner VLAN tag
47182           required: false
47183           type: integer
47184           format: int64
47185         - name: vpn-key
47186           in: query
47187           description: This indicates the customers VPN ID associated with this vlan
47188           required: false
47189           type: string
47190         - name: vlan-id-inner
47191           in: query
47192           description: Inner VLAN tag
47193           required: false
47194           type: integer
47195           format: int64
47196         - name: neutron-network-id
47197           in: query
47198           description: Neutron network id of the interface that address belongs to
47199           required: false
47200           type: string
47201         - name: neutron-subnet-id
47202           in: query
47203           description: Neutron id of subnet that address belongs to
47204           required: false
47205           type: string
47206     put:
47207       tags:
47208         - Network
47209       summary: create or update an existing l3-interface-ipv6-address-list
47210       description: |
47211         Create or update an existing l3-interface-ipv6-address-list.
47212         #
47213         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47214       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
47215       consumes:
47216         - application/json
47217         - application/xml
47218       produces:
47219         - application/json
47220         - application/xml
47221       responses:
47222         "default":
47223           description: Response codes found in [response codes](https://wiki.onap.org/).
47224       parameters:
47225         - name: pnf-name
47226           in: path
47227           description: unique name of Physical Network Function.
47228           required: true
47229           type: string
47230           example: __PNF-NAME__
47231         - name: interface-name
47232           in: path
47233           description: Name that identifies the physical interface
47234           required: true
47235           type: string
47236           example: __INTERFACE-NAME__
47237         - name: interface-name
47238           in: path
47239           description: Name given to the interface
47240           required: true
47241           type: string
47242           example: __INTERFACE-NAME__
47243         - name: vlan-interface
47244           in: path
47245           description: String that identifies the interface
47246           required: true
47247           type: string
47248           example: __VLAN-INTERFACE__
47249         - name: l3-interface-ipv6-address
47250           in: path
47251           description: IP address
47252           required: true
47253           type: string
47254           example: __L3-INTERFACE-IPV6-ADDRESS__
47255         - name: body
47256           in: body
47257           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
47258           required: true
47259           schema:
47260             $ref: "#/definitions/l3-interface-ipv6-address-list"
47261     patch:
47262       tags:
47263         - Network
47264       summary: update an existing l3-interface-ipv6-address-list
47265       description: |
47266         Update an existing l3-interface-ipv6-address-list
47267         #
47268         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47269         The PUT operation will entirely replace an existing object.
47270         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47271         #
47272         Other differences between PUT and PATCH are:
47273         #
47274         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47275         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47276         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47277       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
47278       consumes:
47279         - application/json
47280         - application/xml
47281       produces:
47282         - application/json
47283         - application/xml
47284       responses:
47285         "default":
47286           description: Response codes found in [response codes](https://wiki.onap.org/).
47287       parameters:
47288         - name: pnf-name
47289           in: path
47290           description: unique name of Physical Network Function.
47291           required: true
47292           type: string
47293           example: __PNF-NAME__
47294         - name: interface-name
47295           in: path
47296           description: Name that identifies the physical interface
47297           required: true
47298           type: string
47299           example: __INTERFACE-NAME__
47300         - name: interface-name
47301           in: path
47302           description: Name given to the interface
47303           required: true
47304           type: string
47305           example: __INTERFACE-NAME__
47306         - name: vlan-interface
47307           in: path
47308           description: String that identifies the interface
47309           required: true
47310           type: string
47311           example: __VLAN-INTERFACE__
47312         - name: l3-interface-ipv6-address
47313           in: path
47314           description: IP address
47315           required: true
47316           type: string
47317           example: __L3-INTERFACE-IPV6-ADDRESS__
47318         - name: body
47319           in: body
47320           description: l3-interface-ipv6-address-list object that needs to be created or updated.
47321           required: true
47322           schema:
47323             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
47324     delete:
47325       tags:
47326         - Network
47327       summary: delete an existing l3-interface-ipv6-address-list
47328       description: delete an existing l3-interface-ipv6-address-list
47329       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
47330       consumes:
47331         - application/json
47332         - application/xml
47333       produces:
47334         - application/json
47335         - application/xml
47336       responses:
47337         "default":
47338           description: Response codes found in [response codes](https://wiki.onap.org/).
47339       parameters:
47340         - name: pnf-name
47341           in: path
47342           description: unique name of Physical Network Function.
47343           required: true
47344           type: string
47345           example: __PNF-NAME__
47346         - name: interface-name
47347           in: path
47348           description: Name that identifies the physical interface
47349           required: true
47350           type: string
47351           example: __INTERFACE-NAME__
47352         - name: interface-name
47353           in: path
47354           description: Name given to the interface
47355           required: true
47356           type: string
47357           example: __INTERFACE-NAME__
47358         - name: vlan-interface
47359           in: path
47360           description: String that identifies the interface
47361           required: true
47362           type: string
47363           example: __VLAN-INTERFACE__
47364         - name: l3-interface-ipv6-address
47365           in: path
47366           description: IP address
47367           required: true
47368           type: string
47369           example: __L3-INTERFACE-IPV6-ADDRESS__
47370         - name: resource-version
47371           in: query
47372           description: resource-version for concurrency
47373           required: true
47374           type: string
47375   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
47376     get:
47377       tags:
47378         - Network
47379       summary: returns vlan
47380       description: returns vlan
47381       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47382       produces:
47383         - application/json
47384         - application/xml
47385       responses:
47386         "200":
47387           description: successful operation
47388           schema:
47389               $ref: "#/getDefinitions/vlan"
47390         "default":
47391           description: Response codes found in [response codes](https://wiki.onap.org/).
47392       parameters:
47393         - name: pnf-name
47394           in: path
47395           description: unique name of Physical Network Function.
47396           required: true
47397           type: string
47398           example: __PNF-NAME__
47399         - name: interface-name
47400           in: path
47401           description: Name that identifies the physical interface
47402           required: true
47403           type: string
47404           example: __INTERFACE-NAME__
47405         - name: interface-name
47406           in: path
47407           description: Name given to the interface
47408           required: true
47409           type: string
47410           example: __INTERFACE-NAME__
47411         - name: vlan-interface
47412           in: path
47413           description: String that identifies the interface
47414           required: true
47415           type: string
47416           example: __VLAN-INTERFACE__
47417         - name: inv-status
47418           in: query
47419           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47420           required: false
47421           type: string
47422         - name: prov-status
47423           in: query
47424           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47425           required: false
47426           type: string
47427         - name: interface-id
47428           in: query
47429           description: ID of interface
47430           required: false
47431           type: string
47432         - name: macaddr
47433           in: query
47434           description: MAC address for the interface
47435           required: false
47436           type: string
47437         - name: network-name
47438           in: query
47439           description: Name of the network
47440           required: false
47441           type: string
47442         - name: vlan-id-inner
47443           in: query
47444           description: Inner VLAN tag
47445           required: false
47446           type: integer
47447           format: int64
47448         - name: vpn-key
47449           in: query
47450           description: This indicates the customers VPN ID associated with this vlan
47451           required: false
47452           type: string
47453     put:
47454       tags:
47455         - Network
47456       summary: create or update an existing vlan
47457       description: |
47458         Create or update an existing vlan.
47459         #
47460         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47461       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47462       consumes:
47463         - application/json
47464         - application/xml
47465       produces:
47466         - application/json
47467         - application/xml
47468       responses:
47469         "default":
47470           description: Response codes found in [response codes](https://wiki.onap.org/).
47471       parameters:
47472         - name: pnf-name
47473           in: path
47474           description: unique name of Physical Network Function.
47475           required: true
47476           type: string
47477           example: __PNF-NAME__
47478         - name: interface-name
47479           in: path
47480           description: Name that identifies the physical interface
47481           required: true
47482           type: string
47483           example: __INTERFACE-NAME__
47484         - name: interface-name
47485           in: path
47486           description: Name given to the interface
47487           required: true
47488           type: string
47489           example: __INTERFACE-NAME__
47490         - name: vlan-interface
47491           in: path
47492           description: String that identifies the interface
47493           required: true
47494           type: string
47495           example: __VLAN-INTERFACE__
47496         - name: body
47497           in: body
47498           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
47499           required: true
47500           schema:
47501             $ref: "#/definitions/vlan"
47502     patch:
47503       tags:
47504         - Network
47505       summary: update an existing vlan
47506       description: |
47507         Update an existing vlan
47508         #
47509         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47510         The PUT operation will entirely replace an existing object.
47511         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47512         #
47513         Other differences between PUT and PATCH are:
47514         #
47515         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47516         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47517         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47518       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47519       consumes:
47520         - application/json
47521         - application/xml
47522       produces:
47523         - application/json
47524         - application/xml
47525       responses:
47526         "default":
47527           description: Response codes found in [response codes](https://wiki.onap.org/).
47528       parameters:
47529         - name: pnf-name
47530           in: path
47531           description: unique name of Physical Network Function.
47532           required: true
47533           type: string
47534           example: __PNF-NAME__
47535         - name: interface-name
47536           in: path
47537           description: Name that identifies the physical interface
47538           required: true
47539           type: string
47540           example: __INTERFACE-NAME__
47541         - name: interface-name
47542           in: path
47543           description: Name given to the interface
47544           required: true
47545           type: string
47546           example: __INTERFACE-NAME__
47547         - name: vlan-interface
47548           in: path
47549           description: String that identifies the interface
47550           required: true
47551           type: string
47552           example: __VLAN-INTERFACE__
47553         - name: body
47554           in: body
47555           description: vlan object that needs to be created or updated.
47556           required: true
47557           schema:
47558             $ref: "#/patchDefinitions/vlan"
47559     delete:
47560       tags:
47561         - Network
47562       summary: delete an existing vlan
47563       description: delete an existing vlan
47564       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47565       consumes:
47566         - application/json
47567         - application/xml
47568       produces:
47569         - application/json
47570         - application/xml
47571       responses:
47572         "default":
47573           description: Response codes found in [response codes](https://wiki.onap.org/).
47574       parameters:
47575         - name: pnf-name
47576           in: path
47577           description: unique name of Physical Network Function.
47578           required: true
47579           type: string
47580           example: __PNF-NAME__
47581         - name: interface-name
47582           in: path
47583           description: Name that identifies the physical interface
47584           required: true
47585           type: string
47586           example: __INTERFACE-NAME__
47587         - name: interface-name
47588           in: path
47589           description: Name given to the interface
47590           required: true
47591           type: string
47592           example: __INTERFACE-NAME__
47593         - name: vlan-interface
47594           in: path
47595           description: String that identifies the interface
47596           required: true
47597           type: string
47598           example: __VLAN-INTERFACE__
47599         - name: resource-version
47600           in: query
47601           description: resource-version for concurrency
47602           required: true
47603           type: string
47604   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
47605     get:
47606       tags:
47607         - Network
47608       summary: returns vlans
47609       description: returns vlans
47610       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
47611       produces:
47612         - application/json
47613         - application/xml
47614       responses:
47615         "200":
47616           description: successful operation
47617           schema:
47618               $ref: "#/getDefinitions/vlans"
47619         "default":
47620           description: Response codes found in [response codes](https://wiki.onap.org/).
47621       parameters:
47622         - name: pnf-name
47623           in: path
47624           description: unique name of Physical Network Function.
47625           required: true
47626           type: string
47627           example: __PNF-NAME__
47628         - name: interface-name
47629           in: path
47630           description: Name that identifies the physical interface
47631           required: true
47632           type: string
47633           example: __INTERFACE-NAME__
47634         - name: interface-name
47635           in: path
47636           description: Name given to the interface
47637           required: true
47638           type: string
47639           example: __INTERFACE-NAME__
47640         - name: inv-status
47641           in: query
47642           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47643           required: false
47644           type: string
47645         - name: prov-status
47646           in: query
47647           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47648           required: false
47649           type: string
47650         - name: interface-id
47651           in: query
47652           description: ID of interface
47653           required: false
47654           type: string
47655         - name: macaddr
47656           in: query
47657           description: MAC address for the interface
47658           required: false
47659           type: string
47660         - name: network-name
47661           in: query
47662           description: Name of the network
47663           required: false
47664           type: string
47665   /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:
47666     put:
47667       tags:
47668         - Network
47669       summary: see node definition for valid relationships
47670       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
47671       consumes:
47672         - application/json
47673         - application/xml
47674       produces:
47675         - application/json
47676         - application/xml
47677       responses:
47678         "default":
47679           description: Response codes found in [response codes](https://wiki.onap.org/).
47680       parameters:
47681         - name: pnf-name
47682           in: path
47683           description: unique name of Physical Network Function.
47684           required: true
47685           type: string
47686           example: __PNF-NAME__
47687         - name: interface-name
47688           in: path
47689           description: Name that identifies the physical interface
47690           required: true
47691           type: string
47692           example: __INTERFACE-NAME__
47693         - name: interface-name
47694           in: path
47695           description: Name given to the interface
47696           required: true
47697           type: string
47698           example: __INTERFACE-NAME__
47699         - name: pci-id
47700           in: path
47701           description: PCI ID used to identify the sriov-vf
47702           required: true
47703           type: string
47704           example: __PCI-ID__
47705         - name: body
47706           in: body
47707           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
47708           required: true
47709           schema:
47710             $ref: "#/definitions/relationship"
47711     delete:
47712       tags:
47713         - Network
47714       summary: delete an existing relationship
47715       description: delete an existing relationship
47716       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
47717       consumes:
47718         - application/json
47719         - application/xml
47720       produces:
47721         - application/json
47722         - application/xml
47723       responses:
47724         "default":
47725           description: Response codes found in [response codes](https://wiki.onap.org/).
47726       parameters:
47727         - name: pnf-name
47728           in: path
47729           description: unique name of Physical Network Function.
47730           required: true
47731           type: string
47732           example: __PNF-NAME__
47733         - name: interface-name
47734           in: path
47735           description: Name that identifies the physical interface
47736           required: true
47737           type: string
47738           example: __INTERFACE-NAME__
47739         - name: interface-name
47740           in: path
47741           description: Name given to the interface
47742           required: true
47743           type: string
47744           example: __INTERFACE-NAME__
47745         - name: pci-id
47746           in: path
47747           description: PCI ID used to identify the sriov-vf
47748           required: true
47749           type: string
47750           example: __PCI-ID__
47751   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
47752     get:
47753       tags:
47754         - Network
47755       summary: returns sriov-vf
47756       description: returns sriov-vf
47757       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47758       produces:
47759         - application/json
47760         - application/xml
47761       responses:
47762         "200":
47763           description: successful operation
47764           schema:
47765               $ref: "#/getDefinitions/sriov-vf"
47766         "default":
47767           description: Response codes found in [response codes](https://wiki.onap.org/).
47768       parameters:
47769         - name: pnf-name
47770           in: path
47771           description: unique name of Physical Network Function.
47772           required: true
47773           type: string
47774           example: __PNF-NAME__
47775         - name: interface-name
47776           in: path
47777           description: Name that identifies the physical interface
47778           required: true
47779           type: string
47780           example: __INTERFACE-NAME__
47781         - name: interface-name
47782           in: path
47783           description: Name given to the interface
47784           required: true
47785           type: string
47786           example: __INTERFACE-NAME__
47787         - name: pci-id
47788           in: path
47789           description: PCI ID used to identify the sriov-vf
47790           required: true
47791           type: string
47792           example: __PCI-ID__
47793         - name: inv-status
47794           in: query
47795           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47796           required: false
47797           type: string
47798         - name: prov-status
47799           in: query
47800           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47801           required: false
47802           type: string
47803         - name: interface-id
47804           in: query
47805           description: ID of interface
47806           required: false
47807           type: string
47808         - name: macaddr
47809           in: query
47810           description: MAC address for the interface
47811           required: false
47812           type: string
47813         - name: network-name
47814           in: query
47815           description: Name of the network
47816           required: false
47817           type: string
47818         - name: vf-vlan-filter
47819           in: query
47820           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
47821           required: false
47822           type: string
47823         - name: vf-mac-filter
47824           in: query
47825           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
47826           required: false
47827           type: string
47828         - name: vf-vlan-strip
47829           in: query
47830           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
47831           required: false
47832           type: boolean
47833         - name: neutron-network-id
47834           in: query
47835           description: Neutron network id of the interface
47836           required: false
47837           type: string
47838     put:
47839       tags:
47840         - Network
47841       summary: create or update an existing sriov-vf
47842       description: |
47843         Create or update an existing sriov-vf.
47844         #
47845         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47846       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47847       consumes:
47848         - application/json
47849         - application/xml
47850       produces:
47851         - application/json
47852         - application/xml
47853       responses:
47854         "default":
47855           description: Response codes found in [response codes](https://wiki.onap.org/).
47856       parameters:
47857         - name: pnf-name
47858           in: path
47859           description: unique name of Physical Network Function.
47860           required: true
47861           type: string
47862           example: __PNF-NAME__
47863         - name: interface-name
47864           in: path
47865           description: Name that identifies the physical interface
47866           required: true
47867           type: string
47868           example: __INTERFACE-NAME__
47869         - name: interface-name
47870           in: path
47871           description: Name given to the interface
47872           required: true
47873           type: string
47874           example: __INTERFACE-NAME__
47875         - name: pci-id
47876           in: path
47877           description: PCI ID used to identify the sriov-vf
47878           required: true
47879           type: string
47880           example: __PCI-ID__
47881         - name: body
47882           in: body
47883           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
47884           required: true
47885           schema:
47886             $ref: "#/definitions/sriov-vf"
47887     patch:
47888       tags:
47889         - Network
47890       summary: update an existing sriov-vf
47891       description: |
47892         Update an existing sriov-vf
47893         #
47894         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47895         The PUT operation will entirely replace an existing object.
47896         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47897         #
47898         Other differences between PUT and PATCH are:
47899         #
47900         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47901         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47902         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47903       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47904       consumes:
47905         - application/json
47906         - application/xml
47907       produces:
47908         - application/json
47909         - application/xml
47910       responses:
47911         "default":
47912           description: Response codes found in [response codes](https://wiki.onap.org/).
47913       parameters:
47914         - name: pnf-name
47915           in: path
47916           description: unique name of Physical Network Function.
47917           required: true
47918           type: string
47919           example: __PNF-NAME__
47920         - name: interface-name
47921           in: path
47922           description: Name that identifies the physical interface
47923           required: true
47924           type: string
47925           example: __INTERFACE-NAME__
47926         - name: interface-name
47927           in: path
47928           description: Name given to the interface
47929           required: true
47930           type: string
47931           example: __INTERFACE-NAME__
47932         - name: pci-id
47933           in: path
47934           description: PCI ID used to identify the sriov-vf
47935           required: true
47936           type: string
47937           example: __PCI-ID__
47938         - name: body
47939           in: body
47940           description: sriov-vf object that needs to be created or updated.
47941           required: true
47942           schema:
47943             $ref: "#/patchDefinitions/sriov-vf"
47944     delete:
47945       tags:
47946         - Network
47947       summary: delete an existing sriov-vf
47948       description: delete an existing sriov-vf
47949       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47950       consumes:
47951         - application/json
47952         - application/xml
47953       produces:
47954         - application/json
47955         - application/xml
47956       responses:
47957         "default":
47958           description: Response codes found in [response codes](https://wiki.onap.org/).
47959       parameters:
47960         - name: pnf-name
47961           in: path
47962           description: unique name of Physical Network Function.
47963           required: true
47964           type: string
47965           example: __PNF-NAME__
47966         - name: interface-name
47967           in: path
47968           description: Name that identifies the physical interface
47969           required: true
47970           type: string
47971           example: __INTERFACE-NAME__
47972         - name: interface-name
47973           in: path
47974           description: Name given to the interface
47975           required: true
47976           type: string
47977           example: __INTERFACE-NAME__
47978         - name: pci-id
47979           in: path
47980           description: PCI ID used to identify the sriov-vf
47981           required: true
47982           type: string
47983           example: __PCI-ID__
47984         - name: resource-version
47985           in: query
47986           description: resource-version for concurrency
47987           required: true
47988           type: string
47989   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
47990     get:
47991       tags:
47992         - Network
47993       summary: returns sriov-vfs
47994       description: returns sriov-vfs
47995       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
47996       produces:
47997         - application/json
47998         - application/xml
47999       responses:
48000         "200":
48001           description: successful operation
48002           schema:
48003               $ref: "#/getDefinitions/sriov-vfs"
48004         "default":
48005           description: Response codes found in [response codes](https://wiki.onap.org/).
48006       parameters:
48007         - name: pnf-name
48008           in: path
48009           description: unique name of Physical Network Function.
48010           required: true
48011           type: string
48012           example: __PNF-NAME__
48013         - name: interface-name
48014           in: path
48015           description: Name that identifies the physical interface
48016           required: true
48017           type: string
48018           example: __INTERFACE-NAME__
48019         - name: interface-name
48020           in: path
48021           description: Name given to the interface
48022           required: true
48023           type: string
48024           example: __INTERFACE-NAME__
48025         - name: inv-status
48026           in: query
48027           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48028           required: false
48029           type: string
48030         - name: prov-status
48031           in: query
48032           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48033           required: false
48034           type: string
48035         - name: interface-id
48036           in: query
48037           description: ID of interface
48038           required: false
48039           type: string
48040         - name: macaddr
48041           in: query
48042           description: MAC address for the interface
48043           required: false
48044           type: string
48045         - name: network-name
48046           in: query
48047           description: Name of the network
48048           required: false
48049           type: string
48050   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
48051     put:
48052       tags:
48053         - Network
48054       summary: see node definition for valid relationships
48055       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
48056       consumes:
48057         - application/json
48058         - application/xml
48059       produces:
48060         - application/json
48061         - application/xml
48062       responses:
48063         "default":
48064           description: Response codes found in [response codes](https://wiki.onap.org/).
48065       parameters:
48066         - name: pnf-name
48067           in: path
48068           description: unique name of Physical Network Function.
48069           required: true
48070           type: string
48071           example: __PNF-NAME__
48072         - name: interface-name
48073           in: path
48074           description: Name that identifies the physical interface
48075           required: true
48076           type: string
48077           example: __INTERFACE-NAME__
48078         - name: interface-name
48079           in: path
48080           description: Name given to the interface
48081           required: true
48082           type: string
48083           example: __INTERFACE-NAME__
48084         - name: body
48085           in: body
48086           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
48087           required: true
48088           schema:
48089             $ref: "#/definitions/relationship"
48090     delete:
48091       tags:
48092         - Network
48093       summary: delete an existing relationship
48094       description: delete an existing relationship
48095       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
48096       consumes:
48097         - application/json
48098         - application/xml
48099       produces:
48100         - application/json
48101         - application/xml
48102       responses:
48103         "default":
48104           description: Response codes found in [response codes](https://wiki.onap.org/).
48105       parameters:
48106         - name: pnf-name
48107           in: path
48108           description: unique name of Physical Network Function.
48109           required: true
48110           type: string
48111           example: __PNF-NAME__
48112         - name: interface-name
48113           in: path
48114           description: Name that identifies the physical interface
48115           required: true
48116           type: string
48117           example: __INTERFACE-NAME__
48118         - name: interface-name
48119           in: path
48120           description: Name given to the interface
48121           required: true
48122           type: string
48123           example: __INTERFACE-NAME__
48124   /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:
48125     put:
48126       tags:
48127         - Network
48128       summary: see node definition for valid relationships
48129       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
48130       consumes:
48131         - application/json
48132         - application/xml
48133       produces:
48134         - application/json
48135         - application/xml
48136       responses:
48137         "default":
48138           description: Response codes found in [response codes](https://wiki.onap.org/).
48139       parameters:
48140         - name: pnf-name
48141           in: path
48142           description: unique name of Physical Network Function.
48143           required: true
48144           type: string
48145           example: __PNF-NAME__
48146         - name: interface-name
48147           in: path
48148           description: Name that identifies the physical interface
48149           required: true
48150           type: string
48151           example: __INTERFACE-NAME__
48152         - name: interface-name
48153           in: path
48154           description: Name given to the interface
48155           required: true
48156           type: string
48157           example: __INTERFACE-NAME__
48158         - name: l3-interface-ipv4-address
48159           in: path
48160           description: IP address
48161           required: true
48162           type: string
48163           example: __L3-INTERFACE-IPV4-ADDRESS__
48164         - name: body
48165           in: body
48166           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
48167           required: true
48168           schema:
48169             $ref: "#/definitions/relationship"
48170     delete:
48171       tags:
48172         - Network
48173       summary: delete an existing relationship
48174       description: delete an existing relationship
48175       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
48176       consumes:
48177         - application/json
48178         - application/xml
48179       produces:
48180         - application/json
48181         - application/xml
48182       responses:
48183         "default":
48184           description: Response codes found in [response codes](https://wiki.onap.org/).
48185       parameters:
48186         - name: pnf-name
48187           in: path
48188           description: unique name of Physical Network Function.
48189           required: true
48190           type: string
48191           example: __PNF-NAME__
48192         - name: interface-name
48193           in: path
48194           description: Name that identifies the physical interface
48195           required: true
48196           type: string
48197           example: __INTERFACE-NAME__
48198         - name: interface-name
48199           in: path
48200           description: Name given to the interface
48201           required: true
48202           type: string
48203           example: __INTERFACE-NAME__
48204         - name: l3-interface-ipv4-address
48205           in: path
48206           description: IP address
48207           required: true
48208           type: string
48209           example: __L3-INTERFACE-IPV4-ADDRESS__
48210   /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}:
48211     get:
48212       tags:
48213         - Network
48214       summary: returns l3-interface-ipv4-address-list
48215       description: returns l3-interface-ipv4-address-list
48216       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
48217       produces:
48218         - application/json
48219         - application/xml
48220       responses:
48221         "200":
48222           description: successful operation
48223           schema:
48224               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
48225         "default":
48226           description: Response codes found in [response codes](https://wiki.onap.org/).
48227       parameters:
48228         - name: pnf-name
48229           in: path
48230           description: unique name of Physical Network Function.
48231           required: true
48232           type: string
48233           example: __PNF-NAME__
48234         - name: interface-name
48235           in: path
48236           description: Name that identifies the physical interface
48237           required: true
48238           type: string
48239           example: __INTERFACE-NAME__
48240         - name: interface-name
48241           in: path
48242           description: Name given to the interface
48243           required: true
48244           type: string
48245           example: __INTERFACE-NAME__
48246         - name: l3-interface-ipv4-address
48247           in: path
48248           description: IP address
48249           required: true
48250           type: string
48251           example: __L3-INTERFACE-IPV4-ADDRESS__
48252         - name: inv-status
48253           in: query
48254           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48255           required: false
48256           type: string
48257         - name: prov-status
48258           in: query
48259           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48260           required: false
48261           type: string
48262         - name: interface-id
48263           in: query
48264           description: ID of interface
48265           required: false
48266           type: string
48267         - name: macaddr
48268           in: query
48269           description: MAC address for the interface
48270           required: false
48271           type: string
48272         - name: network-name
48273           in: query
48274           description: Name of the network
48275           required: false
48276           type: string
48277         - name: vlan-id-inner
48278           in: query
48279           description: Inner VLAN tag
48280           required: false
48281           type: integer
48282           format: int64
48283         - name: neutron-network-id
48284           in: query
48285           description: Neutron network id of the interface that address belongs to
48286           required: false
48287           type: string
48288         - name: neutron-subnet-id
48289           in: query
48290           description: Neutron id of subnet that address belongs to
48291           required: false
48292           type: string
48293     put:
48294       tags:
48295         - Network
48296       summary: create or update an existing l3-interface-ipv4-address-list
48297       description: |
48298         Create or update an existing l3-interface-ipv4-address-list.
48299         #
48300         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48301       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
48302       consumes:
48303         - application/json
48304         - application/xml
48305       produces:
48306         - application/json
48307         - application/xml
48308       responses:
48309         "default":
48310           description: Response codes found in [response codes](https://wiki.onap.org/).
48311       parameters:
48312         - name: pnf-name
48313           in: path
48314           description: unique name of Physical Network Function.
48315           required: true
48316           type: string
48317           example: __PNF-NAME__
48318         - name: interface-name
48319           in: path
48320           description: Name that identifies the physical interface
48321           required: true
48322           type: string
48323           example: __INTERFACE-NAME__
48324         - name: interface-name
48325           in: path
48326           description: Name given to the interface
48327           required: true
48328           type: string
48329           example: __INTERFACE-NAME__
48330         - name: l3-interface-ipv4-address
48331           in: path
48332           description: IP address
48333           required: true
48334           type: string
48335           example: __L3-INTERFACE-IPV4-ADDRESS__
48336         - name: body
48337           in: body
48338           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
48339           required: true
48340           schema:
48341             $ref: "#/definitions/l3-interface-ipv4-address-list"
48342     patch:
48343       tags:
48344         - Network
48345       summary: update an existing l3-interface-ipv4-address-list
48346       description: |
48347         Update an existing l3-interface-ipv4-address-list
48348         #
48349         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48350         The PUT operation will entirely replace an existing object.
48351         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48352         #
48353         Other differences between PUT and PATCH are:
48354         #
48355         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48356         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48357         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48358       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
48359       consumes:
48360         - application/json
48361         - application/xml
48362       produces:
48363         - application/json
48364         - application/xml
48365       responses:
48366         "default":
48367           description: Response codes found in [response codes](https://wiki.onap.org/).
48368       parameters:
48369         - name: pnf-name
48370           in: path
48371           description: unique name of Physical Network Function.
48372           required: true
48373           type: string
48374           example: __PNF-NAME__
48375         - name: interface-name
48376           in: path
48377           description: Name that identifies the physical interface
48378           required: true
48379           type: string
48380           example: __INTERFACE-NAME__
48381         - name: interface-name
48382           in: path
48383           description: Name given to the interface
48384           required: true
48385           type: string
48386           example: __INTERFACE-NAME__
48387         - name: l3-interface-ipv4-address
48388           in: path
48389           description: IP address
48390           required: true
48391           type: string
48392           example: __L3-INTERFACE-IPV4-ADDRESS__
48393         - name: body
48394           in: body
48395           description: l3-interface-ipv4-address-list object that needs to be created or updated.
48396           required: true
48397           schema:
48398             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
48399     delete:
48400       tags:
48401         - Network
48402       summary: delete an existing l3-interface-ipv4-address-list
48403       description: delete an existing l3-interface-ipv4-address-list
48404       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
48405       consumes:
48406         - application/json
48407         - application/xml
48408       produces:
48409         - application/json
48410         - application/xml
48411       responses:
48412         "default":
48413           description: Response codes found in [response codes](https://wiki.onap.org/).
48414       parameters:
48415         - name: pnf-name
48416           in: path
48417           description: unique name of Physical Network Function.
48418           required: true
48419           type: string
48420           example: __PNF-NAME__
48421         - name: interface-name
48422           in: path
48423           description: Name that identifies the physical interface
48424           required: true
48425           type: string
48426           example: __INTERFACE-NAME__
48427         - name: interface-name
48428           in: path
48429           description: Name given to the interface
48430           required: true
48431           type: string
48432           example: __INTERFACE-NAME__
48433         - name: l3-interface-ipv4-address
48434           in: path
48435           description: IP address
48436           required: true
48437           type: string
48438           example: __L3-INTERFACE-IPV4-ADDRESS__
48439         - name: resource-version
48440           in: query
48441           description: resource-version for concurrency
48442           required: true
48443           type: string
48444   /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:
48445     put:
48446       tags:
48447         - Network
48448       summary: see node definition for valid relationships
48449       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
48450       consumes:
48451         - application/json
48452         - application/xml
48453       produces:
48454         - application/json
48455         - application/xml
48456       responses:
48457         "default":
48458           description: Response codes found in [response codes](https://wiki.onap.org/).
48459       parameters:
48460         - name: pnf-name
48461           in: path
48462           description: unique name of Physical Network Function.
48463           required: true
48464           type: string
48465           example: __PNF-NAME__
48466         - name: interface-name
48467           in: path
48468           description: Name that identifies the physical interface
48469           required: true
48470           type: string
48471           example: __INTERFACE-NAME__
48472         - name: interface-name
48473           in: path
48474           description: Name given to the interface
48475           required: true
48476           type: string
48477           example: __INTERFACE-NAME__
48478         - name: l3-interface-ipv6-address
48479           in: path
48480           description: IP address
48481           required: true
48482           type: string
48483           example: __L3-INTERFACE-IPV6-ADDRESS__
48484         - name: body
48485           in: body
48486           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
48487           required: true
48488           schema:
48489             $ref: "#/definitions/relationship"
48490     delete:
48491       tags:
48492         - Network
48493       summary: delete an existing relationship
48494       description: delete an existing relationship
48495       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
48496       consumes:
48497         - application/json
48498         - application/xml
48499       produces:
48500         - application/json
48501         - application/xml
48502       responses:
48503         "default":
48504           description: Response codes found in [response codes](https://wiki.onap.org/).
48505       parameters:
48506         - name: pnf-name
48507           in: path
48508           description: unique name of Physical Network Function.
48509           required: true
48510           type: string
48511           example: __PNF-NAME__
48512         - name: interface-name
48513           in: path
48514           description: Name that identifies the physical interface
48515           required: true
48516           type: string
48517           example: __INTERFACE-NAME__
48518         - name: interface-name
48519           in: path
48520           description: Name given to the interface
48521           required: true
48522           type: string
48523           example: __INTERFACE-NAME__
48524         - name: l3-interface-ipv6-address
48525           in: path
48526           description: IP address
48527           required: true
48528           type: string
48529           example: __L3-INTERFACE-IPV6-ADDRESS__
48530   /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}:
48531     get:
48532       tags:
48533         - Network
48534       summary: returns l3-interface-ipv6-address-list
48535       description: returns l3-interface-ipv6-address-list
48536       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48537       produces:
48538         - application/json
48539         - application/xml
48540       responses:
48541         "200":
48542           description: successful operation
48543           schema:
48544               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
48545         "default":
48546           description: Response codes found in [response codes](https://wiki.onap.org/).
48547       parameters:
48548         - name: pnf-name
48549           in: path
48550           description: unique name of Physical Network Function.
48551           required: true
48552           type: string
48553           example: __PNF-NAME__
48554         - name: interface-name
48555           in: path
48556           description: Name that identifies the physical interface
48557           required: true
48558           type: string
48559           example: __INTERFACE-NAME__
48560         - name: interface-name
48561           in: path
48562           description: Name given to the interface
48563           required: true
48564           type: string
48565           example: __INTERFACE-NAME__
48566         - name: l3-interface-ipv6-address
48567           in: path
48568           description: IP address
48569           required: true
48570           type: string
48571           example: __L3-INTERFACE-IPV6-ADDRESS__
48572         - name: inv-status
48573           in: query
48574           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48575           required: false
48576           type: string
48577         - name: prov-status
48578           in: query
48579           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48580           required: false
48581           type: string
48582         - name: interface-id
48583           in: query
48584           description: ID of interface
48585           required: false
48586           type: string
48587         - name: macaddr
48588           in: query
48589           description: MAC address for the interface
48590           required: false
48591           type: string
48592         - name: network-name
48593           in: query
48594           description: Name of the network
48595           required: false
48596           type: string
48597         - name: vlan-id-inner
48598           in: query
48599           description: Inner VLAN tag
48600           required: false
48601           type: integer
48602           format: int64
48603         - name: neutron-network-id
48604           in: query
48605           description: Neutron network id of the interface that address belongs to
48606           required: false
48607           type: string
48608         - name: neutron-subnet-id
48609           in: query
48610           description: Neutron id of subnet that address belongs to
48611           required: false
48612           type: string
48613     put:
48614       tags:
48615         - Network
48616       summary: create or update an existing l3-interface-ipv6-address-list
48617       description: |
48618         Create or update an existing l3-interface-ipv6-address-list.
48619         #
48620         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48621       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48622       consumes:
48623         - application/json
48624         - application/xml
48625       produces:
48626         - application/json
48627         - application/xml
48628       responses:
48629         "default":
48630           description: Response codes found in [response codes](https://wiki.onap.org/).
48631       parameters:
48632         - name: pnf-name
48633           in: path
48634           description: unique name of Physical Network Function.
48635           required: true
48636           type: string
48637           example: __PNF-NAME__
48638         - name: interface-name
48639           in: path
48640           description: Name that identifies the physical interface
48641           required: true
48642           type: string
48643           example: __INTERFACE-NAME__
48644         - name: interface-name
48645           in: path
48646           description: Name given to the interface
48647           required: true
48648           type: string
48649           example: __INTERFACE-NAME__
48650         - name: l3-interface-ipv6-address
48651           in: path
48652           description: IP address
48653           required: true
48654           type: string
48655           example: __L3-INTERFACE-IPV6-ADDRESS__
48656         - name: body
48657           in: body
48658           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
48659           required: true
48660           schema:
48661             $ref: "#/definitions/l3-interface-ipv6-address-list"
48662     patch:
48663       tags:
48664         - Network
48665       summary: update an existing l3-interface-ipv6-address-list
48666       description: |
48667         Update an existing l3-interface-ipv6-address-list
48668         #
48669         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48670         The PUT operation will entirely replace an existing object.
48671         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48672         #
48673         Other differences between PUT and PATCH are:
48674         #
48675         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48676         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48677         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48678       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48679       consumes:
48680         - application/json
48681         - application/xml
48682       produces:
48683         - application/json
48684         - application/xml
48685       responses:
48686         "default":
48687           description: Response codes found in [response codes](https://wiki.onap.org/).
48688       parameters:
48689         - name: pnf-name
48690           in: path
48691           description: unique name of Physical Network Function.
48692           required: true
48693           type: string
48694           example: __PNF-NAME__
48695         - name: interface-name
48696           in: path
48697           description: Name that identifies the physical interface
48698           required: true
48699           type: string
48700           example: __INTERFACE-NAME__
48701         - name: interface-name
48702           in: path
48703           description: Name given to the interface
48704           required: true
48705           type: string
48706           example: __INTERFACE-NAME__
48707         - name: l3-interface-ipv6-address
48708           in: path
48709           description: IP address
48710           required: true
48711           type: string
48712           example: __L3-INTERFACE-IPV6-ADDRESS__
48713         - name: body
48714           in: body
48715           description: l3-interface-ipv6-address-list object that needs to be created or updated.
48716           required: true
48717           schema:
48718             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
48719     delete:
48720       tags:
48721         - Network
48722       summary: delete an existing l3-interface-ipv6-address-list
48723       description: delete an existing l3-interface-ipv6-address-list
48724       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48725       consumes:
48726         - application/json
48727         - application/xml
48728       produces:
48729         - application/json
48730         - application/xml
48731       responses:
48732         "default":
48733           description: Response codes found in [response codes](https://wiki.onap.org/).
48734       parameters:
48735         - name: pnf-name
48736           in: path
48737           description: unique name of Physical Network Function.
48738           required: true
48739           type: string
48740           example: __PNF-NAME__
48741         - name: interface-name
48742           in: path
48743           description: Name that identifies the physical interface
48744           required: true
48745           type: string
48746           example: __INTERFACE-NAME__
48747         - name: interface-name
48748           in: path
48749           description: Name given to the interface
48750           required: true
48751           type: string
48752           example: __INTERFACE-NAME__
48753         - name: l3-interface-ipv6-address
48754           in: path
48755           description: IP address
48756           required: true
48757           type: string
48758           example: __L3-INTERFACE-IPV6-ADDRESS__
48759         - name: resource-version
48760           in: query
48761           description: resource-version for concurrency
48762           required: true
48763           type: string
48764   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
48765     get:
48766       tags:
48767         - Network
48768       summary: returns l-interface
48769       description: returns l-interface
48770       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48771       produces:
48772         - application/json
48773         - application/xml
48774       responses:
48775         "200":
48776           description: successful operation
48777           schema:
48778               $ref: "#/getDefinitions/l-interface"
48779         "default":
48780           description: Response codes found in [response codes](https://wiki.onap.org/).
48781       parameters:
48782         - name: pnf-name
48783           in: path
48784           description: unique name of Physical Network Function.
48785           required: true
48786           type: string
48787           example: __PNF-NAME__
48788         - name: interface-name
48789           in: path
48790           description: Name that identifies the physical interface
48791           required: true
48792           type: string
48793           example: __INTERFACE-NAME__
48794         - name: interface-name
48795           in: path
48796           description: Name given to the interface
48797           required: true
48798           type: string
48799           example: __INTERFACE-NAME__
48800         - name: inv-status
48801           in: query
48802           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48803           required: false
48804           type: string
48805         - name: prov-status
48806           in: query
48807           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48808           required: false
48809           type: string
48810         - name: interface-id
48811           in: query
48812           description: ID of interface
48813           required: false
48814           type: string
48815         - name: macaddr
48816           in: query
48817           description: MAC address for the interface
48818           required: false
48819           type: string
48820         - name: network-name
48821           in: query
48822           description: Name of the network
48823           required: false
48824           type: string
48825     put:
48826       tags:
48827         - Network
48828       summary: create or update an existing l-interface
48829       description: |
48830         Create or update an existing l-interface.
48831         #
48832         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48833       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48834       consumes:
48835         - application/json
48836         - application/xml
48837       produces:
48838         - application/json
48839         - application/xml
48840       responses:
48841         "default":
48842           description: Response codes found in [response codes](https://wiki.onap.org/).
48843       parameters:
48844         - name: pnf-name
48845           in: path
48846           description: unique name of Physical Network Function.
48847           required: true
48848           type: string
48849           example: __PNF-NAME__
48850         - name: interface-name
48851           in: path
48852           description: Name that identifies the physical interface
48853           required: true
48854           type: string
48855           example: __INTERFACE-NAME__
48856         - name: interface-name
48857           in: path
48858           description: Name given to the interface
48859           required: true
48860           type: string
48861           example: __INTERFACE-NAME__
48862         - name: body
48863           in: body
48864           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
48865           required: true
48866           schema:
48867             $ref: "#/definitions/l-interface"
48868     patch:
48869       tags:
48870         - Network
48871       summary: update an existing l-interface
48872       description: |
48873         Update an existing l-interface
48874         #
48875         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48876         The PUT operation will entirely replace an existing object.
48877         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48878         #
48879         Other differences between PUT and PATCH are:
48880         #
48881         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48882         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48883         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48884       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48885       consumes:
48886         - application/json
48887         - application/xml
48888       produces:
48889         - application/json
48890         - application/xml
48891       responses:
48892         "default":
48893           description: Response codes found in [response codes](https://wiki.onap.org/).
48894       parameters:
48895         - name: pnf-name
48896           in: path
48897           description: unique name of Physical Network Function.
48898           required: true
48899           type: string
48900           example: __PNF-NAME__
48901         - name: interface-name
48902           in: path
48903           description: Name that identifies the physical interface
48904           required: true
48905           type: string
48906           example: __INTERFACE-NAME__
48907         - name: interface-name
48908           in: path
48909           description: Name given to the interface
48910           required: true
48911           type: string
48912           example: __INTERFACE-NAME__
48913         - name: body
48914           in: body
48915           description: l-interface object that needs to be created or updated.
48916           required: true
48917           schema:
48918             $ref: "#/patchDefinitions/l-interface"
48919     delete:
48920       tags:
48921         - Network
48922       summary: delete an existing l-interface
48923       description: delete an existing l-interface
48924       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48925       consumes:
48926         - application/json
48927         - application/xml
48928       produces:
48929         - application/json
48930         - application/xml
48931       responses:
48932         "default":
48933           description: Response codes found in [response codes](https://wiki.onap.org/).
48934       parameters:
48935         - name: pnf-name
48936           in: path
48937           description: unique name of Physical Network Function.
48938           required: true
48939           type: string
48940           example: __PNF-NAME__
48941         - name: interface-name
48942           in: path
48943           description: Name that identifies the physical interface
48944           required: true
48945           type: string
48946           example: __INTERFACE-NAME__
48947         - name: interface-name
48948           in: path
48949           description: Name given to the interface
48950           required: true
48951           type: string
48952           example: __INTERFACE-NAME__
48953         - name: resource-version
48954           in: query
48955           description: resource-version for concurrency
48956           required: true
48957           type: string
48958   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
48959     get:
48960       tags:
48961         - Network
48962       summary: returns l-interfaces
48963       description: returns l-interfaces
48964       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
48965       produces:
48966         - application/json
48967         - application/xml
48968       responses:
48969         "200":
48970           description: successful operation
48971           schema:
48972               $ref: "#/getDefinitions/l-interfaces"
48973         "default":
48974           description: Response codes found in [response codes](https://wiki.onap.org/).
48975       parameters:
48976         - name: pnf-name
48977           in: path
48978           description: unique name of Physical Network Function.
48979           required: true
48980           type: string
48981           example: __PNF-NAME__
48982         - name: interface-name
48983           in: path
48984           description: Name that identifies the physical interface
48985           required: true
48986           type: string
48987           example: __INTERFACE-NAME__
48988         - name: inv-status
48989           in: query
48990           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48991           required: false
48992           type: string
48993         - name: prov-status
48994           in: query
48995           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48996           required: false
48997           type: string
48998   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
48999     get:
49000       tags:
49001         - Network
49002       summary: returns p-interface
49003       description: returns p-interface
49004       operationId: getNetworkPnfsPnfPInterfacesPInterface
49005       produces:
49006         - application/json
49007         - application/xml
49008       responses:
49009         "200":
49010           description: successful operation
49011           schema:
49012               $ref: "#/getDefinitions/p-interface"
49013         "default":
49014           description: Response codes found in [response codes](https://wiki.onap.org/).
49015       parameters:
49016         - name: pnf-name
49017           in: path
49018           description: unique name of Physical Network Function.
49019           required: true
49020           type: string
49021           example: __PNF-NAME__
49022         - name: interface-name
49023           in: path
49024           description: Name that identifies the physical interface
49025           required: true
49026           type: string
49027           example: __INTERFACE-NAME__
49028         - name: inv-status
49029           in: query
49030           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49031           required: false
49032           type: string
49033         - name: prov-status
49034           in: query
49035           description: Trigger for operational monitoring of this resource by Service Assurance systems.
49036           required: false
49037           type: string
49038     put:
49039       tags:
49040         - Network
49041       summary: create or update an existing p-interface
49042       description: |
49043         Create or update an existing p-interface.
49044         #
49045         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49046       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
49047       consumes:
49048         - application/json
49049         - application/xml
49050       produces:
49051         - application/json
49052         - application/xml
49053       responses:
49054         "default":
49055           description: Response codes found in [response codes](https://wiki.onap.org/).
49056       parameters:
49057         - name: pnf-name
49058           in: path
49059           description: unique name of Physical Network Function.
49060           required: true
49061           type: string
49062           example: __PNF-NAME__
49063         - name: interface-name
49064           in: path
49065           description: Name that identifies the physical interface
49066           required: true
49067           type: string
49068           example: __INTERFACE-NAME__
49069         - name: body
49070           in: body
49071           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
49072           required: true
49073           schema:
49074             $ref: "#/definitions/p-interface"
49075     patch:
49076       tags:
49077         - Network
49078       summary: update an existing p-interface
49079       description: |
49080         Update an existing p-interface
49081         #
49082         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49083         The PUT operation will entirely replace an existing object.
49084         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49085         #
49086         Other differences between PUT and PATCH are:
49087         #
49088         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49089         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49090         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49091       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
49092       consumes:
49093         - application/json
49094         - application/xml
49095       produces:
49096         - application/json
49097         - application/xml
49098       responses:
49099         "default":
49100           description: Response codes found in [response codes](https://wiki.onap.org/).
49101       parameters:
49102         - name: pnf-name
49103           in: path
49104           description: unique name of Physical Network Function.
49105           required: true
49106           type: string
49107           example: __PNF-NAME__
49108         - name: interface-name
49109           in: path
49110           description: Name that identifies the physical interface
49111           required: true
49112           type: string
49113           example: __INTERFACE-NAME__
49114         - name: body
49115           in: body
49116           description: p-interface object that needs to be created or updated.
49117           required: true
49118           schema:
49119             $ref: "#/patchDefinitions/p-interface"
49120     delete:
49121       tags:
49122         - Network
49123       summary: delete an existing p-interface
49124       description: delete an existing p-interface
49125       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
49126       consumes:
49127         - application/json
49128         - application/xml
49129       produces:
49130         - application/json
49131         - application/xml
49132       responses:
49133         "default":
49134           description: Response codes found in [response codes](https://wiki.onap.org/).
49135       parameters:
49136         - name: pnf-name
49137           in: path
49138           description: unique name of Physical Network Function.
49139           required: true
49140           type: string
49141           example: __PNF-NAME__
49142         - name: interface-name
49143           in: path
49144           description: Name that identifies the physical interface
49145           required: true
49146           type: string
49147           example: __INTERFACE-NAME__
49148         - name: resource-version
49149           in: query
49150           description: resource-version for concurrency
49151           required: true
49152           type: string
49153   /network/pnfs/pnf/{pnf-name}/p-interfaces:
49154     get:
49155       tags:
49156         - Network
49157       summary: returns p-interfaces
49158       description: returns p-interfaces
49159       operationId: getNetworkPnfsPnfPInterfaces
49160       produces:
49161         - application/json
49162         - application/xml
49163       responses:
49164         "200":
49165           description: successful operation
49166           schema:
49167               $ref: "#/getDefinitions/p-interfaces"
49168         "default":
49169           description: Response codes found in [response codes](https://wiki.onap.org/).
49170       parameters:
49171         - name: pnf-name
49172           in: path
49173           description: unique name of Physical Network Function.
49174           required: true
49175           type: string
49176           example: __PNF-NAME__
49177         - name: inv-status
49178           in: query
49179           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49180           required: false
49181           type: string
49182   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
49183     put:
49184       tags:
49185         - Network
49186       summary: see node definition for valid relationships
49187       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
49188       consumes:
49189         - application/json
49190         - application/xml
49191       produces:
49192         - application/json
49193         - application/xml
49194       responses:
49195         "default":
49196           description: Response codes found in [response codes](https://wiki.onap.org/).
49197       parameters:
49198         - name: pnf-name
49199           in: path
49200           description: unique name of Physical Network Function.
49201           required: true
49202           type: string
49203           example: __PNF-NAME__
49204         - name: interface-name
49205           in: path
49206           description: Name that identifies the link aggregate interface
49207           required: true
49208           type: string
49209           example: __INTERFACE-NAME__
49210         - name: body
49211           in: body
49212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
49213           required: true
49214           schema:
49215             $ref: "#/definitions/relationship"
49216     delete:
49217       tags:
49218         - Network
49219       summary: delete an existing relationship
49220       description: delete an existing relationship
49221       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
49222       consumes:
49223         - application/json
49224         - application/xml
49225       produces:
49226         - application/json
49227         - application/xml
49228       responses:
49229         "default":
49230           description: Response codes found in [response codes](https://wiki.onap.org/).
49231       parameters:
49232         - name: pnf-name
49233           in: path
49234           description: unique name of Physical Network Function.
49235           required: true
49236           type: string
49237           example: __PNF-NAME__
49238         - name: interface-name
49239           in: path
49240           description: Name that identifies the link aggregate interface
49241           required: true
49242           type: string
49243           example: __INTERFACE-NAME__
49244   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
49245     put:
49246       tags:
49247         - Network
49248       summary: see node definition for valid relationships
49249       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
49250       consumes:
49251         - application/json
49252         - application/xml
49253       produces:
49254         - application/json
49255         - application/xml
49256       responses:
49257         "default":
49258           description: Response codes found in [response codes](https://wiki.onap.org/).
49259       parameters:
49260         - name: pnf-name
49261           in: path
49262           description: unique name of Physical Network Function.
49263           required: true
49264           type: string
49265           example: __PNF-NAME__
49266         - name: interface-name
49267           in: path
49268           description: Name that identifies the link aggregate interface
49269           required: true
49270           type: string
49271           example: __INTERFACE-NAME__
49272         - name: interface-name
49273           in: path
49274           description: Name given to the interface
49275           required: true
49276           type: string
49277           example: __INTERFACE-NAME__
49278         - name: vlan-interface
49279           in: path
49280           description: String that identifies the interface
49281           required: true
49282           type: string
49283           example: __VLAN-INTERFACE__
49284         - name: body
49285           in: body
49286           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
49287           required: true
49288           schema:
49289             $ref: "#/definitions/relationship"
49290     delete:
49291       tags:
49292         - Network
49293       summary: delete an existing relationship
49294       description: delete an existing relationship
49295       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
49296       consumes:
49297         - application/json
49298         - application/xml
49299       produces:
49300         - application/json
49301         - application/xml
49302       responses:
49303         "default":
49304           description: Response codes found in [response codes](https://wiki.onap.org/).
49305       parameters:
49306         - name: pnf-name
49307           in: path
49308           description: unique name of Physical Network Function.
49309           required: true
49310           type: string
49311           example: __PNF-NAME__
49312         - name: interface-name
49313           in: path
49314           description: Name that identifies the link aggregate interface
49315           required: true
49316           type: string
49317           example: __INTERFACE-NAME__
49318         - name: interface-name
49319           in: path
49320           description: Name given to the interface
49321           required: true
49322           type: string
49323           example: __INTERFACE-NAME__
49324         - name: vlan-interface
49325           in: path
49326           description: String that identifies the interface
49327           required: true
49328           type: string
49329           example: __VLAN-INTERFACE__
49330   /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:
49331     put:
49332       tags:
49333         - Network
49334       summary: see node definition for valid relationships
49335       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
49336       consumes:
49337         - application/json
49338         - application/xml
49339       produces:
49340         - application/json
49341         - application/xml
49342       responses:
49343         "default":
49344           description: Response codes found in [response codes](https://wiki.onap.org/).
49345       parameters:
49346         - name: pnf-name
49347           in: path
49348           description: unique name of Physical Network Function.
49349           required: true
49350           type: string
49351           example: __PNF-NAME__
49352         - name: interface-name
49353           in: path
49354           description: Name that identifies the link aggregate interface
49355           required: true
49356           type: string
49357           example: __INTERFACE-NAME__
49358         - name: interface-name
49359           in: path
49360           description: Name given to the interface
49361           required: true
49362           type: string
49363           example: __INTERFACE-NAME__
49364         - name: vlan-interface
49365           in: path
49366           description: String that identifies the interface
49367           required: true
49368           type: string
49369           example: __VLAN-INTERFACE__
49370         - name: l3-interface-ipv4-address
49371           in: path
49372           description: IP address
49373           required: true
49374           type: string
49375           example: __L3-INTERFACE-IPV4-ADDRESS__
49376         - name: body
49377           in: body
49378           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
49379           required: true
49380           schema:
49381             $ref: "#/definitions/relationship"
49382     delete:
49383       tags:
49384         - Network
49385       summary: delete an existing relationship
49386       description: delete an existing relationship
49387       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
49388       consumes:
49389         - application/json
49390         - application/xml
49391       produces:
49392         - application/json
49393         - application/xml
49394       responses:
49395         "default":
49396           description: Response codes found in [response codes](https://wiki.onap.org/).
49397       parameters:
49398         - name: pnf-name
49399           in: path
49400           description: unique name of Physical Network Function.
49401           required: true
49402           type: string
49403           example: __PNF-NAME__
49404         - name: interface-name
49405           in: path
49406           description: Name that identifies the link aggregate interface
49407           required: true
49408           type: string
49409           example: __INTERFACE-NAME__
49410         - name: interface-name
49411           in: path
49412           description: Name given to the interface
49413           required: true
49414           type: string
49415           example: __INTERFACE-NAME__
49416         - name: vlan-interface
49417           in: path
49418           description: String that identifies the interface
49419           required: true
49420           type: string
49421           example: __VLAN-INTERFACE__
49422         - name: l3-interface-ipv4-address
49423           in: path
49424           description: IP address
49425           required: true
49426           type: string
49427           example: __L3-INTERFACE-IPV4-ADDRESS__
49428   /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}:
49429     get:
49430       tags:
49431         - Network
49432       summary: returns l3-interface-ipv4-address-list
49433       description: returns l3-interface-ipv4-address-list
49434       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49435       produces:
49436         - application/json
49437         - application/xml
49438       responses:
49439         "200":
49440           description: successful operation
49441           schema:
49442               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49443         "default":
49444           description: Response codes found in [response codes](https://wiki.onap.org/).
49445       parameters:
49446         - name: pnf-name
49447           in: path
49448           description: unique name of Physical Network Function.
49449           required: true
49450           type: string
49451           example: __PNF-NAME__
49452         - name: interface-name
49453           in: path
49454           description: Name that identifies the link aggregate interface
49455           required: true
49456           type: string
49457           example: __INTERFACE-NAME__
49458         - name: interface-name
49459           in: path
49460           description: Name given to the interface
49461           required: true
49462           type: string
49463           example: __INTERFACE-NAME__
49464         - name: vlan-interface
49465           in: path
49466           description: String that identifies the interface
49467           required: true
49468           type: string
49469           example: __VLAN-INTERFACE__
49470         - name: l3-interface-ipv4-address
49471           in: path
49472           description: IP address
49473           required: true
49474           type: string
49475           example: __L3-INTERFACE-IPV4-ADDRESS__
49476         - name: inv-status
49477           in: query
49478           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49479           required: false
49480           type: string
49481         - name: interface-id
49482           in: query
49483           description: ID of interface
49484           required: false
49485           type: string
49486         - name: interface-role
49487           in: query
49488           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49489           required: false
49490           type: string
49491         - name: interface-id
49492           in: query
49493           description: ID of interface
49494           required: false
49495           type: string
49496         - name: macaddr
49497           in: query
49498           description: MAC address for the interface
49499           required: false
49500           type: string
49501         - name: network-name
49502           in: query
49503           description: Name of the network
49504           required: false
49505           type: string
49506         - name: vlan-id-inner
49507           in: query
49508           description: Inner VLAN tag
49509           required: false
49510           type: integer
49511           format: int64
49512         - name: vpn-key
49513           in: query
49514           description: This indicates the customers VPN ID associated with this vlan
49515           required: false
49516           type: string
49517         - name: vlan-id-inner
49518           in: query
49519           description: Inner VLAN tag
49520           required: false
49521           type: integer
49522           format: int64
49523         - name: neutron-network-id
49524           in: query
49525           description: Neutron network id of the interface that address belongs to
49526           required: false
49527           type: string
49528         - name: neutron-subnet-id
49529           in: query
49530           description: Neutron id of subnet that address belongs to
49531           required: false
49532           type: string
49533     put:
49534       tags:
49535         - Network
49536       summary: create or update an existing l3-interface-ipv4-address-list
49537       description: |
49538         Create or update an existing l3-interface-ipv4-address-list.
49539         #
49540         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49541       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49542       consumes:
49543         - application/json
49544         - application/xml
49545       produces:
49546         - application/json
49547         - application/xml
49548       responses:
49549         "default":
49550           description: Response codes found in [response codes](https://wiki.onap.org/).
49551       parameters:
49552         - name: pnf-name
49553           in: path
49554           description: unique name of Physical Network Function.
49555           required: true
49556           type: string
49557           example: __PNF-NAME__
49558         - name: interface-name
49559           in: path
49560           description: Name that identifies the link aggregate interface
49561           required: true
49562           type: string
49563           example: __INTERFACE-NAME__
49564         - name: interface-name
49565           in: path
49566           description: Name given to the interface
49567           required: true
49568           type: string
49569           example: __INTERFACE-NAME__
49570         - name: vlan-interface
49571           in: path
49572           description: String that identifies the interface
49573           required: true
49574           type: string
49575           example: __VLAN-INTERFACE__
49576         - name: l3-interface-ipv4-address
49577           in: path
49578           description: IP address
49579           required: true
49580           type: string
49581           example: __L3-INTERFACE-IPV4-ADDRESS__
49582         - name: body
49583           in: body
49584           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
49585           required: true
49586           schema:
49587             $ref: "#/definitions/l3-interface-ipv4-address-list"
49588     patch:
49589       tags:
49590         - Network
49591       summary: update an existing l3-interface-ipv4-address-list
49592       description: |
49593         Update an existing l3-interface-ipv4-address-list
49594         #
49595         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49596         The PUT operation will entirely replace an existing object.
49597         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49598         #
49599         Other differences between PUT and PATCH are:
49600         #
49601         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49602         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49603         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49604       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49605       consumes:
49606         - application/json
49607         - application/xml
49608       produces:
49609         - application/json
49610         - application/xml
49611       responses:
49612         "default":
49613           description: Response codes found in [response codes](https://wiki.onap.org/).
49614       parameters:
49615         - name: pnf-name
49616           in: path
49617           description: unique name of Physical Network Function.
49618           required: true
49619           type: string
49620           example: __PNF-NAME__
49621         - name: interface-name
49622           in: path
49623           description: Name that identifies the link aggregate interface
49624           required: true
49625           type: string
49626           example: __INTERFACE-NAME__
49627         - name: interface-name
49628           in: path
49629           description: Name given to the interface
49630           required: true
49631           type: string
49632           example: __INTERFACE-NAME__
49633         - name: vlan-interface
49634           in: path
49635           description: String that identifies the interface
49636           required: true
49637           type: string
49638           example: __VLAN-INTERFACE__
49639         - name: l3-interface-ipv4-address
49640           in: path
49641           description: IP address
49642           required: true
49643           type: string
49644           example: __L3-INTERFACE-IPV4-ADDRESS__
49645         - name: body
49646           in: body
49647           description: l3-interface-ipv4-address-list object that needs to be created or updated.
49648           required: true
49649           schema:
49650             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
49651     delete:
49652       tags:
49653         - Network
49654       summary: delete an existing l3-interface-ipv4-address-list
49655       description: delete an existing l3-interface-ipv4-address-list
49656       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49657       consumes:
49658         - application/json
49659         - application/xml
49660       produces:
49661         - application/json
49662         - application/xml
49663       responses:
49664         "default":
49665           description: Response codes found in [response codes](https://wiki.onap.org/).
49666       parameters:
49667         - name: pnf-name
49668           in: path
49669           description: unique name of Physical Network Function.
49670           required: true
49671           type: string
49672           example: __PNF-NAME__
49673         - name: interface-name
49674           in: path
49675           description: Name that identifies the link aggregate interface
49676           required: true
49677           type: string
49678           example: __INTERFACE-NAME__
49679         - name: interface-name
49680           in: path
49681           description: Name given to the interface
49682           required: true
49683           type: string
49684           example: __INTERFACE-NAME__
49685         - name: vlan-interface
49686           in: path
49687           description: String that identifies the interface
49688           required: true
49689           type: string
49690           example: __VLAN-INTERFACE__
49691         - name: l3-interface-ipv4-address
49692           in: path
49693           description: IP address
49694           required: true
49695           type: string
49696           example: __L3-INTERFACE-IPV4-ADDRESS__
49697         - name: resource-version
49698           in: query
49699           description: resource-version for concurrency
49700           required: true
49701           type: string
49702   /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:
49703     put:
49704       tags:
49705         - Network
49706       summary: see node definition for valid relationships
49707       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
49708       consumes:
49709         - application/json
49710         - application/xml
49711       produces:
49712         - application/json
49713         - application/xml
49714       responses:
49715         "default":
49716           description: Response codes found in [response codes](https://wiki.onap.org/).
49717       parameters:
49718         - name: pnf-name
49719           in: path
49720           description: unique name of Physical Network Function.
49721           required: true
49722           type: string
49723           example: __PNF-NAME__
49724         - name: interface-name
49725           in: path
49726           description: Name that identifies the link aggregate interface
49727           required: true
49728           type: string
49729           example: __INTERFACE-NAME__
49730         - name: interface-name
49731           in: path
49732           description: Name given to the interface
49733           required: true
49734           type: string
49735           example: __INTERFACE-NAME__
49736         - name: vlan-interface
49737           in: path
49738           description: String that identifies the interface
49739           required: true
49740           type: string
49741           example: __VLAN-INTERFACE__
49742         - name: l3-interface-ipv6-address
49743           in: path
49744           description: IP address
49745           required: true
49746           type: string
49747           example: __L3-INTERFACE-IPV6-ADDRESS__
49748         - name: body
49749           in: body
49750           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
49751           required: true
49752           schema:
49753             $ref: "#/definitions/relationship"
49754     delete:
49755       tags:
49756         - Network
49757       summary: delete an existing relationship
49758       description: delete an existing relationship
49759       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
49760       consumes:
49761         - application/json
49762         - application/xml
49763       produces:
49764         - application/json
49765         - application/xml
49766       responses:
49767         "default":
49768           description: Response codes found in [response codes](https://wiki.onap.org/).
49769       parameters:
49770         - name: pnf-name
49771           in: path
49772           description: unique name of Physical Network Function.
49773           required: true
49774           type: string
49775           example: __PNF-NAME__
49776         - name: interface-name
49777           in: path
49778           description: Name that identifies the link aggregate interface
49779           required: true
49780           type: string
49781           example: __INTERFACE-NAME__
49782         - name: interface-name
49783           in: path
49784           description: Name given to the interface
49785           required: true
49786           type: string
49787           example: __INTERFACE-NAME__
49788         - name: vlan-interface
49789           in: path
49790           description: String that identifies the interface
49791           required: true
49792           type: string
49793           example: __VLAN-INTERFACE__
49794         - name: l3-interface-ipv6-address
49795           in: path
49796           description: IP address
49797           required: true
49798           type: string
49799           example: __L3-INTERFACE-IPV6-ADDRESS__
49800   /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}:
49801     get:
49802       tags:
49803         - Network
49804       summary: returns l3-interface-ipv6-address-list
49805       description: returns l3-interface-ipv6-address-list
49806       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49807       produces:
49808         - application/json
49809         - application/xml
49810       responses:
49811         "200":
49812           description: successful operation
49813           schema:
49814               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
49815         "default":
49816           description: Response codes found in [response codes](https://wiki.onap.org/).
49817       parameters:
49818         - name: pnf-name
49819           in: path
49820           description: unique name of Physical Network Function.
49821           required: true
49822           type: string
49823           example: __PNF-NAME__
49824         - name: interface-name
49825           in: path
49826           description: Name that identifies the link aggregate interface
49827           required: true
49828           type: string
49829           example: __INTERFACE-NAME__
49830         - name: interface-name
49831           in: path
49832           description: Name given to the interface
49833           required: true
49834           type: string
49835           example: __INTERFACE-NAME__
49836         - name: vlan-interface
49837           in: path
49838           description: String that identifies the interface
49839           required: true
49840           type: string
49841           example: __VLAN-INTERFACE__
49842         - name: l3-interface-ipv6-address
49843           in: path
49844           description: IP address
49845           required: true
49846           type: string
49847           example: __L3-INTERFACE-IPV6-ADDRESS__
49848         - name: inv-status
49849           in: query
49850           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49851           required: false
49852           type: string
49853         - name: interface-id
49854           in: query
49855           description: ID of interface
49856           required: false
49857           type: string
49858         - name: interface-role
49859           in: query
49860           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49861           required: false
49862           type: string
49863         - name: interface-id
49864           in: query
49865           description: ID of interface
49866           required: false
49867           type: string
49868         - name: macaddr
49869           in: query
49870           description: MAC address for the interface
49871           required: false
49872           type: string
49873         - name: network-name
49874           in: query
49875           description: Name of the network
49876           required: false
49877           type: string
49878         - name: vlan-id-inner
49879           in: query
49880           description: Inner VLAN tag
49881           required: false
49882           type: integer
49883           format: int64
49884         - name: vpn-key
49885           in: query
49886           description: This indicates the customers VPN ID associated with this vlan
49887           required: false
49888           type: string
49889         - name: vlan-id-inner
49890           in: query
49891           description: Inner VLAN tag
49892           required: false
49893           type: integer
49894           format: int64
49895         - name: neutron-network-id
49896           in: query
49897           description: Neutron network id of the interface that address belongs to
49898           required: false
49899           type: string
49900         - name: neutron-subnet-id
49901           in: query
49902           description: Neutron id of subnet that address belongs to
49903           required: false
49904           type: string
49905     put:
49906       tags:
49907         - Network
49908       summary: create or update an existing l3-interface-ipv6-address-list
49909       description: |
49910         Create or update an existing l3-interface-ipv6-address-list.
49911         #
49912         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49913       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49914       consumes:
49915         - application/json
49916         - application/xml
49917       produces:
49918         - application/json
49919         - application/xml
49920       responses:
49921         "default":
49922           description: Response codes found in [response codes](https://wiki.onap.org/).
49923       parameters:
49924         - name: pnf-name
49925           in: path
49926           description: unique name of Physical Network Function.
49927           required: true
49928           type: string
49929           example: __PNF-NAME__
49930         - name: interface-name
49931           in: path
49932           description: Name that identifies the link aggregate interface
49933           required: true
49934           type: string
49935           example: __INTERFACE-NAME__
49936         - name: interface-name
49937           in: path
49938           description: Name given to the interface
49939           required: true
49940           type: string
49941           example: __INTERFACE-NAME__
49942         - name: vlan-interface
49943           in: path
49944           description: String that identifies the interface
49945           required: true
49946           type: string
49947           example: __VLAN-INTERFACE__
49948         - name: l3-interface-ipv6-address
49949           in: path
49950           description: IP address
49951           required: true
49952           type: string
49953           example: __L3-INTERFACE-IPV6-ADDRESS__
49954         - name: body
49955           in: body
49956           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
49957           required: true
49958           schema:
49959             $ref: "#/definitions/l3-interface-ipv6-address-list"
49960     patch:
49961       tags:
49962         - Network
49963       summary: update an existing l3-interface-ipv6-address-list
49964       description: |
49965         Update an existing l3-interface-ipv6-address-list
49966         #
49967         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49968         The PUT operation will entirely replace an existing object.
49969         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49970         #
49971         Other differences between PUT and PATCH are:
49972         #
49973         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49974         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49975         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49976       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49977       consumes:
49978         - application/json
49979         - application/xml
49980       produces:
49981         - application/json
49982         - application/xml
49983       responses:
49984         "default":
49985           description: Response codes found in [response codes](https://wiki.onap.org/).
49986       parameters:
49987         - name: pnf-name
49988           in: path
49989           description: unique name of Physical Network Function.
49990           required: true
49991           type: string
49992           example: __PNF-NAME__
49993         - name: interface-name
49994           in: path
49995           description: Name that identifies the link aggregate interface
49996           required: true
49997           type: string
49998           example: __INTERFACE-NAME__
49999         - name: interface-name
50000           in: path
50001           description: Name given to the interface
50002           required: true
50003           type: string
50004           example: __INTERFACE-NAME__
50005         - name: vlan-interface
50006           in: path
50007           description: String that identifies the interface
50008           required: true
50009           type: string
50010           example: __VLAN-INTERFACE__
50011         - name: l3-interface-ipv6-address
50012           in: path
50013           description: IP address
50014           required: true
50015           type: string
50016           example: __L3-INTERFACE-IPV6-ADDRESS__
50017         - name: body
50018           in: body
50019           description: l3-interface-ipv6-address-list object that needs to be created or updated.
50020           required: true
50021           schema:
50022             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
50023     delete:
50024       tags:
50025         - Network
50026       summary: delete an existing l3-interface-ipv6-address-list
50027       description: delete an existing l3-interface-ipv6-address-list
50028       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
50029       consumes:
50030         - application/json
50031         - application/xml
50032       produces:
50033         - application/json
50034         - application/xml
50035       responses:
50036         "default":
50037           description: Response codes found in [response codes](https://wiki.onap.org/).
50038       parameters:
50039         - name: pnf-name
50040           in: path
50041           description: unique name of Physical Network Function.
50042           required: true
50043           type: string
50044           example: __PNF-NAME__
50045         - name: interface-name
50046           in: path
50047           description: Name that identifies the link aggregate interface
50048           required: true
50049           type: string
50050           example: __INTERFACE-NAME__
50051         - name: interface-name
50052           in: path
50053           description: Name given to the interface
50054           required: true
50055           type: string
50056           example: __INTERFACE-NAME__
50057         - name: vlan-interface
50058           in: path
50059           description: String that identifies the interface
50060           required: true
50061           type: string
50062           example: __VLAN-INTERFACE__
50063         - name: l3-interface-ipv6-address
50064           in: path
50065           description: IP address
50066           required: true
50067           type: string
50068           example: __L3-INTERFACE-IPV6-ADDRESS__
50069         - name: resource-version
50070           in: query
50071           description: resource-version for concurrency
50072           required: true
50073           type: string
50074   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
50075     get:
50076       tags:
50077         - Network
50078       summary: returns vlan
50079       description: returns vlan
50080       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
50081       produces:
50082         - application/json
50083         - application/xml
50084       responses:
50085         "200":
50086           description: successful operation
50087           schema:
50088               $ref: "#/getDefinitions/vlan"
50089         "default":
50090           description: Response codes found in [response codes](https://wiki.onap.org/).
50091       parameters:
50092         - name: pnf-name
50093           in: path
50094           description: unique name of Physical Network Function.
50095           required: true
50096           type: string
50097           example: __PNF-NAME__
50098         - name: interface-name
50099           in: path
50100           description: Name that identifies the link aggregate interface
50101           required: true
50102           type: string
50103           example: __INTERFACE-NAME__
50104         - name: interface-name
50105           in: path
50106           description: Name given to the interface
50107           required: true
50108           type: string
50109           example: __INTERFACE-NAME__
50110         - name: vlan-interface
50111           in: path
50112           description: String that identifies the interface
50113           required: true
50114           type: string
50115           example: __VLAN-INTERFACE__
50116         - name: inv-status
50117           in: query
50118           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50119           required: false
50120           type: string
50121         - name: interface-id
50122           in: query
50123           description: ID of interface
50124           required: false
50125           type: string
50126         - name: interface-role
50127           in: query
50128           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50129           required: false
50130           type: string
50131         - name: interface-id
50132           in: query
50133           description: ID of interface
50134           required: false
50135           type: string
50136         - name: macaddr
50137           in: query
50138           description: MAC address for the interface
50139           required: false
50140           type: string
50141         - name: network-name
50142           in: query
50143           description: Name of the network
50144           required: false
50145           type: string
50146         - name: vlan-id-inner
50147           in: query
50148           description: Inner VLAN tag
50149           required: false
50150           type: integer
50151           format: int64
50152         - name: vpn-key
50153           in: query
50154           description: This indicates the customers VPN ID associated with this vlan
50155           required: false
50156           type: string
50157     put:
50158       tags:
50159         - Network
50160       summary: create or update an existing vlan
50161       description: |
50162         Create or update an existing vlan.
50163         #
50164         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50165       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
50166       consumes:
50167         - application/json
50168         - application/xml
50169       produces:
50170         - application/json
50171         - application/xml
50172       responses:
50173         "default":
50174           description: Response codes found in [response codes](https://wiki.onap.org/).
50175       parameters:
50176         - name: pnf-name
50177           in: path
50178           description: unique name of Physical Network Function.
50179           required: true
50180           type: string
50181           example: __PNF-NAME__
50182         - name: interface-name
50183           in: path
50184           description: Name that identifies the link aggregate interface
50185           required: true
50186           type: string
50187           example: __INTERFACE-NAME__
50188         - name: interface-name
50189           in: path
50190           description: Name given to the interface
50191           required: true
50192           type: string
50193           example: __INTERFACE-NAME__
50194         - name: vlan-interface
50195           in: path
50196           description: String that identifies the interface
50197           required: true
50198           type: string
50199           example: __VLAN-INTERFACE__
50200         - name: body
50201           in: body
50202           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
50203           required: true
50204           schema:
50205             $ref: "#/definitions/vlan"
50206     patch:
50207       tags:
50208         - Network
50209       summary: update an existing vlan
50210       description: |
50211         Update an existing vlan
50212         #
50213         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50214         The PUT operation will entirely replace an existing object.
50215         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50216         #
50217         Other differences between PUT and PATCH are:
50218         #
50219         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50220         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50221         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50222       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
50223       consumes:
50224         - application/json
50225         - application/xml
50226       produces:
50227         - application/json
50228         - application/xml
50229       responses:
50230         "default":
50231           description: Response codes found in [response codes](https://wiki.onap.org/).
50232       parameters:
50233         - name: pnf-name
50234           in: path
50235           description: unique name of Physical Network Function.
50236           required: true
50237           type: string
50238           example: __PNF-NAME__
50239         - name: interface-name
50240           in: path
50241           description: Name that identifies the link aggregate interface
50242           required: true
50243           type: string
50244           example: __INTERFACE-NAME__
50245         - name: interface-name
50246           in: path
50247           description: Name given to the interface
50248           required: true
50249           type: string
50250           example: __INTERFACE-NAME__
50251         - name: vlan-interface
50252           in: path
50253           description: String that identifies the interface
50254           required: true
50255           type: string
50256           example: __VLAN-INTERFACE__
50257         - name: body
50258           in: body
50259           description: vlan object that needs to be created or updated.
50260           required: true
50261           schema:
50262             $ref: "#/patchDefinitions/vlan"
50263     delete:
50264       tags:
50265         - Network
50266       summary: delete an existing vlan
50267       description: delete an existing vlan
50268       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
50269       consumes:
50270         - application/json
50271         - application/xml
50272       produces:
50273         - application/json
50274         - application/xml
50275       responses:
50276         "default":
50277           description: Response codes found in [response codes](https://wiki.onap.org/).
50278       parameters:
50279         - name: pnf-name
50280           in: path
50281           description: unique name of Physical Network Function.
50282           required: true
50283           type: string
50284           example: __PNF-NAME__
50285         - name: interface-name
50286           in: path
50287           description: Name that identifies the link aggregate interface
50288           required: true
50289           type: string
50290           example: __INTERFACE-NAME__
50291         - name: interface-name
50292           in: path
50293           description: Name given to the interface
50294           required: true
50295           type: string
50296           example: __INTERFACE-NAME__
50297         - name: vlan-interface
50298           in: path
50299           description: String that identifies the interface
50300           required: true
50301           type: string
50302           example: __VLAN-INTERFACE__
50303         - name: resource-version
50304           in: query
50305           description: resource-version for concurrency
50306           required: true
50307           type: string
50308   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
50309     get:
50310       tags:
50311         - Network
50312       summary: returns vlans
50313       description: returns vlans
50314       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
50315       produces:
50316         - application/json
50317         - application/xml
50318       responses:
50319         "200":
50320           description: successful operation
50321           schema:
50322               $ref: "#/getDefinitions/vlans"
50323         "default":
50324           description: Response codes found in [response codes](https://wiki.onap.org/).
50325       parameters:
50326         - name: pnf-name
50327           in: path
50328           description: unique name of Physical Network Function.
50329           required: true
50330           type: string
50331           example: __PNF-NAME__
50332         - name: interface-name
50333           in: path
50334           description: Name that identifies the link aggregate interface
50335           required: true
50336           type: string
50337           example: __INTERFACE-NAME__
50338         - name: interface-name
50339           in: path
50340           description: Name given to the interface
50341           required: true
50342           type: string
50343           example: __INTERFACE-NAME__
50344         - name: inv-status
50345           in: query
50346           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50347           required: false
50348           type: string
50349         - name: interface-id
50350           in: query
50351           description: ID of interface
50352           required: false
50353           type: string
50354         - name: interface-role
50355           in: query
50356           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50357           required: false
50358           type: string
50359         - name: interface-id
50360           in: query
50361           description: ID of interface
50362           required: false
50363           type: string
50364         - name: macaddr
50365           in: query
50366           description: MAC address for the interface
50367           required: false
50368           type: string
50369         - name: network-name
50370           in: query
50371           description: Name of the network
50372           required: false
50373           type: string
50374   /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:
50375     put:
50376       tags:
50377         - Network
50378       summary: see node definition for valid relationships
50379       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
50380       consumes:
50381         - application/json
50382         - application/xml
50383       produces:
50384         - application/json
50385         - application/xml
50386       responses:
50387         "default":
50388           description: Response codes found in [response codes](https://wiki.onap.org/).
50389       parameters:
50390         - name: pnf-name
50391           in: path
50392           description: unique name of Physical Network Function.
50393           required: true
50394           type: string
50395           example: __PNF-NAME__
50396         - name: interface-name
50397           in: path
50398           description: Name that identifies the link aggregate interface
50399           required: true
50400           type: string
50401           example: __INTERFACE-NAME__
50402         - name: interface-name
50403           in: path
50404           description: Name given to the interface
50405           required: true
50406           type: string
50407           example: __INTERFACE-NAME__
50408         - name: pci-id
50409           in: path
50410           description: PCI ID used to identify the sriov-vf
50411           required: true
50412           type: string
50413           example: __PCI-ID__
50414         - name: body
50415           in: body
50416           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
50417           required: true
50418           schema:
50419             $ref: "#/definitions/relationship"
50420     delete:
50421       tags:
50422         - Network
50423       summary: delete an existing relationship
50424       description: delete an existing relationship
50425       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
50426       consumes:
50427         - application/json
50428         - application/xml
50429       produces:
50430         - application/json
50431         - application/xml
50432       responses:
50433         "default":
50434           description: Response codes found in [response codes](https://wiki.onap.org/).
50435       parameters:
50436         - name: pnf-name
50437           in: path
50438           description: unique name of Physical Network Function.
50439           required: true
50440           type: string
50441           example: __PNF-NAME__
50442         - name: interface-name
50443           in: path
50444           description: Name that identifies the link aggregate interface
50445           required: true
50446           type: string
50447           example: __INTERFACE-NAME__
50448         - name: interface-name
50449           in: path
50450           description: Name given to the interface
50451           required: true
50452           type: string
50453           example: __INTERFACE-NAME__
50454         - name: pci-id
50455           in: path
50456           description: PCI ID used to identify the sriov-vf
50457           required: true
50458           type: string
50459           example: __PCI-ID__
50460   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
50461     get:
50462       tags:
50463         - Network
50464       summary: returns sriov-vf
50465       description: returns sriov-vf
50466       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50467       produces:
50468         - application/json
50469         - application/xml
50470       responses:
50471         "200":
50472           description: successful operation
50473           schema:
50474               $ref: "#/getDefinitions/sriov-vf"
50475         "default":
50476           description: Response codes found in [response codes](https://wiki.onap.org/).
50477       parameters:
50478         - name: pnf-name
50479           in: path
50480           description: unique name of Physical Network Function.
50481           required: true
50482           type: string
50483           example: __PNF-NAME__
50484         - name: interface-name
50485           in: path
50486           description: Name that identifies the link aggregate interface
50487           required: true
50488           type: string
50489           example: __INTERFACE-NAME__
50490         - name: interface-name
50491           in: path
50492           description: Name given to the interface
50493           required: true
50494           type: string
50495           example: __INTERFACE-NAME__
50496         - name: pci-id
50497           in: path
50498           description: PCI ID used to identify the sriov-vf
50499           required: true
50500           type: string
50501           example: __PCI-ID__
50502         - name: inv-status
50503           in: query
50504           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50505           required: false
50506           type: string
50507         - name: interface-id
50508           in: query
50509           description: ID of interface
50510           required: false
50511           type: string
50512         - name: interface-role
50513           in: query
50514           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50515           required: false
50516           type: string
50517         - name: interface-id
50518           in: query
50519           description: ID of interface
50520           required: false
50521           type: string
50522         - name: macaddr
50523           in: query
50524           description: MAC address for the interface
50525           required: false
50526           type: string
50527         - name: network-name
50528           in: query
50529           description: Name of the network
50530           required: false
50531           type: string
50532         - name: vf-vlan-filter
50533           in: query
50534           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
50535           required: false
50536           type: string
50537         - name: vf-mac-filter
50538           in: query
50539           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
50540           required: false
50541           type: string
50542         - name: vf-vlan-strip
50543           in: query
50544           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
50545           required: false
50546           type: boolean
50547         - name: neutron-network-id
50548           in: query
50549           description: Neutron network id of the interface
50550           required: false
50551           type: string
50552     put:
50553       tags:
50554         - Network
50555       summary: create or update an existing sriov-vf
50556       description: |
50557         Create or update an existing sriov-vf.
50558         #
50559         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50560       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50561       consumes:
50562         - application/json
50563         - application/xml
50564       produces:
50565         - application/json
50566         - application/xml
50567       responses:
50568         "default":
50569           description: Response codes found in [response codes](https://wiki.onap.org/).
50570       parameters:
50571         - name: pnf-name
50572           in: path
50573           description: unique name of Physical Network Function.
50574           required: true
50575           type: string
50576           example: __PNF-NAME__
50577         - name: interface-name
50578           in: path
50579           description: Name that identifies the link aggregate interface
50580           required: true
50581           type: string
50582           example: __INTERFACE-NAME__
50583         - name: interface-name
50584           in: path
50585           description: Name given to the interface
50586           required: true
50587           type: string
50588           example: __INTERFACE-NAME__
50589         - name: pci-id
50590           in: path
50591           description: PCI ID used to identify the sriov-vf
50592           required: true
50593           type: string
50594           example: __PCI-ID__
50595         - name: body
50596           in: body
50597           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
50598           required: true
50599           schema:
50600             $ref: "#/definitions/sriov-vf"
50601     patch:
50602       tags:
50603         - Network
50604       summary: update an existing sriov-vf
50605       description: |
50606         Update an existing sriov-vf
50607         #
50608         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50609         The PUT operation will entirely replace an existing object.
50610         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50611         #
50612         Other differences between PUT and PATCH are:
50613         #
50614         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50615         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50616         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50617       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50618       consumes:
50619         - application/json
50620         - application/xml
50621       produces:
50622         - application/json
50623         - application/xml
50624       responses:
50625         "default":
50626           description: Response codes found in [response codes](https://wiki.onap.org/).
50627       parameters:
50628         - name: pnf-name
50629           in: path
50630           description: unique name of Physical Network Function.
50631           required: true
50632           type: string
50633           example: __PNF-NAME__
50634         - name: interface-name
50635           in: path
50636           description: Name that identifies the link aggregate interface
50637           required: true
50638           type: string
50639           example: __INTERFACE-NAME__
50640         - name: interface-name
50641           in: path
50642           description: Name given to the interface
50643           required: true
50644           type: string
50645           example: __INTERFACE-NAME__
50646         - name: pci-id
50647           in: path
50648           description: PCI ID used to identify the sriov-vf
50649           required: true
50650           type: string
50651           example: __PCI-ID__
50652         - name: body
50653           in: body
50654           description: sriov-vf object that needs to be created or updated.
50655           required: true
50656           schema:
50657             $ref: "#/patchDefinitions/sriov-vf"
50658     delete:
50659       tags:
50660         - Network
50661       summary: delete an existing sriov-vf
50662       description: delete an existing sriov-vf
50663       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50664       consumes:
50665         - application/json
50666         - application/xml
50667       produces:
50668         - application/json
50669         - application/xml
50670       responses:
50671         "default":
50672           description: Response codes found in [response codes](https://wiki.onap.org/).
50673       parameters:
50674         - name: pnf-name
50675           in: path
50676           description: unique name of Physical Network Function.
50677           required: true
50678           type: string
50679           example: __PNF-NAME__
50680         - name: interface-name
50681           in: path
50682           description: Name that identifies the link aggregate interface
50683           required: true
50684           type: string
50685           example: __INTERFACE-NAME__
50686         - name: interface-name
50687           in: path
50688           description: Name given to the interface
50689           required: true
50690           type: string
50691           example: __INTERFACE-NAME__
50692         - name: pci-id
50693           in: path
50694           description: PCI ID used to identify the sriov-vf
50695           required: true
50696           type: string
50697           example: __PCI-ID__
50698         - name: resource-version
50699           in: query
50700           description: resource-version for concurrency
50701           required: true
50702           type: string
50703   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
50704     get:
50705       tags:
50706         - Network
50707       summary: returns sriov-vfs
50708       description: returns sriov-vfs
50709       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
50710       produces:
50711         - application/json
50712         - application/xml
50713       responses:
50714         "200":
50715           description: successful operation
50716           schema:
50717               $ref: "#/getDefinitions/sriov-vfs"
50718         "default":
50719           description: Response codes found in [response codes](https://wiki.onap.org/).
50720       parameters:
50721         - name: pnf-name
50722           in: path
50723           description: unique name of Physical Network Function.
50724           required: true
50725           type: string
50726           example: __PNF-NAME__
50727         - name: interface-name
50728           in: path
50729           description: Name that identifies the link aggregate interface
50730           required: true
50731           type: string
50732           example: __INTERFACE-NAME__
50733         - name: interface-name
50734           in: path
50735           description: Name given to the interface
50736           required: true
50737           type: string
50738           example: __INTERFACE-NAME__
50739         - name: inv-status
50740           in: query
50741           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50742           required: false
50743           type: string
50744         - name: interface-id
50745           in: query
50746           description: ID of interface
50747           required: false
50748           type: string
50749         - name: interface-role
50750           in: query
50751           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50752           required: false
50753           type: string
50754         - name: interface-id
50755           in: query
50756           description: ID of interface
50757           required: false
50758           type: string
50759         - name: macaddr
50760           in: query
50761           description: MAC address for the interface
50762           required: false
50763           type: string
50764         - name: network-name
50765           in: query
50766           description: Name of the network
50767           required: false
50768           type: string
50769   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
50770     put:
50771       tags:
50772         - Network
50773       summary: see node definition for valid relationships
50774       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
50775       consumes:
50776         - application/json
50777         - application/xml
50778       produces:
50779         - application/json
50780         - application/xml
50781       responses:
50782         "default":
50783           description: Response codes found in [response codes](https://wiki.onap.org/).
50784       parameters:
50785         - name: pnf-name
50786           in: path
50787           description: unique name of Physical Network Function.
50788           required: true
50789           type: string
50790           example: __PNF-NAME__
50791         - name: interface-name
50792           in: path
50793           description: Name that identifies the link aggregate interface
50794           required: true
50795           type: string
50796           example: __INTERFACE-NAME__
50797         - name: interface-name
50798           in: path
50799           description: Name given to the interface
50800           required: true
50801           type: string
50802           example: __INTERFACE-NAME__
50803         - name: body
50804           in: body
50805           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
50806           required: true
50807           schema:
50808             $ref: "#/definitions/relationship"
50809     delete:
50810       tags:
50811         - Network
50812       summary: delete an existing relationship
50813       description: delete an existing relationship
50814       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
50815       consumes:
50816         - application/json
50817         - application/xml
50818       produces:
50819         - application/json
50820         - application/xml
50821       responses:
50822         "default":
50823           description: Response codes found in [response codes](https://wiki.onap.org/).
50824       parameters:
50825         - name: pnf-name
50826           in: path
50827           description: unique name of Physical Network Function.
50828           required: true
50829           type: string
50830           example: __PNF-NAME__
50831         - name: interface-name
50832           in: path
50833           description: Name that identifies the link aggregate interface
50834           required: true
50835           type: string
50836           example: __INTERFACE-NAME__
50837         - name: interface-name
50838           in: path
50839           description: Name given to the interface
50840           required: true
50841           type: string
50842           example: __INTERFACE-NAME__
50843   /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:
50844     put:
50845       tags:
50846         - Network
50847       summary: see node definition for valid relationships
50848       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
50849       consumes:
50850         - application/json
50851         - application/xml
50852       produces:
50853         - application/json
50854         - application/xml
50855       responses:
50856         "default":
50857           description: Response codes found in [response codes](https://wiki.onap.org/).
50858       parameters:
50859         - name: pnf-name
50860           in: path
50861           description: unique name of Physical Network Function.
50862           required: true
50863           type: string
50864           example: __PNF-NAME__
50865         - name: interface-name
50866           in: path
50867           description: Name that identifies the link aggregate interface
50868           required: true
50869           type: string
50870           example: __INTERFACE-NAME__
50871         - name: interface-name
50872           in: path
50873           description: Name given to the interface
50874           required: true
50875           type: string
50876           example: __INTERFACE-NAME__
50877         - name: l3-interface-ipv4-address
50878           in: path
50879           description: IP address
50880           required: true
50881           type: string
50882           example: __L3-INTERFACE-IPV4-ADDRESS__
50883         - name: body
50884           in: body
50885           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
50886           required: true
50887           schema:
50888             $ref: "#/definitions/relationship"
50889     delete:
50890       tags:
50891         - Network
50892       summary: delete an existing relationship
50893       description: delete an existing relationship
50894       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
50895       consumes:
50896         - application/json
50897         - application/xml
50898       produces:
50899         - application/json
50900         - application/xml
50901       responses:
50902         "default":
50903           description: Response codes found in [response codes](https://wiki.onap.org/).
50904       parameters:
50905         - name: pnf-name
50906           in: path
50907           description: unique name of Physical Network Function.
50908           required: true
50909           type: string
50910           example: __PNF-NAME__
50911         - name: interface-name
50912           in: path
50913           description: Name that identifies the link aggregate interface
50914           required: true
50915           type: string
50916           example: __INTERFACE-NAME__
50917         - name: interface-name
50918           in: path
50919           description: Name given to the interface
50920           required: true
50921           type: string
50922           example: __INTERFACE-NAME__
50923         - name: l3-interface-ipv4-address
50924           in: path
50925           description: IP address
50926           required: true
50927           type: string
50928           example: __L3-INTERFACE-IPV4-ADDRESS__
50929   /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}:
50930     get:
50931       tags:
50932         - Network
50933       summary: returns l3-interface-ipv4-address-list
50934       description: returns l3-interface-ipv4-address-list
50935       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
50936       produces:
50937         - application/json
50938         - application/xml
50939       responses:
50940         "200":
50941           description: successful operation
50942           schema:
50943               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
50944         "default":
50945           description: Response codes found in [response codes](https://wiki.onap.org/).
50946       parameters:
50947         - name: pnf-name
50948           in: path
50949           description: unique name of Physical Network Function.
50950           required: true
50951           type: string
50952           example: __PNF-NAME__
50953         - name: interface-name
50954           in: path
50955           description: Name that identifies the link aggregate interface
50956           required: true
50957           type: string
50958           example: __INTERFACE-NAME__
50959         - name: interface-name
50960           in: path
50961           description: Name given to the interface
50962           required: true
50963           type: string
50964           example: __INTERFACE-NAME__
50965         - name: l3-interface-ipv4-address
50966           in: path
50967           description: IP address
50968           required: true
50969           type: string
50970           example: __L3-INTERFACE-IPV4-ADDRESS__
50971         - name: inv-status
50972           in: query
50973           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50974           required: false
50975           type: string
50976         - name: interface-id
50977           in: query
50978           description: ID of interface
50979           required: false
50980           type: string
50981         - name: interface-role
50982           in: query
50983           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50984           required: false
50985           type: string
50986         - name: interface-id
50987           in: query
50988           description: ID of interface
50989           required: false
50990           type: string
50991         - name: macaddr
50992           in: query
50993           description: MAC address for the interface
50994           required: false
50995           type: string
50996         - name: network-name
50997           in: query
50998           description: Name of the network
50999           required: false
51000           type: string
51001         - name: vlan-id-inner
51002           in: query
51003           description: Inner VLAN tag
51004           required: false
51005           type: integer
51006           format: int64
51007         - name: neutron-network-id
51008           in: query
51009           description: Neutron network id of the interface that address belongs to
51010           required: false
51011           type: string
51012         - name: neutron-subnet-id
51013           in: query
51014           description: Neutron id of subnet that address belongs to
51015           required: false
51016           type: string
51017     put:
51018       tags:
51019         - Network
51020       summary: create or update an existing l3-interface-ipv4-address-list
51021       description: |
51022         Create or update an existing l3-interface-ipv4-address-list.
51023         #
51024         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51025       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
51026       consumes:
51027         - application/json
51028         - application/xml
51029       produces:
51030         - application/json
51031         - application/xml
51032       responses:
51033         "default":
51034           description: Response codes found in [response codes](https://wiki.onap.org/).
51035       parameters:
51036         - name: pnf-name
51037           in: path
51038           description: unique name of Physical Network Function.
51039           required: true
51040           type: string
51041           example: __PNF-NAME__
51042         - name: interface-name
51043           in: path
51044           description: Name that identifies the link aggregate interface
51045           required: true
51046           type: string
51047           example: __INTERFACE-NAME__
51048         - name: interface-name
51049           in: path
51050           description: Name given to the interface
51051           required: true
51052           type: string
51053           example: __INTERFACE-NAME__
51054         - name: l3-interface-ipv4-address
51055           in: path
51056           description: IP address
51057           required: true
51058           type: string
51059           example: __L3-INTERFACE-IPV4-ADDRESS__
51060         - name: body
51061           in: body
51062           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
51063           required: true
51064           schema:
51065             $ref: "#/definitions/l3-interface-ipv4-address-list"
51066     patch:
51067       tags:
51068         - Network
51069       summary: update an existing l3-interface-ipv4-address-list
51070       description: |
51071         Update an existing l3-interface-ipv4-address-list
51072         #
51073         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51074         The PUT operation will entirely replace an existing object.
51075         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51076         #
51077         Other differences between PUT and PATCH are:
51078         #
51079         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51080         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51081         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51082       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
51083       consumes:
51084         - application/json
51085         - application/xml
51086       produces:
51087         - application/json
51088         - application/xml
51089       responses:
51090         "default":
51091           description: Response codes found in [response codes](https://wiki.onap.org/).
51092       parameters:
51093         - name: pnf-name
51094           in: path
51095           description: unique name of Physical Network Function.
51096           required: true
51097           type: string
51098           example: __PNF-NAME__
51099         - name: interface-name
51100           in: path
51101           description: Name that identifies the link aggregate interface
51102           required: true
51103           type: string
51104           example: __INTERFACE-NAME__
51105         - name: interface-name
51106           in: path
51107           description: Name given to the interface
51108           required: true
51109           type: string
51110           example: __INTERFACE-NAME__
51111         - name: l3-interface-ipv4-address
51112           in: path
51113           description: IP address
51114           required: true
51115           type: string
51116           example: __L3-INTERFACE-IPV4-ADDRESS__
51117         - name: body
51118           in: body
51119           description: l3-interface-ipv4-address-list object that needs to be created or updated.
51120           required: true
51121           schema:
51122             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
51123     delete:
51124       tags:
51125         - Network
51126       summary: delete an existing l3-interface-ipv4-address-list
51127       description: delete an existing l3-interface-ipv4-address-list
51128       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
51129       consumes:
51130         - application/json
51131         - application/xml
51132       produces:
51133         - application/json
51134         - application/xml
51135       responses:
51136         "default":
51137           description: Response codes found in [response codes](https://wiki.onap.org/).
51138       parameters:
51139         - name: pnf-name
51140           in: path
51141           description: unique name of Physical Network Function.
51142           required: true
51143           type: string
51144           example: __PNF-NAME__
51145         - name: interface-name
51146           in: path
51147           description: Name that identifies the link aggregate interface
51148           required: true
51149           type: string
51150           example: __INTERFACE-NAME__
51151         - name: interface-name
51152           in: path
51153           description: Name given to the interface
51154           required: true
51155           type: string
51156           example: __INTERFACE-NAME__
51157         - name: l3-interface-ipv4-address
51158           in: path
51159           description: IP address
51160           required: true
51161           type: string
51162           example: __L3-INTERFACE-IPV4-ADDRESS__
51163         - name: resource-version
51164           in: query
51165           description: resource-version for concurrency
51166           required: true
51167           type: string
51168   /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:
51169     put:
51170       tags:
51171         - Network
51172       summary: see node definition for valid relationships
51173       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
51174       consumes:
51175         - application/json
51176         - application/xml
51177       produces:
51178         - application/json
51179         - application/xml
51180       responses:
51181         "default":
51182           description: Response codes found in [response codes](https://wiki.onap.org/).
51183       parameters:
51184         - name: pnf-name
51185           in: path
51186           description: unique name of Physical Network Function.
51187           required: true
51188           type: string
51189           example: __PNF-NAME__
51190         - name: interface-name
51191           in: path
51192           description: Name that identifies the link aggregate interface
51193           required: true
51194           type: string
51195           example: __INTERFACE-NAME__
51196         - name: interface-name
51197           in: path
51198           description: Name given to the interface
51199           required: true
51200           type: string
51201           example: __INTERFACE-NAME__
51202         - name: l3-interface-ipv6-address
51203           in: path
51204           description: IP address
51205           required: true
51206           type: string
51207           example: __L3-INTERFACE-IPV6-ADDRESS__
51208         - name: body
51209           in: body
51210           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
51211           required: true
51212           schema:
51213             $ref: "#/definitions/relationship"
51214     delete:
51215       tags:
51216         - Network
51217       summary: delete an existing relationship
51218       description: delete an existing relationship
51219       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
51220       consumes:
51221         - application/json
51222         - application/xml
51223       produces:
51224         - application/json
51225         - application/xml
51226       responses:
51227         "default":
51228           description: Response codes found in [response codes](https://wiki.onap.org/).
51229       parameters:
51230         - name: pnf-name
51231           in: path
51232           description: unique name of Physical Network Function.
51233           required: true
51234           type: string
51235           example: __PNF-NAME__
51236         - name: interface-name
51237           in: path
51238           description: Name that identifies the link aggregate interface
51239           required: true
51240           type: string
51241           example: __INTERFACE-NAME__
51242         - name: interface-name
51243           in: path
51244           description: Name given to the interface
51245           required: true
51246           type: string
51247           example: __INTERFACE-NAME__
51248         - name: l3-interface-ipv6-address
51249           in: path
51250           description: IP address
51251           required: true
51252           type: string
51253           example: __L3-INTERFACE-IPV6-ADDRESS__
51254   /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}:
51255     get:
51256       tags:
51257         - Network
51258       summary: returns l3-interface-ipv6-address-list
51259       description: returns l3-interface-ipv6-address-list
51260       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
51261       produces:
51262         - application/json
51263         - application/xml
51264       responses:
51265         "200":
51266           description: successful operation
51267           schema:
51268               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
51269         "default":
51270           description: Response codes found in [response codes](https://wiki.onap.org/).
51271       parameters:
51272         - name: pnf-name
51273           in: path
51274           description: unique name of Physical Network Function.
51275           required: true
51276           type: string
51277           example: __PNF-NAME__
51278         - name: interface-name
51279           in: path
51280           description: Name that identifies the link aggregate interface
51281           required: true
51282           type: string
51283           example: __INTERFACE-NAME__
51284         - name: interface-name
51285           in: path
51286           description: Name given to the interface
51287           required: true
51288           type: string
51289           example: __INTERFACE-NAME__
51290         - name: l3-interface-ipv6-address
51291           in: path
51292           description: IP address
51293           required: true
51294           type: string
51295           example: __L3-INTERFACE-IPV6-ADDRESS__
51296         - name: inv-status
51297           in: query
51298           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51299           required: false
51300           type: string
51301         - name: interface-id
51302           in: query
51303           description: ID of interface
51304           required: false
51305           type: string
51306         - name: interface-role
51307           in: query
51308           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51309           required: false
51310           type: string
51311         - name: interface-id
51312           in: query
51313           description: ID of interface
51314           required: false
51315           type: string
51316         - name: macaddr
51317           in: query
51318           description: MAC address for the interface
51319           required: false
51320           type: string
51321         - name: network-name
51322           in: query
51323           description: Name of the network
51324           required: false
51325           type: string
51326         - name: vlan-id-inner
51327           in: query
51328           description: Inner VLAN tag
51329           required: false
51330           type: integer
51331           format: int64
51332         - name: neutron-network-id
51333           in: query
51334           description: Neutron network id of the interface that address belongs to
51335           required: false
51336           type: string
51337         - name: neutron-subnet-id
51338           in: query
51339           description: Neutron id of subnet that address belongs to
51340           required: false
51341           type: string
51342     put:
51343       tags:
51344         - Network
51345       summary: create or update an existing l3-interface-ipv6-address-list
51346       description: |
51347         Create or update an existing l3-interface-ipv6-address-list.
51348         #
51349         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51350       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
51351       consumes:
51352         - application/json
51353         - application/xml
51354       produces:
51355         - application/json
51356         - application/xml
51357       responses:
51358         "default":
51359           description: Response codes found in [response codes](https://wiki.onap.org/).
51360       parameters:
51361         - name: pnf-name
51362           in: path
51363           description: unique name of Physical Network Function.
51364           required: true
51365           type: string
51366           example: __PNF-NAME__
51367         - name: interface-name
51368           in: path
51369           description: Name that identifies the link aggregate interface
51370           required: true
51371           type: string
51372           example: __INTERFACE-NAME__
51373         - name: interface-name
51374           in: path
51375           description: Name given to the interface
51376           required: true
51377           type: string
51378           example: __INTERFACE-NAME__
51379         - name: l3-interface-ipv6-address
51380           in: path
51381           description: IP address
51382           required: true
51383           type: string
51384           example: __L3-INTERFACE-IPV6-ADDRESS__
51385         - name: body
51386           in: body
51387           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
51388           required: true
51389           schema:
51390             $ref: "#/definitions/l3-interface-ipv6-address-list"
51391     patch:
51392       tags:
51393         - Network
51394       summary: update an existing l3-interface-ipv6-address-list
51395       description: |
51396         Update an existing l3-interface-ipv6-address-list
51397         #
51398         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51399         The PUT operation will entirely replace an existing object.
51400         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51401         #
51402         Other differences between PUT and PATCH are:
51403         #
51404         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51405         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51406         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51407       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
51408       consumes:
51409         - application/json
51410         - application/xml
51411       produces:
51412         - application/json
51413         - application/xml
51414       responses:
51415         "default":
51416           description: Response codes found in [response codes](https://wiki.onap.org/).
51417       parameters:
51418         - name: pnf-name
51419           in: path
51420           description: unique name of Physical Network Function.
51421           required: true
51422           type: string
51423           example: __PNF-NAME__
51424         - name: interface-name
51425           in: path
51426           description: Name that identifies the link aggregate interface
51427           required: true
51428           type: string
51429           example: __INTERFACE-NAME__
51430         - name: interface-name
51431           in: path
51432           description: Name given to the interface
51433           required: true
51434           type: string
51435           example: __INTERFACE-NAME__
51436         - name: l3-interface-ipv6-address
51437           in: path
51438           description: IP address
51439           required: true
51440           type: string
51441           example: __L3-INTERFACE-IPV6-ADDRESS__
51442         - name: body
51443           in: body
51444           description: l3-interface-ipv6-address-list object that needs to be created or updated.
51445           required: true
51446           schema:
51447             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
51448     delete:
51449       tags:
51450         - Network
51451       summary: delete an existing l3-interface-ipv6-address-list
51452       description: delete an existing l3-interface-ipv6-address-list
51453       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
51454       consumes:
51455         - application/json
51456         - application/xml
51457       produces:
51458         - application/json
51459         - application/xml
51460       responses:
51461         "default":
51462           description: Response codes found in [response codes](https://wiki.onap.org/).
51463       parameters:
51464         - name: pnf-name
51465           in: path
51466           description: unique name of Physical Network Function.
51467           required: true
51468           type: string
51469           example: __PNF-NAME__
51470         - name: interface-name
51471           in: path
51472           description: Name that identifies the link aggregate interface
51473           required: true
51474           type: string
51475           example: __INTERFACE-NAME__
51476         - name: interface-name
51477           in: path
51478           description: Name given to the interface
51479           required: true
51480           type: string
51481           example: __INTERFACE-NAME__
51482         - name: l3-interface-ipv6-address
51483           in: path
51484           description: IP address
51485           required: true
51486           type: string
51487           example: __L3-INTERFACE-IPV6-ADDRESS__
51488         - name: resource-version
51489           in: query
51490           description: resource-version for concurrency
51491           required: true
51492           type: string
51493   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
51494     get:
51495       tags:
51496         - Network
51497       summary: returns l-interface
51498       description: returns l-interface
51499       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51500       produces:
51501         - application/json
51502         - application/xml
51503       responses:
51504         "200":
51505           description: successful operation
51506           schema:
51507               $ref: "#/getDefinitions/l-interface"
51508         "default":
51509           description: Response codes found in [response codes](https://wiki.onap.org/).
51510       parameters:
51511         - name: pnf-name
51512           in: path
51513           description: unique name of Physical Network Function.
51514           required: true
51515           type: string
51516           example: __PNF-NAME__
51517         - name: interface-name
51518           in: path
51519           description: Name that identifies the link aggregate interface
51520           required: true
51521           type: string
51522           example: __INTERFACE-NAME__
51523         - name: interface-name
51524           in: path
51525           description: Name given to the interface
51526           required: true
51527           type: string
51528           example: __INTERFACE-NAME__
51529         - name: inv-status
51530           in: query
51531           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51532           required: false
51533           type: string
51534         - name: interface-id
51535           in: query
51536           description: ID of interface
51537           required: false
51538           type: string
51539         - name: interface-role
51540           in: query
51541           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51542           required: false
51543           type: string
51544         - name: interface-id
51545           in: query
51546           description: ID of interface
51547           required: false
51548           type: string
51549         - name: macaddr
51550           in: query
51551           description: MAC address for the interface
51552           required: false
51553           type: string
51554         - name: network-name
51555           in: query
51556           description: Name of the network
51557           required: false
51558           type: string
51559     put:
51560       tags:
51561         - Network
51562       summary: create or update an existing l-interface
51563       description: |
51564         Create or update an existing l-interface.
51565         #
51566         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51567       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51568       consumes:
51569         - application/json
51570         - application/xml
51571       produces:
51572         - application/json
51573         - application/xml
51574       responses:
51575         "default":
51576           description: Response codes found in [response codes](https://wiki.onap.org/).
51577       parameters:
51578         - name: pnf-name
51579           in: path
51580           description: unique name of Physical Network Function.
51581           required: true
51582           type: string
51583           example: __PNF-NAME__
51584         - name: interface-name
51585           in: path
51586           description: Name that identifies the link aggregate interface
51587           required: true
51588           type: string
51589           example: __INTERFACE-NAME__
51590         - name: interface-name
51591           in: path
51592           description: Name given to the interface
51593           required: true
51594           type: string
51595           example: __INTERFACE-NAME__
51596         - name: body
51597           in: body
51598           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
51599           required: true
51600           schema:
51601             $ref: "#/definitions/l-interface"
51602     patch:
51603       tags:
51604         - Network
51605       summary: update an existing l-interface
51606       description: |
51607         Update an existing l-interface
51608         #
51609         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51610         The PUT operation will entirely replace an existing object.
51611         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51612         #
51613         Other differences between PUT and PATCH are:
51614         #
51615         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51616         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51617         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51618       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51619       consumes:
51620         - application/json
51621         - application/xml
51622       produces:
51623         - application/json
51624         - application/xml
51625       responses:
51626         "default":
51627           description: Response codes found in [response codes](https://wiki.onap.org/).
51628       parameters:
51629         - name: pnf-name
51630           in: path
51631           description: unique name of Physical Network Function.
51632           required: true
51633           type: string
51634           example: __PNF-NAME__
51635         - name: interface-name
51636           in: path
51637           description: Name that identifies the link aggregate interface
51638           required: true
51639           type: string
51640           example: __INTERFACE-NAME__
51641         - name: interface-name
51642           in: path
51643           description: Name given to the interface
51644           required: true
51645           type: string
51646           example: __INTERFACE-NAME__
51647         - name: body
51648           in: body
51649           description: l-interface object that needs to be created or updated.
51650           required: true
51651           schema:
51652             $ref: "#/patchDefinitions/l-interface"
51653     delete:
51654       tags:
51655         - Network
51656       summary: delete an existing l-interface
51657       description: delete an existing l-interface
51658       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51659       consumes:
51660         - application/json
51661         - application/xml
51662       produces:
51663         - application/json
51664         - application/xml
51665       responses:
51666         "default":
51667           description: Response codes found in [response codes](https://wiki.onap.org/).
51668       parameters:
51669         - name: pnf-name
51670           in: path
51671           description: unique name of Physical Network Function.
51672           required: true
51673           type: string
51674           example: __PNF-NAME__
51675         - name: interface-name
51676           in: path
51677           description: Name that identifies the link aggregate interface
51678           required: true
51679           type: string
51680           example: __INTERFACE-NAME__
51681         - name: interface-name
51682           in: path
51683           description: Name given to the interface
51684           required: true
51685           type: string
51686           example: __INTERFACE-NAME__
51687         - name: resource-version
51688           in: query
51689           description: resource-version for concurrency
51690           required: true
51691           type: string
51692   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
51693     get:
51694       tags:
51695         - Network
51696       summary: returns l-interfaces
51697       description: returns l-interfaces
51698       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
51699       produces:
51700         - application/json
51701         - application/xml
51702       responses:
51703         "200":
51704           description: successful operation
51705           schema:
51706               $ref: "#/getDefinitions/l-interfaces"
51707         "default":
51708           description: Response codes found in [response codes](https://wiki.onap.org/).
51709       parameters:
51710         - name: pnf-name
51711           in: path
51712           description: unique name of Physical Network Function.
51713           required: true
51714           type: string
51715           example: __PNF-NAME__
51716         - name: interface-name
51717           in: path
51718           description: Name that identifies the link aggregate interface
51719           required: true
51720           type: string
51721           example: __INTERFACE-NAME__
51722         - name: inv-status
51723           in: query
51724           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51725           required: false
51726           type: string
51727         - name: interface-id
51728           in: query
51729           description: ID of interface
51730           required: false
51731           type: string
51732         - name: interface-role
51733           in: query
51734           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51735           required: false
51736           type: string
51737   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
51738     get:
51739       tags:
51740         - Network
51741       summary: returns lag-interface
51742       description: returns lag-interface
51743       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
51744       produces:
51745         - application/json
51746         - application/xml
51747       responses:
51748         "200":
51749           description: successful operation
51750           schema:
51751               $ref: "#/getDefinitions/lag-interface"
51752         "default":
51753           description: Response codes found in [response codes](https://wiki.onap.org/).
51754       parameters:
51755         - name: pnf-name
51756           in: path
51757           description: unique name of Physical Network Function.
51758           required: true
51759           type: string
51760           example: __PNF-NAME__
51761         - name: interface-name
51762           in: path
51763           description: Name that identifies the link aggregate interface
51764           required: true
51765           type: string
51766           example: __INTERFACE-NAME__
51767         - name: inv-status
51768           in: query
51769           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51770           required: false
51771           type: string
51772         - name: interface-id
51773           in: query
51774           description: ID of interface
51775           required: false
51776           type: string
51777         - name: interface-role
51778           in: query
51779           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51780           required: false
51781           type: string
51782     put:
51783       tags:
51784         - Network
51785       summary: create or update an existing lag-interface
51786       description: |
51787         Create or update an existing lag-interface.
51788         #
51789         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51790       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
51791       consumes:
51792         - application/json
51793         - application/xml
51794       produces:
51795         - application/json
51796         - application/xml
51797       responses:
51798         "default":
51799           description: Response codes found in [response codes](https://wiki.onap.org/).
51800       parameters:
51801         - name: pnf-name
51802           in: path
51803           description: unique name of Physical Network Function.
51804           required: true
51805           type: string
51806           example: __PNF-NAME__
51807         - name: interface-name
51808           in: path
51809           description: Name that identifies the link aggregate interface
51810           required: true
51811           type: string
51812           example: __INTERFACE-NAME__
51813         - name: body
51814           in: body
51815           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
51816           required: true
51817           schema:
51818             $ref: "#/definitions/lag-interface"
51819     patch:
51820       tags:
51821         - Network
51822       summary: update an existing lag-interface
51823       description: |
51824         Update an existing lag-interface
51825         #
51826         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51827         The PUT operation will entirely replace an existing object.
51828         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51829         #
51830         Other differences between PUT and PATCH are:
51831         #
51832         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51833         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51834         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51835       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
51836       consumes:
51837         - application/json
51838         - application/xml
51839       produces:
51840         - application/json
51841         - application/xml
51842       responses:
51843         "default":
51844           description: Response codes found in [response codes](https://wiki.onap.org/).
51845       parameters:
51846         - name: pnf-name
51847           in: path
51848           description: unique name of Physical Network Function.
51849           required: true
51850           type: string
51851           example: __PNF-NAME__
51852         - name: interface-name
51853           in: path
51854           description: Name that identifies the link aggregate interface
51855           required: true
51856           type: string
51857           example: __INTERFACE-NAME__
51858         - name: body
51859           in: body
51860           description: lag-interface object that needs to be created or updated.
51861           required: true
51862           schema:
51863             $ref: "#/patchDefinitions/lag-interface"
51864     delete:
51865       tags:
51866         - Network
51867       summary: delete an existing lag-interface
51868       description: delete an existing lag-interface
51869       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
51870       consumes:
51871         - application/json
51872         - application/xml
51873       produces:
51874         - application/json
51875         - application/xml
51876       responses:
51877         "default":
51878           description: Response codes found in [response codes](https://wiki.onap.org/).
51879       parameters:
51880         - name: pnf-name
51881           in: path
51882           description: unique name of Physical Network Function.
51883           required: true
51884           type: string
51885           example: __PNF-NAME__
51886         - name: interface-name
51887           in: path
51888           description: Name that identifies the link aggregate interface
51889           required: true
51890           type: string
51891           example: __INTERFACE-NAME__
51892         - name: resource-version
51893           in: query
51894           description: resource-version for concurrency
51895           required: true
51896           type: string
51897   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
51898     get:
51899       tags:
51900         - Network
51901       summary: returns lag-interfaces
51902       description: returns lag-interfaces
51903       operationId: getNetworkPnfsPnfLagInterfaces
51904       produces:
51905         - application/json
51906         - application/xml
51907       responses:
51908         "200":
51909           description: successful operation
51910           schema:
51911               $ref: "#/getDefinitions/lag-interfaces"
51912         "default":
51913           description: Response codes found in [response codes](https://wiki.onap.org/).
51914       parameters:
51915         - name: pnf-name
51916           in: path
51917           description: unique name of Physical Network Function.
51918           required: true
51919           type: string
51920           example: __PNF-NAME__
51921         - name: inv-status
51922           in: query
51923           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51924           required: false
51925           type: string
51926   /network/pnfs/pnf/{pnf-name}:
51927     get:
51928       tags:
51929         - Network
51930       summary: returns pnf
51931       description: returns pnf
51932       operationId: getNetworkPnfsPnf
51933       produces:
51934         - application/json
51935         - application/xml
51936       responses:
51937         "200":
51938           description: successful operation
51939           schema:
51940               $ref: "#/getDefinitions/pnf"
51941         "default":
51942           description: Response codes found in [response codes](https://wiki.onap.org/).
51943       parameters:
51944         - name: pnf-name
51945           in: path
51946           description: unique name of Physical Network Function.
51947           required: true
51948           type: string
51949           example: __PNF-NAME__
51950         - name: inv-status
51951           in: query
51952           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51953           required: false
51954           type: string
51955     put:
51956       tags:
51957         - Network
51958       summary: create or update an existing pnf
51959       description: |
51960         Create or update an existing pnf.
51961         #
51962         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51963       operationId: createOrUpdateNetworkPnfsPnf
51964       consumes:
51965         - application/json
51966         - application/xml
51967       produces:
51968         - application/json
51969         - application/xml
51970       responses:
51971         "default":
51972           description: Response codes found in [response codes](https://wiki.onap.org/).
51973       parameters:
51974         - name: pnf-name
51975           in: path
51976           description: unique name of Physical Network Function.
51977           required: true
51978           type: string
51979           example: __PNF-NAME__
51980         - name: body
51981           in: body
51982           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
51983           required: true
51984           schema:
51985             $ref: "#/definitions/pnf"
51986     patch:
51987       tags:
51988         - Network
51989       summary: update an existing pnf
51990       description: |
51991         Update an existing pnf
51992         #
51993         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51994         The PUT operation will entirely replace an existing object.
51995         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51996         #
51997         Other differences between PUT and PATCH are:
51998         #
51999         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52000         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52001         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52002       operationId: UpdateNetworkPnfsPnf
52003       consumes:
52004         - application/json
52005         - application/xml
52006       produces:
52007         - application/json
52008         - application/xml
52009       responses:
52010         "default":
52011           description: Response codes found in [response codes](https://wiki.onap.org/).
52012       parameters:
52013         - name: pnf-name
52014           in: path
52015           description: unique name of Physical Network Function.
52016           required: true
52017           type: string
52018           example: __PNF-NAME__
52019         - name: body
52020           in: body
52021           description: pnf object that needs to be created or updated.
52022           required: true
52023           schema:
52024             $ref: "#/patchDefinitions/pnf"
52025     delete:
52026       tags:
52027         - Network
52028       summary: delete an existing pnf
52029       description: delete an existing pnf
52030       operationId: deleteNetworkPnfsPnf
52031       consumes:
52032         - application/json
52033         - application/xml
52034       produces:
52035         - application/json
52036         - application/xml
52037       responses:
52038         "default":
52039           description: Response codes found in [response codes](https://wiki.onap.org/).
52040       parameters:
52041         - name: pnf-name
52042           in: path
52043           description: unique name of Physical Network Function.
52044           required: true
52045           type: string
52046           example: __PNF-NAME__
52047         - name: resource-version
52048           in: query
52049           description: resource-version for concurrency
52050           required: true
52051           type: string
52052   /network/pnfs:
52053     get:
52054       tags:
52055         - Network
52056       summary: returns pnfs
52057       description: returns pnfs
52058       operationId: getNetworkPnfs
52059       produces:
52060         - application/json
52061         - application/xml
52062       responses:
52063         "200":
52064           description: successful operation
52065           schema:
52066               $ref: "#/getDefinitions/pnfs"
52067         "default":
52068           description: Response codes found in [response codes](https://wiki.onap.org/).
52069   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
52070     put:
52071       tags:
52072         - Network
52073       summary: see node definition for valid relationships
52074       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
52075       consumes:
52076         - application/json
52077         - application/xml
52078       produces:
52079         - application/json
52080         - application/xml
52081       responses:
52082         "default":
52083           description: Response codes found in [response codes](https://wiki.onap.org/).
52084       parameters:
52085         - name: link-name
52086           in: path
52087           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
52088           required: true
52089           type: string
52090           example: __LINK-NAME__
52091         - name: body
52092           in: body
52093           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
52094           required: true
52095           schema:
52096             $ref: "#/definitions/relationship"
52097     delete:
52098       tags:
52099         - Network
52100       summary: delete an existing relationship
52101       description: delete an existing relationship
52102       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
52103       consumes:
52104         - application/json
52105         - application/xml
52106       produces:
52107         - application/json
52108         - application/xml
52109       responses:
52110         "default":
52111           description: Response codes found in [response codes](https://wiki.onap.org/).
52112       parameters:
52113         - name: link-name
52114           in: path
52115           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
52116           required: true
52117           type: string
52118           example: __LINK-NAME__
52119   /network/physical-links/physical-link/{link-name}:
52120     get:
52121       tags:
52122         - Network
52123       summary: returns physical-link
52124       description: returns physical-link
52125       operationId: getNetworkPhysicalLinksPhysicalLink
52126       produces:
52127         - application/json
52128         - application/xml
52129       responses:
52130         "200":
52131           description: successful operation
52132           schema:
52133               $ref: "#/getDefinitions/physical-link"
52134         "default":
52135           description: Response codes found in [response codes](https://wiki.onap.org/).
52136       parameters:
52137         - name: link-name
52138           in: path
52139           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
52140           required: true
52141           type: string
52142           example: __LINK-NAME__
52143         - name: circuit-id
52144           in: query
52145           description: Circuit it
52146           required: false
52147           type: string
52148     put:
52149       tags:
52150         - Network
52151       summary: create or update an existing physical-link
52152       description: |
52153         Create or update an existing physical-link.
52154         #
52155         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52156       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
52157       consumes:
52158         - application/json
52159         - application/xml
52160       produces:
52161         - application/json
52162         - application/xml
52163       responses:
52164         "default":
52165           description: Response codes found in [response codes](https://wiki.onap.org/).
52166       parameters:
52167         - name: link-name
52168           in: path
52169           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
52170           required: true
52171           type: string
52172           example: __LINK-NAME__
52173         - name: body
52174           in: body
52175           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
52176           required: true
52177           schema:
52178             $ref: "#/definitions/physical-link"
52179     patch:
52180       tags:
52181         - Network
52182       summary: update an existing physical-link
52183       description: |
52184         Update an existing physical-link
52185         #
52186         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52187         The PUT operation will entirely replace an existing object.
52188         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52189         #
52190         Other differences between PUT and PATCH are:
52191         #
52192         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52193         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52194         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52195       operationId: UpdateNetworkPhysicalLinksPhysicalLink
52196       consumes:
52197         - application/json
52198         - application/xml
52199       produces:
52200         - application/json
52201         - application/xml
52202       responses:
52203         "default":
52204           description: Response codes found in [response codes](https://wiki.onap.org/).
52205       parameters:
52206         - name: link-name
52207           in: path
52208           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
52209           required: true
52210           type: string
52211           example: __LINK-NAME__
52212         - name: body
52213           in: body
52214           description: physical-link object that needs to be created or updated.
52215           required: true
52216           schema:
52217             $ref: "#/patchDefinitions/physical-link"
52218     delete:
52219       tags:
52220         - Network
52221       summary: delete an existing physical-link
52222       description: delete an existing physical-link
52223       operationId: deleteNetworkPhysicalLinksPhysicalLink
52224       consumes:
52225         - application/json
52226         - application/xml
52227       produces:
52228         - application/json
52229         - application/xml
52230       responses:
52231         "default":
52232           description: Response codes found in [response codes](https://wiki.onap.org/).
52233       parameters:
52234         - name: link-name
52235           in: path
52236           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
52237           required: true
52238           type: string
52239           example: __LINK-NAME__
52240         - name: resource-version
52241           in: query
52242           description: resource-version for concurrency
52243           required: true
52244           type: string
52245   /network/physical-links:
52246     get:
52247       tags:
52248         - Network
52249       summary: returns physical-links
52250       description: returns physical-links
52251       operationId: getNetworkPhysicalLinks
52252       produces:
52253         - application/json
52254         - application/xml
52255       responses:
52256         "200":
52257           description: successful operation
52258           schema:
52259               $ref: "#/getDefinitions/physical-links"
52260         "default":
52261           description: Response codes found in [response codes](https://wiki.onap.org/).
52262   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
52263     put:
52264       tags:
52265         - Network
52266       summary: see node definition for valid relationships
52267       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
52268       consumes:
52269         - application/json
52270         - application/xml
52271       produces:
52272         - application/json
52273         - application/xml
52274       responses:
52275         "default":
52276           description: Response codes found in [response codes](https://wiki.onap.org/).
52277       parameters:
52278         - name: ipsec-configuration-id
52279           in: path
52280           description: UUID of this configuration
52281           required: true
52282           type: string
52283           example: __IPSEC-CONFIGURATION-ID__
52284         - name: body
52285           in: body
52286           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
52287           required: true
52288           schema:
52289             $ref: "#/definitions/relationship"
52290     delete:
52291       tags:
52292         - Network
52293       summary: delete an existing relationship
52294       description: delete an existing relationship
52295       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
52296       consumes:
52297         - application/json
52298         - application/xml
52299       produces:
52300         - application/json
52301         - application/xml
52302       responses:
52303         "default":
52304           description: Response codes found in [response codes](https://wiki.onap.org/).
52305       parameters:
52306         - name: ipsec-configuration-id
52307           in: path
52308           description: UUID of this configuration
52309           required: true
52310           type: string
52311           example: __IPSEC-CONFIGURATION-ID__
52312   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
52313     put:
52314       tags:
52315         - Network
52316       summary: see node definition for valid relationships
52317       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
52318       consumes:
52319         - application/json
52320         - application/xml
52321       produces:
52322         - application/json
52323         - application/xml
52324       responses:
52325         "default":
52326           description: Response codes found in [response codes](https://wiki.onap.org/).
52327       parameters:
52328         - name: ipsec-configuration-id
52329           in: path
52330           description: UUID of this configuration
52331           required: true
52332           type: string
52333           example: __IPSEC-CONFIGURATION-ID__
52334         - name: vig-address-type
52335           in: path
52336           description: indicates whether the VIG is for AVPN or INTERNET
52337           required: true
52338           type: string
52339           example: __VIG-ADDRESS-TYPE__
52340         - name: body
52341           in: body
52342           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
52343           required: true
52344           schema:
52345             $ref: "#/definitions/relationship"
52346     delete:
52347       tags:
52348         - Network
52349       summary: delete an existing relationship
52350       description: delete an existing relationship
52351       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
52352       consumes:
52353         - application/json
52354         - application/xml
52355       produces:
52356         - application/json
52357         - application/xml
52358       responses:
52359         "default":
52360           description: Response codes found in [response codes](https://wiki.onap.org/).
52361       parameters:
52362         - name: ipsec-configuration-id
52363           in: path
52364           description: UUID of this configuration
52365           required: true
52366           type: string
52367           example: __IPSEC-CONFIGURATION-ID__
52368         - name: vig-address-type
52369           in: path
52370           description: indicates whether the VIG is for AVPN or INTERNET
52371           required: true
52372           type: string
52373           example: __VIG-ADDRESS-TYPE__
52374   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
52375     get:
52376       tags:
52377         - Network
52378       summary: returns vig-server
52379       description: returns vig-server
52380       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52381       produces:
52382         - application/json
52383         - application/xml
52384       responses:
52385         "200":
52386           description: successful operation
52387           schema:
52388               $ref: "#/getDefinitions/vig-server"
52389         "default":
52390           description: Response codes found in [response codes](https://wiki.onap.org/).
52391       parameters:
52392         - name: ipsec-configuration-id
52393           in: path
52394           description: UUID of this configuration
52395           required: true
52396           type: string
52397           example: __IPSEC-CONFIGURATION-ID__
52398         - name: vig-address-type
52399           in: path
52400           description: indicates whether the VIG is for AVPN or INTERNET
52401           required: true
52402           type: string
52403           example: __VIG-ADDRESS-TYPE__
52404     put:
52405       tags:
52406         - Network
52407       summary: create or update an existing vig-server
52408       description: |
52409         Create or update an existing vig-server.
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: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
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: ipsec-configuration-id
52424           in: path
52425           description: UUID of this configuration
52426           required: true
52427           type: string
52428           example: __IPSEC-CONFIGURATION-ID__
52429         - name: vig-address-type
52430           in: path
52431           description: indicates whether the VIG is for AVPN or INTERNET
52432           required: true
52433           type: string
52434           example: __VIG-ADDRESS-TYPE__
52435         - name: body
52436           in: body
52437           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
52438           required: true
52439           schema:
52440             $ref: "#/definitions/vig-server"
52441     patch:
52442       tags:
52443         - Network
52444       summary: update an existing vig-server
52445       description: |
52446         Update an existing vig-server
52447         #
52448         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52449         The PUT operation will entirely replace an existing object.
52450         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52451         #
52452         Other differences between PUT and PATCH are:
52453         #
52454         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52455         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52456         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52457       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52458       consumes:
52459         - application/json
52460         - application/xml
52461       produces:
52462         - application/json
52463         - application/xml
52464       responses:
52465         "default":
52466           description: Response codes found in [response codes](https://wiki.onap.org/).
52467       parameters:
52468         - name: ipsec-configuration-id
52469           in: path
52470           description: UUID of this configuration
52471           required: true
52472           type: string
52473           example: __IPSEC-CONFIGURATION-ID__
52474         - name: vig-address-type
52475           in: path
52476           description: indicates whether the VIG is for AVPN or INTERNET
52477           required: true
52478           type: string
52479           example: __VIG-ADDRESS-TYPE__
52480         - name: body
52481           in: body
52482           description: vig-server object that needs to be created or updated.
52483           required: true
52484           schema:
52485             $ref: "#/patchDefinitions/vig-server"
52486     delete:
52487       tags:
52488         - Network
52489       summary: delete an existing vig-server
52490       description: delete an existing vig-server
52491       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52492       consumes:
52493         - application/json
52494         - application/xml
52495       produces:
52496         - application/json
52497         - application/xml
52498       responses:
52499         "default":
52500           description: Response codes found in [response codes](https://wiki.onap.org/).
52501       parameters:
52502         - name: ipsec-configuration-id
52503           in: path
52504           description: UUID of this configuration
52505           required: true
52506           type: string
52507           example: __IPSEC-CONFIGURATION-ID__
52508         - name: vig-address-type
52509           in: path
52510           description: indicates whether the VIG is for AVPN or INTERNET
52511           required: true
52512           type: string
52513           example: __VIG-ADDRESS-TYPE__
52514         - name: resource-version
52515           in: query
52516           description: resource-version for concurrency
52517           required: true
52518           type: string
52519   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
52520     get:
52521       tags:
52522         - Network
52523       summary: returns vig-servers
52524       description: returns vig-servers
52525       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
52526       produces:
52527         - application/json
52528         - application/xml
52529       responses:
52530         "200":
52531           description: successful operation
52532           schema:
52533               $ref: "#/getDefinitions/vig-servers"
52534         "default":
52535           description: Response codes found in [response codes](https://wiki.onap.org/).
52536       parameters:
52537         - name: ipsec-configuration-id
52538           in: path
52539           description: UUID of this configuration
52540           required: true
52541           type: string
52542           example: __IPSEC-CONFIGURATION-ID__
52543   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
52544     get:
52545       tags:
52546         - Network
52547       summary: returns ipsec-configuration
52548       description: returns ipsec-configuration
52549       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
52550       produces:
52551         - application/json
52552         - application/xml
52553       responses:
52554         "200":
52555           description: successful operation
52556           schema:
52557               $ref: "#/getDefinitions/ipsec-configuration"
52558         "default":
52559           description: Response codes found in [response codes](https://wiki.onap.org/).
52560       parameters:
52561         - name: ipsec-configuration-id
52562           in: path
52563           description: UUID of this configuration
52564           required: true
52565           type: string
52566           example: __IPSEC-CONFIGURATION-ID__
52567     put:
52568       tags:
52569         - Network
52570       summary: create or update an existing ipsec-configuration
52571       description: |
52572         Create or update an existing ipsec-configuration.
52573         #
52574         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52575       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
52576       consumes:
52577         - application/json
52578         - application/xml
52579       produces:
52580         - application/json
52581         - application/xml
52582       responses:
52583         "default":
52584           description: Response codes found in [response codes](https://wiki.onap.org/).
52585       parameters:
52586         - name: ipsec-configuration-id
52587           in: path
52588           description: UUID of this configuration
52589           required: true
52590           type: string
52591           example: __IPSEC-CONFIGURATION-ID__
52592         - name: body
52593           in: body
52594           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
52595           required: true
52596           schema:
52597             $ref: "#/definitions/ipsec-configuration"
52598     patch:
52599       tags:
52600         - Network
52601       summary: update an existing ipsec-configuration
52602       description: |
52603         Update an existing ipsec-configuration
52604         #
52605         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52606         The PUT operation will entirely replace an existing object.
52607         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52608         #
52609         Other differences between PUT and PATCH are:
52610         #
52611         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52612         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52613         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52614       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
52615       consumes:
52616         - application/json
52617         - application/xml
52618       produces:
52619         - application/json
52620         - application/xml
52621       responses:
52622         "default":
52623           description: Response codes found in [response codes](https://wiki.onap.org/).
52624       parameters:
52625         - name: ipsec-configuration-id
52626           in: path
52627           description: UUID of this configuration
52628           required: true
52629           type: string
52630           example: __IPSEC-CONFIGURATION-ID__
52631         - name: body
52632           in: body
52633           description: ipsec-configuration object that needs to be created or updated.
52634           required: true
52635           schema:
52636             $ref: "#/patchDefinitions/ipsec-configuration"
52637     delete:
52638       tags:
52639         - Network
52640       summary: delete an existing ipsec-configuration
52641       description: delete an existing ipsec-configuration
52642       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
52643       consumes:
52644         - application/json
52645         - application/xml
52646       produces:
52647         - application/json
52648         - application/xml
52649       responses:
52650         "default":
52651           description: Response codes found in [response codes](https://wiki.onap.org/).
52652       parameters:
52653         - name: ipsec-configuration-id
52654           in: path
52655           description: UUID of this configuration
52656           required: true
52657           type: string
52658           example: __IPSEC-CONFIGURATION-ID__
52659         - name: resource-version
52660           in: query
52661           description: resource-version for concurrency
52662           required: true
52663           type: string
52664   /network/ipsec-configurations:
52665     get:
52666       tags:
52667         - Network
52668       summary: returns ipsec-configurations
52669       description: returns ipsec-configurations
52670       operationId: getNetworkIpsecConfigurations
52671       produces:
52672         - application/json
52673         - application/xml
52674       responses:
52675         "200":
52676           description: successful operation
52677           schema:
52678               $ref: "#/getDefinitions/ipsec-configurations"
52679         "default":
52680           description: Response codes found in [response codes](https://wiki.onap.org/).
52681   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
52682     put:
52683       tags:
52684         - Network
52685       summary: see node definition for valid relationships
52686       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
52687       consumes:
52688         - application/json
52689         - application/xml
52690       produces:
52691         - application/json
52692         - application/xml
52693       responses:
52694         "default":
52695           description: Response codes found in [response codes](https://wiki.onap.org/).
52696       parameters:
52697         - name: route-table-reference-id
52698           in: path
52699           description: Route Table Reference id, UUID assigned to this instance.
52700           required: true
52701           type: string
52702           example: __ROUTE-TABLE-REFERENCE-ID__
52703         - name: body
52704           in: body
52705           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
52706           required: true
52707           schema:
52708             $ref: "#/definitions/relationship"
52709     delete:
52710       tags:
52711         - Network
52712       summary: delete an existing relationship
52713       description: delete an existing relationship
52714       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
52715       consumes:
52716         - application/json
52717         - application/xml
52718       produces:
52719         - application/json
52720         - application/xml
52721       responses:
52722         "default":
52723           description: Response codes found in [response codes](https://wiki.onap.org/).
52724       parameters:
52725         - name: route-table-reference-id
52726           in: path
52727           description: Route Table Reference id, UUID assigned to this instance.
52728           required: true
52729           type: string
52730           example: __ROUTE-TABLE-REFERENCE-ID__
52731   /network/route-table-references/route-table-reference/{route-table-reference-id}:
52732     get:
52733       tags:
52734         - Network
52735       summary: returns route-table-reference
52736       description: returns route-table-reference
52737       operationId: getNetworkRouteTableReferencesRouteTableReference
52738       produces:
52739         - application/json
52740         - application/xml
52741       responses:
52742         "200":
52743           description: successful operation
52744           schema:
52745               $ref: "#/getDefinitions/route-table-reference"
52746         "default":
52747           description: Response codes found in [response codes](https://wiki.onap.org/).
52748       parameters:
52749         - name: route-table-reference-id
52750           in: path
52751           description: Route Table Reference id, UUID assigned to this instance.
52752           required: true
52753           type: string
52754           example: __ROUTE-TABLE-REFERENCE-ID__
52755         - name: route-table-reference-fqdn
52756           in: query
52757           description: FQDN entry in the route table.
52758           required: false
52759           type: string
52760     put:
52761       tags:
52762         - Network
52763       summary: create or update an existing route-table-reference
52764       description: |
52765         Create or update an existing route-table-reference.
52766         #
52767         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52768       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
52769       consumes:
52770         - application/json
52771         - application/xml
52772       produces:
52773         - application/json
52774         - application/xml
52775       responses:
52776         "default":
52777           description: Response codes found in [response codes](https://wiki.onap.org/).
52778       parameters:
52779         - name: route-table-reference-id
52780           in: path
52781           description: Route Table Reference id, UUID assigned to this instance.
52782           required: true
52783           type: string
52784           example: __ROUTE-TABLE-REFERENCE-ID__
52785         - name: body
52786           in: body
52787           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
52788           required: true
52789           schema:
52790             $ref: "#/definitions/route-table-reference"
52791     patch:
52792       tags:
52793         - Network
52794       summary: update an existing route-table-reference
52795       description: |
52796         Update an existing route-table-reference
52797         #
52798         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52799         The PUT operation will entirely replace an existing object.
52800         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52801         #
52802         Other differences between PUT and PATCH are:
52803         #
52804         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52805         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52806         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52807       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
52808       consumes:
52809         - application/json
52810         - application/xml
52811       produces:
52812         - application/json
52813         - application/xml
52814       responses:
52815         "default":
52816           description: Response codes found in [response codes](https://wiki.onap.org/).
52817       parameters:
52818         - name: route-table-reference-id
52819           in: path
52820           description: Route Table Reference id, UUID assigned to this instance.
52821           required: true
52822           type: string
52823           example: __ROUTE-TABLE-REFERENCE-ID__
52824         - name: body
52825           in: body
52826           description: route-table-reference object that needs to be created or updated.
52827           required: true
52828           schema:
52829             $ref: "#/patchDefinitions/route-table-reference"
52830     delete:
52831       tags:
52832         - Network
52833       summary: delete an existing route-table-reference
52834       description: delete an existing route-table-reference
52835       operationId: deleteNetworkRouteTableReferencesRouteTableReference
52836       consumes:
52837         - application/json
52838         - application/xml
52839       produces:
52840         - application/json
52841         - application/xml
52842       responses:
52843         "default":
52844           description: Response codes found in [response codes](https://wiki.onap.org/).
52845       parameters:
52846         - name: route-table-reference-id
52847           in: path
52848           description: Route Table Reference id, UUID assigned to this instance.
52849           required: true
52850           type: string
52851           example: __ROUTE-TABLE-REFERENCE-ID__
52852         - name: resource-version
52853           in: query
52854           description: resource-version for concurrency
52855           required: true
52856           type: string
52857   /network/route-table-references:
52858     get:
52859       tags:
52860         - Network
52861       summary: returns route-table-references
52862       description: returns route-table-references
52863       operationId: getNetworkRouteTableReferences
52864       produces:
52865         - application/json
52866         - application/xml
52867       responses:
52868         "200":
52869           description: successful operation
52870           schema:
52871               $ref: "#/getDefinitions/route-table-references"
52872         "default":
52873           description: Response codes found in [response codes](https://wiki.onap.org/).
52874   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
52875     put:
52876       tags:
52877         - Network
52878       summary: see node definition for valid relationships
52879       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
52880       consumes:
52881         - application/json
52882         - application/xml
52883       produces:
52884         - application/json
52885         - application/xml
52886       responses:
52887         "default":
52888           description: Response codes found in [response codes](https://wiki.onap.org/).
52889       parameters:
52890         - name: id
52891           in: path
52892           description: Instance Group ID, UUID assigned to this instance.
52893           required: true
52894           type: string
52895           example: __ID__
52896         - name: body
52897           in: body
52898           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
52899           required: true
52900           schema:
52901             $ref: "#/definitions/relationship"
52902     delete:
52903       tags:
52904         - Network
52905       summary: delete an existing relationship
52906       description: delete an existing relationship
52907       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
52908       consumes:
52909         - application/json
52910         - application/xml
52911       produces:
52912         - application/json
52913         - application/xml
52914       responses:
52915         "default":
52916           description: Response codes found in [response codes](https://wiki.onap.org/).
52917       parameters:
52918         - name: id
52919           in: path
52920           description: Instance Group ID, UUID assigned to this instance.
52921           required: true
52922           type: string
52923           example: __ID__
52924   /network/instance-groups/instance-group/{id}:
52925     get:
52926       tags:
52927         - Network
52928       summary: returns instance-group
52929       description: returns instance-group
52930       operationId: getNetworkInstanceGroupsInstanceGroup
52931       produces:
52932         - application/json
52933         - application/xml
52934       responses:
52935         "200":
52936           description: successful operation
52937           schema:
52938               $ref: "#/getDefinitions/instance-group"
52939         "default":
52940           description: Response codes found in [response codes](https://wiki.onap.org/).
52941       parameters:
52942         - name: id
52943           in: path
52944           description: Instance Group ID, UUID assigned to this instance.
52945           required: true
52946           type: string
52947           example: __ID__
52948         - name: description
52949           in: query
52950           description: Descriptive text to help identify the usage of this instance-group
52951           required: false
52952           type: string
52953         - name: type
52954           in: query
52955           description: Only valid value today is lower case ha for high availability
52956           required: false
52957           type: string
52958         - name: sub-type
52959           in: query
52960           description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
52961           required: false
52962           type: string
52963     put:
52964       tags:
52965         - Network
52966       summary: create or update an existing instance-group
52967       description: |
52968         Create or update an existing instance-group.
52969         #
52970         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52971       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
52972       consumes:
52973         - application/json
52974         - application/xml
52975       produces:
52976         - application/json
52977         - application/xml
52978       responses:
52979         "default":
52980           description: Response codes found in [response codes](https://wiki.onap.org/).
52981       parameters:
52982         - name: id
52983           in: path
52984           description: Instance Group ID, UUID assigned to this instance.
52985           required: true
52986           type: string
52987           example: __ID__
52988         - name: body
52989           in: body
52990           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
52991           required: true
52992           schema:
52993             $ref: "#/definitions/instance-group"
52994     patch:
52995       tags:
52996         - Network
52997       summary: update an existing instance-group
52998       description: |
52999         Update an existing instance-group
53000         #
53001         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53002         The PUT operation will entirely replace an existing object.
53003         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53004         #
53005         Other differences between PUT and PATCH are:
53006         #
53007         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53008         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53009         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53010       operationId: UpdateNetworkInstanceGroupsInstanceGroup
53011       consumes:
53012         - application/json
53013         - application/xml
53014       produces:
53015         - application/json
53016         - application/xml
53017       responses:
53018         "default":
53019           description: Response codes found in [response codes](https://wiki.onap.org/).
53020       parameters:
53021         - name: id
53022           in: path
53023           description: Instance Group ID, UUID assigned to this instance.
53024           required: true
53025           type: string
53026           example: __ID__
53027         - name: body
53028           in: body
53029           description: instance-group object that needs to be created or updated.
53030           required: true
53031           schema:
53032             $ref: "#/patchDefinitions/instance-group"
53033     delete:
53034       tags:
53035         - Network
53036       summary: delete an existing instance-group
53037       description: delete an existing instance-group
53038       operationId: deleteNetworkInstanceGroupsInstanceGroup
53039       consumes:
53040         - application/json
53041         - application/xml
53042       produces:
53043         - application/json
53044         - application/xml
53045       responses:
53046         "default":
53047           description: Response codes found in [response codes](https://wiki.onap.org/).
53048       parameters:
53049         - name: id
53050           in: path
53051           description: Instance Group ID, UUID assigned to this instance.
53052           required: true
53053           type: string
53054           example: __ID__
53055         - name: resource-version
53056           in: query
53057           description: resource-version for concurrency
53058           required: true
53059           type: string
53060   /network/instance-groups:
53061     get:
53062       tags:
53063         - Network
53064       summary: returns instance-groups
53065       description: returns instance-groups
53066       operationId: getNetworkInstanceGroups
53067       produces:
53068         - application/json
53069         - application/xml
53070       responses:
53071         "200":
53072           description: successful operation
53073           schema:
53074               $ref: "#/getDefinitions/instance-groups"
53075         "default":
53076           description: Response codes found in [response codes](https://wiki.onap.org/).
53077   /network/zones/zone/{zone-id}/relationship-list/relationship:
53078     put:
53079       tags:
53080         - Network
53081       summary: see node definition for valid relationships
53082       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
53083       consumes:
53084         - application/json
53085         - application/xml
53086       produces:
53087         - application/json
53088         - application/xml
53089       responses:
53090         "default":
53091           description: Response codes found in [response codes](https://wiki.onap.org/).
53092       parameters:
53093         - name: zone-id
53094           in: path
53095           description: Code assigned by AIC to the zone
53096           required: true
53097           type: string
53098           example: __ZONE-ID__
53099         - name: body
53100           in: body
53101           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
53102           required: true
53103           schema:
53104             $ref: "#/definitions/relationship"
53105     delete:
53106       tags:
53107         - Network
53108       summary: delete an existing relationship
53109       description: delete an existing relationship
53110       operationId: deleteNetworkZonesZoneRelationshipListRelationship
53111       consumes:
53112         - application/json
53113         - application/xml
53114       produces:
53115         - application/json
53116         - application/xml
53117       responses:
53118         "default":
53119           description: Response codes found in [response codes](https://wiki.onap.org/).
53120       parameters:
53121         - name: zone-id
53122           in: path
53123           description: Code assigned by AIC to the zone
53124           required: true
53125           type: string
53126           example: __ZONE-ID__
53127   /network/zones/zone/{zone-id}:
53128     get:
53129       tags:
53130         - Network
53131       summary: returns zone
53132       description: returns zone
53133       operationId: getNetworkZonesZone
53134       produces:
53135         - application/json
53136         - application/xml
53137       responses:
53138         "200":
53139           description: successful operation
53140           schema:
53141               $ref: "#/getDefinitions/zone"
53142         "default":
53143           description: Response codes found in [response codes](https://wiki.onap.org/).
53144       parameters:
53145         - name: zone-id
53146           in: path
53147           description: Code assigned by AIC to the zone
53148           required: true
53149           type: string
53150           example: __ZONE-ID__
53151         - name: design-type
53152           in: query
53153           description: Design of zone [Medium/Large…]
53154           required: false
53155           type: string
53156         - name: zone-context
53157           in: query
53158           description: Context of zone [production/test]
53159           required: false
53160           type: string
53161     put:
53162       tags:
53163         - Network
53164       summary: create or update an existing zone
53165       description: |
53166         Create or update an existing zone.
53167         #
53168         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
53169       operationId: createOrUpdateNetworkZonesZone
53170       consumes:
53171         - application/json
53172         - application/xml
53173       produces:
53174         - application/json
53175         - application/xml
53176       responses:
53177         "default":
53178           description: Response codes found in [response codes](https://wiki.onap.org/).
53179       parameters:
53180         - name: zone-id
53181           in: path
53182           description: Code assigned by AIC to the zone
53183           required: true
53184           type: string
53185           example: __ZONE-ID__
53186         - name: body
53187           in: body
53188           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
53189           required: true
53190           schema:
53191             $ref: "#/definitions/zone"
53192     patch:
53193       tags:
53194         - Network
53195       summary: update an existing zone
53196       description: |
53197         Update an existing zone
53198         #
53199         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53200         The PUT operation will entirely replace an existing object.
53201         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53202         #
53203         Other differences between PUT and PATCH are:
53204         #
53205         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53206         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53207         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53208       operationId: UpdateNetworkZonesZone
53209       consumes:
53210         - application/json
53211         - application/xml
53212       produces:
53213         - application/json
53214         - application/xml
53215       responses:
53216         "default":
53217           description: Response codes found in [response codes](https://wiki.onap.org/).
53218       parameters:
53219         - name: zone-id
53220           in: path
53221           description: Code assigned by AIC to the zone
53222           required: true
53223           type: string
53224           example: __ZONE-ID__
53225         - name: body
53226           in: body
53227           description: zone object that needs to be created or updated.
53228           required: true
53229           schema:
53230             $ref: "#/patchDefinitions/zone"
53231     delete:
53232       tags:
53233         - Network
53234       summary: delete an existing zone
53235       description: delete an existing zone
53236       operationId: deleteNetworkZonesZone
53237       consumes:
53238         - application/json
53239         - application/xml
53240       produces:
53241         - application/json
53242         - application/xml
53243       responses:
53244         "default":
53245           description: Response codes found in [response codes](https://wiki.onap.org/).
53246       parameters:
53247         - name: zone-id
53248           in: path
53249           description: Code assigned by AIC to the zone
53250           required: true
53251           type: string
53252           example: __ZONE-ID__
53253         - name: resource-version
53254           in: query
53255           description: resource-version for concurrency
53256           required: true
53257           type: string
53258   /network/zones:
53259     get:
53260       tags:
53261         - Network
53262       summary: returns zones
53263       description: returns zones
53264       operationId: getNetworkZones
53265       produces:
53266         - application/json
53267         - application/xml
53268       responses:
53269         "200":
53270           description: successful operation
53271           schema:
53272               $ref: "#/getDefinitions/zones"
53273         "default":
53274           description: Response codes found in [response codes](https://wiki.onap.org/).
53275   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
53276     put:
53277       tags:
53278         - Network
53279       summary: see node definition for valid relationships
53280       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
53281       consumes:
53282         - application/json
53283         - application/xml
53284       produces:
53285         - application/json
53286         - application/xml
53287       responses:
53288         "default":
53289           description: Response codes found in [response codes](https://wiki.onap.org/).
53290       parameters:
53291         - name: configuration-id
53292           in: path
53293           description: UUID assigned to configuration.
53294           required: true
53295           type: string
53296           example: __CONFIGURATION-ID__
53297         - name: body
53298           in: body
53299           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
53300           required: true
53301           schema:
53302             $ref: "#/definitions/relationship"
53303     delete:
53304       tags:
53305         - Network
53306       summary: delete an existing relationship
53307       description: delete an existing relationship
53308       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
53309       consumes:
53310         - application/json
53311         - application/xml
53312       produces:
53313         - application/json
53314         - application/xml
53315       responses:
53316         "default":
53317           description: Response codes found in [response codes](https://wiki.onap.org/).
53318       parameters:
53319         - name: configuration-id
53320           in: path
53321           description: UUID assigned to configuration.
53322           required: true
53323           type: string
53324           example: __CONFIGURATION-ID__
53325   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
53326     get:
53327       tags:
53328         - Network
53329       summary: returns metadatum
53330       description: returns metadatum
53331       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
53332       produces:
53333         - application/json
53334         - application/xml
53335       responses:
53336         "200":
53337           description: successful operation
53338           schema:
53339               $ref: "#/getDefinitions/metadatum"
53340         "default":
53341           description: Response codes found in [response codes](https://wiki.onap.org/).
53342       parameters:
53343         - name: configuration-id
53344           in: path
53345           description: UUID assigned to configuration.
53346           required: true
53347           type: string
53348           example: __CONFIGURATION-ID__
53349         - name: metaname
53350           in: path
53351           required: true
53352           type: string
53353           example: __METANAME__
53354         - name: model-invariant-id
53355           in: query
53356           description: the ASDC model id for this resource or service model.
53357           required: false
53358           type: string
53359         - name: model-version-id
53360           in: query
53361           description: the ASDC model version for this resource or service model.
53362           required: false
53363           type: string
53364     put:
53365       tags:
53366         - Network
53367       summary: create or update an existing metadatum
53368       description: |
53369         Create or update an existing metadatum.
53370         #
53371         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
53372       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
53373       consumes:
53374         - application/json
53375         - application/xml
53376       produces:
53377         - application/json
53378         - application/xml
53379       responses:
53380         "default":
53381           description: Response codes found in [response codes](https://wiki.onap.org/).
53382       parameters:
53383         - name: configuration-id
53384           in: path
53385           description: UUID assigned to configuration.
53386           required: true
53387           type: string
53388           example: __CONFIGURATION-ID__
53389         - name: metaname
53390           in: path
53391           required: true
53392           type: string
53393           example: __METANAME__
53394         - name: body
53395           in: body
53396           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)
53397           required: true
53398           schema:
53399             $ref: "#/definitions/metadatum"
53400     patch:
53401       tags:
53402         - Network
53403       summary: update an existing metadatum
53404       description: |
53405         Update an existing metadatum
53406         #
53407         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53408         The PUT operation will entirely replace an existing object.
53409         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53410         #
53411         Other differences between PUT and PATCH are:
53412         #
53413         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53414         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53415         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53416       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
53417       consumes:
53418         - application/json
53419         - application/xml
53420       produces:
53421         - application/json
53422         - application/xml
53423       responses:
53424         "default":
53425           description: Response codes found in [response codes](https://wiki.onap.org/).
53426       parameters:
53427         - name: configuration-id
53428           in: path
53429           description: UUID assigned to configuration.
53430           required: true
53431           type: string
53432           example: __CONFIGURATION-ID__
53433         - name: metaname
53434           in: path
53435           required: true
53436           type: string
53437           example: __METANAME__
53438         - name: body
53439           in: body
53440           description: metadatum object that needs to be created or updated.
53441           required: true
53442           schema:
53443             $ref: "#/patchDefinitions/metadatum"
53444     delete:
53445       tags:
53446         - Network
53447       summary: delete an existing metadatum
53448       description: delete an existing metadatum
53449       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
53450       consumes:
53451         - application/json
53452         - application/xml
53453       produces:
53454         - application/json
53455         - application/xml
53456       responses:
53457         "default":
53458           description: Response codes found in [response codes](https://wiki.onap.org/).
53459       parameters:
53460         - name: configuration-id
53461           in: path
53462           description: UUID assigned to configuration.
53463           required: true
53464           type: string
53465           example: __CONFIGURATION-ID__
53466         - name: metaname
53467           in: path
53468           required: true
53469           type: string
53470           example: __METANAME__
53471         - name: resource-version
53472           in: query
53473           description: resource-version for concurrency
53474           required: true
53475           type: string
53476   /network/configurations/configuration/{configuration-id}/metadata:
53477     get:
53478       tags:
53479         - Network
53480       summary: returns metadata
53481       description: returns metadata
53482       operationId: getNetworkConfigurationsConfigurationMetadata
53483       produces:
53484         - application/json
53485         - application/xml
53486       responses:
53487         "200":
53488           description: successful operation
53489           schema:
53490               $ref: "#/getDefinitions/metadata"
53491         "default":
53492           description: Response codes found in [response codes](https://wiki.onap.org/).
53493       parameters:
53494         - name: configuration-id
53495           in: path
53496           description: UUID assigned to configuration.
53497           required: true
53498           type: string
53499           example: __CONFIGURATION-ID__
53500         - name: model-invariant-id
53501           in: query
53502           description: the ASDC model id for this resource or service model.
53503           required: false
53504           type: string
53505         - name: model-version-id
53506           in: query
53507           description: the ASDC model version for this resource or service model.
53508           required: false
53509           type: string
53510   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
53511     put:
53512       tags:
53513         - Network
53514       summary: see node definition for valid relationships
53515       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
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: forwarder-evc-id
53533           in: path
53534           description: Key for forwarder-evc object
53535           required: true
53536           type: string
53537           example: __FORWARDER-EVC-ID__
53538         - name: body
53539           in: body
53540           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
53541           required: true
53542           schema:
53543             $ref: "#/definitions/relationship"
53544     delete:
53545       tags:
53546         - Network
53547       summary: delete an existing relationship
53548       description: delete an existing relationship
53549       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
53550       consumes:
53551         - application/json
53552         - application/xml
53553       produces:
53554         - application/json
53555         - application/xml
53556       responses:
53557         "default":
53558           description: Response codes found in [response codes](https://wiki.onap.org/).
53559       parameters:
53560         - name: configuration-id
53561           in: path
53562           description: UUID assigned to configuration.
53563           required: true
53564           type: string
53565           example: __CONFIGURATION-ID__
53566         - name: forwarder-evc-id
53567           in: path
53568           description: Key for forwarder-evc object
53569           required: true
53570           type: string
53571           example: __FORWARDER-EVC-ID__
53572   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
53573     get:
53574       tags:
53575         - Network
53576       summary: returns forwarder-evc
53577       description: returns forwarder-evc
53578       operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53579       produces:
53580         - application/json
53581         - application/xml
53582       responses:
53583         "200":
53584           description: successful operation
53585           schema:
53586               $ref: "#/getDefinitions/forwarder-evc"
53587         "default":
53588           description: Response codes found in [response codes](https://wiki.onap.org/).
53589       parameters:
53590         - name: configuration-id
53591           in: path
53592           description: UUID assigned to configuration.
53593           required: true
53594           type: string
53595           example: __CONFIGURATION-ID__
53596         - name: forwarder-evc-id
53597           in: path
53598           description: Key for forwarder-evc object
53599           required: true
53600           type: string
53601           example: __FORWARDER-EVC-ID__
53602         - name: model-invariant-id
53603           in: query
53604           description: the ASDC model id for this resource or service model.
53605           required: false
53606           type: string
53607         - name: model-version-id
53608           in: query
53609           description: the ASDC model version for this resource or service model.
53610           required: false
53611           type: string
53612     put:
53613       tags:
53614         - Network
53615       summary: create or update an existing forwarder-evc
53616       description: |
53617         Create or update an existing forwarder-evc.
53618         #
53619         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
53620       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53621       consumes:
53622         - application/json
53623         - application/xml
53624       produces:
53625         - application/json
53626         - application/xml
53627       responses:
53628         "default":
53629           description: Response codes found in [response codes](https://wiki.onap.org/).
53630       parameters:
53631         - name: configuration-id
53632           in: path
53633           description: UUID assigned to configuration.
53634           required: true
53635           type: string
53636           example: __CONFIGURATION-ID__
53637         - name: forwarder-evc-id
53638           in: path
53639           description: Key for forwarder-evc object
53640           required: true
53641           type: string
53642           example: __FORWARDER-EVC-ID__
53643         - name: body
53644           in: body
53645           description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
53646           required: true
53647           schema:
53648             $ref: "#/definitions/forwarder-evc"
53649     patch:
53650       tags:
53651         - Network
53652       summary: update an existing forwarder-evc
53653       description: |
53654         Update an existing forwarder-evc
53655         #
53656         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53657         The PUT operation will entirely replace an existing object.
53658         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53659         #
53660         Other differences between PUT and PATCH are:
53661         #
53662         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53663         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53664         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53665       operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53666       consumes:
53667         - application/json
53668         - application/xml
53669       produces:
53670         - application/json
53671         - application/xml
53672       responses:
53673         "default":
53674           description: Response codes found in [response codes](https://wiki.onap.org/).
53675       parameters:
53676         - name: configuration-id
53677           in: path
53678           description: UUID assigned to configuration.
53679           required: true
53680           type: string
53681           example: __CONFIGURATION-ID__
53682         - name: forwarder-evc-id
53683           in: path
53684           description: Key for forwarder-evc object
53685           required: true
53686           type: string
53687           example: __FORWARDER-EVC-ID__
53688         - name: body
53689           in: body
53690           description: forwarder-evc object that needs to be created or updated.
53691           required: true
53692           schema:
53693             $ref: "#/patchDefinitions/forwarder-evc"
53694     delete:
53695       tags:
53696         - Network
53697       summary: delete an existing forwarder-evc
53698       description: delete an existing forwarder-evc
53699       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53700       consumes:
53701         - application/json
53702         - application/xml
53703       produces:
53704         - application/json
53705         - application/xml
53706       responses:
53707         "default":
53708           description: Response codes found in [response codes](https://wiki.onap.org/).
53709       parameters:
53710         - name: configuration-id
53711           in: path
53712           description: UUID assigned to configuration.
53713           required: true
53714           type: string
53715           example: __CONFIGURATION-ID__
53716         - name: forwarder-evc-id
53717           in: path
53718           description: Key for forwarder-evc object
53719           required: true
53720           type: string
53721           example: __FORWARDER-EVC-ID__
53722         - name: resource-version
53723           in: query
53724           description: resource-version for concurrency
53725           required: true
53726           type: string
53727   /network/configurations/configuration/{configuration-id}/forwarder-evcs:
53728     get:
53729       tags:
53730         - Network
53731       summary: returns forwarder-evcs
53732       description: returns forwarder-evcs
53733       operationId: getNetworkConfigurationsConfigurationForwarderEvcs
53734       produces:
53735         - application/json
53736         - application/xml
53737       responses:
53738         "200":
53739           description: successful operation
53740           schema:
53741               $ref: "#/getDefinitions/forwarder-evcs"
53742         "default":
53743           description: Response codes found in [response codes](https://wiki.onap.org/).
53744       parameters:
53745         - name: configuration-id
53746           in: path
53747           description: UUID assigned to configuration.
53748           required: true
53749           type: string
53750           example: __CONFIGURATION-ID__
53751         - name: model-invariant-id
53752           in: query
53753           description: the ASDC model id for this resource or service model.
53754           required: false
53755           type: string
53756         - name: model-version-id
53757           in: query
53758           description: the ASDC model version for this resource or service model.
53759           required: false
53760           type: string
53761   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
53762     put:
53763       tags:
53764         - Network
53765       summary: see node definition for valid relationships
53766       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
53767       consumes:
53768         - application/json
53769         - application/xml
53770       produces:
53771         - application/json
53772         - application/xml
53773       responses:
53774         "default":
53775           description: Response codes found in [response codes](https://wiki.onap.org/).
53776       parameters:
53777         - name: configuration-id
53778           in: path
53779           description: UUID assigned to configuration.
53780           required: true
53781           type: string
53782           example: __CONFIGURATION-ID__
53783         - name: evc-id
53784           in: path
53785           description: Unique/key field for the evc object
53786           required: true
53787           type: string
53788           example: __EVC-ID__
53789         - name: body
53790           in: body
53791           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
53792           required: true
53793           schema:
53794             $ref: "#/definitions/relationship"
53795     delete:
53796       tags:
53797         - Network
53798       summary: delete an existing relationship
53799       description: delete an existing relationship
53800       operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
53801       consumes:
53802         - application/json
53803         - application/xml
53804       produces:
53805         - application/json
53806         - application/xml
53807       responses:
53808         "default":
53809           description: Response codes found in [response codes](https://wiki.onap.org/).
53810       parameters:
53811         - name: configuration-id
53812           in: path
53813           description: UUID assigned to configuration.
53814           required: true
53815           type: string
53816           example: __CONFIGURATION-ID__
53817         - name: evc-id
53818           in: path
53819           description: Unique/key field for the evc object
53820           required: true
53821           type: string
53822           example: __EVC-ID__
53823   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
53824     get:
53825       tags:
53826         - Network
53827       summary: returns evc
53828       description: returns evc
53829       operationId: getNetworkConfigurationsConfigurationEvcsEvc
53830       produces:
53831         - application/json
53832         - application/xml
53833       responses:
53834         "200":
53835           description: successful operation
53836           schema:
53837               $ref: "#/getDefinitions/evc"
53838         "default":
53839           description: Response codes found in [response codes](https://wiki.onap.org/).
53840       parameters:
53841         - name: configuration-id
53842           in: path
53843           description: UUID assigned to configuration.
53844           required: true
53845           type: string
53846           example: __CONFIGURATION-ID__
53847         - name: evc-id
53848           in: path
53849           description: Unique/key field for the evc object
53850           required: true
53851           type: string
53852           example: __EVC-ID__
53853         - name: model-invariant-id
53854           in: query
53855           description: the ASDC model id for this resource or service model.
53856           required: false
53857           type: string
53858         - name: model-version-id
53859           in: query
53860           description: the ASDC model version for this resource or service model.
53861           required: false
53862           type: string
53863     put:
53864       tags:
53865         - Network
53866       summary: create or update an existing evc
53867       description: |
53868         Create or update an existing evc.
53869         #
53870         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
53871       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
53872       consumes:
53873         - application/json
53874         - application/xml
53875       produces:
53876         - application/json
53877         - application/xml
53878       responses:
53879         "default":
53880           description: Response codes found in [response codes](https://wiki.onap.org/).
53881       parameters:
53882         - name: configuration-id
53883           in: path
53884           description: UUID assigned to configuration.
53885           required: true
53886           type: string
53887           example: __CONFIGURATION-ID__
53888         - name: evc-id
53889           in: path
53890           description: Unique/key field for the evc object
53891           required: true
53892           type: string
53893           example: __EVC-ID__
53894         - name: body
53895           in: body
53896           description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
53897           required: true
53898           schema:
53899             $ref: "#/definitions/evc"
53900     patch:
53901       tags:
53902         - Network
53903       summary: update an existing evc
53904       description: |
53905         Update an existing evc
53906         #
53907         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53908         The PUT operation will entirely replace an existing object.
53909         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
53910         #
53911         Other differences between PUT and PATCH are:
53912         #
53913         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53914         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53915         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53916       operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
53917       consumes:
53918         - application/json
53919         - application/xml
53920       produces:
53921         - application/json
53922         - application/xml
53923       responses:
53924         "default":
53925           description: Response codes found in [response codes](https://wiki.onap.org/).
53926       parameters:
53927         - name: configuration-id
53928           in: path
53929           description: UUID assigned to configuration.
53930           required: true
53931           type: string
53932           example: __CONFIGURATION-ID__
53933         - name: evc-id
53934           in: path
53935           description: Unique/key field for the evc object
53936           required: true
53937           type: string
53938           example: __EVC-ID__
53939         - name: body
53940           in: body
53941           description: evc object that needs to be created or updated.
53942           required: true
53943           schema:
53944             $ref: "#/patchDefinitions/evc"
53945     delete:
53946       tags:
53947         - Network
53948       summary: delete an existing evc
53949       description: delete an existing evc
53950       operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
53951       consumes:
53952         - application/json
53953         - application/xml
53954       produces:
53955         - application/json
53956         - application/xml
53957       responses:
53958         "default":
53959           description: Response codes found in [response codes](https://wiki.onap.org/).
53960       parameters:
53961         - name: configuration-id
53962           in: path
53963           description: UUID assigned to configuration.
53964           required: true
53965           type: string
53966           example: __CONFIGURATION-ID__
53967         - name: evc-id
53968           in: path
53969           description: Unique/key field for the evc object
53970           required: true
53971           type: string
53972           example: __EVC-ID__
53973         - name: resource-version
53974           in: query
53975           description: resource-version for concurrency
53976           required: true
53977           type: string
53978   /network/configurations/configuration/{configuration-id}/evcs:
53979     get:
53980       tags:
53981         - Network
53982       summary: returns evcs
53983       description: returns evcs
53984       operationId: getNetworkConfigurationsConfigurationEvcs
53985       produces:
53986         - application/json
53987         - application/xml
53988       responses:
53989         "200":
53990           description: successful operation
53991           schema:
53992               $ref: "#/getDefinitions/evcs"
53993         "default":
53994           description: Response codes found in [response codes](https://wiki.onap.org/).
53995       parameters:
53996         - name: configuration-id
53997           in: path
53998           description: UUID assigned to configuration.
53999           required: true
54000           type: string
54001           example: __CONFIGURATION-ID__
54002         - name: model-invariant-id
54003           in: query
54004           description: the ASDC model id for this resource or service model.
54005           required: false
54006           type: string
54007         - name: model-version-id
54008           in: query
54009           description: the ASDC model version for this resource or service model.
54010           required: false
54011           type: string
54012   /network/configurations/configuration/{configuration-id}:
54013     get:
54014       tags:
54015         - Network
54016       summary: returns configuration
54017       description: returns configuration
54018       operationId: getNetworkConfigurationsConfiguration
54019       produces:
54020         - application/json
54021         - application/xml
54022       responses:
54023         "200":
54024           description: successful operation
54025           schema:
54026               $ref: "#/getDefinitions/configuration"
54027         "default":
54028           description: Response codes found in [response codes](https://wiki.onap.org/).
54029       parameters:
54030         - name: configuration-id
54031           in: path
54032           description: UUID assigned to configuration.
54033           required: true
54034           type: string
54035           example: __CONFIGURATION-ID__
54036         - name: model-invariant-id
54037           in: query
54038           description: the ASDC model id for this resource or service model.
54039           required: false
54040           type: string
54041         - name: model-version-id
54042           in: query
54043           description: the ASDC model version for this resource or service model.
54044           required: false
54045           type: string
54046     put:
54047       tags:
54048         - Network
54049       summary: create or update an existing configuration
54050       description: |
54051         Create or update an existing configuration.
54052         #
54053         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
54054       operationId: createOrUpdateNetworkConfigurationsConfiguration
54055       consumes:
54056         - application/json
54057         - application/xml
54058       produces:
54059         - application/json
54060         - application/xml
54061       responses:
54062         "default":
54063           description: Response codes found in [response codes](https://wiki.onap.org/).
54064       parameters:
54065         - name: configuration-id
54066           in: path
54067           description: UUID assigned to configuration.
54068           required: true
54069           type: string
54070           example: __CONFIGURATION-ID__
54071         - name: body
54072           in: body
54073           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
54074           required: true
54075           schema:
54076             $ref: "#/definitions/configuration"
54077     patch:
54078       tags:
54079         - Network
54080       summary: update an existing configuration
54081       description: |
54082         Update an existing configuration
54083         #
54084         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
54085         The PUT operation will entirely replace an existing object.
54086         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
54087         #
54088         Other differences between PUT and PATCH are:
54089         #
54090         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
54091         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
54092         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
54093       operationId: UpdateNetworkConfigurationsConfiguration
54094       consumes:
54095         - application/json
54096         - application/xml
54097       produces:
54098         - application/json
54099         - application/xml
54100       responses:
54101         "default":
54102           description: Response codes found in [response codes](https://wiki.onap.org/).
54103       parameters:
54104         - name: configuration-id
54105           in: path
54106           description: UUID assigned to configuration.
54107           required: true
54108           type: string
54109           example: __CONFIGURATION-ID__
54110         - name: body
54111           in: body
54112           description: configuration object that needs to be created or updated.
54113           required: true
54114           schema:
54115             $ref: "#/patchDefinitions/configuration"
54116     delete:
54117       tags:
54118         - Network
54119       summary: delete an existing configuration
54120       description: delete an existing configuration
54121       operationId: deleteNetworkConfigurationsConfiguration
54122       consumes:
54123         - application/json
54124         - application/xml
54125       produces:
54126         - application/json
54127         - application/xml
54128       responses:
54129         "default":
54130           description: Response codes found in [response codes](https://wiki.onap.org/).
54131       parameters:
54132         - name: configuration-id
54133           in: path
54134           description: UUID assigned to configuration.
54135           required: true
54136           type: string
54137           example: __CONFIGURATION-ID__
54138         - name: resource-version
54139           in: query
54140           description: resource-version for concurrency
54141           required: true
54142           type: string
54143   /network/configurations:
54144     get:
54145       tags:
54146         - Network
54147       summary: returns configurations
54148       description: returns configurations
54149       operationId: getNetworkConfigurations
54150       produces:
54151         - application/json
54152         - application/xml
54153       responses:
54154         "200":
54155           description: successful operation
54156           schema:
54157               $ref: "#/getDefinitions/configurations"
54158         "default":
54159           description: Response codes found in [response codes](https://wiki.onap.org/).
54160   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
54161     put:
54162       tags:
54163         - Network
54164       summary: see node definition for valid relationships
54165       operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
54166       consumes:
54167         - application/json
54168         - application/xml
54169       produces:
54170         - application/json
54171         - application/xml
54172       responses:
54173         "default":
54174           description: Response codes found in [response codes](https://wiki.onap.org/).
54175       parameters:
54176         - name: forwarding-path-id
54177           in: path
54178           description: Unique ID of this FP
54179           required: true
54180           type: string
54181           example: __FORWARDING-PATH-ID__
54182         - name: body
54183           in: body
54184           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
54185           required: true
54186           schema:
54187             $ref: "#/definitions/relationship"
54188     delete:
54189       tags:
54190         - Network
54191       summary: delete an existing relationship
54192       description: delete an existing relationship
54193       operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
54194       consumes:
54195         - application/json
54196         - application/xml
54197       produces:
54198         - application/json
54199         - application/xml
54200       responses:
54201         "default":
54202           description: Response codes found in [response codes](https://wiki.onap.org/).
54203       parameters:
54204         - name: forwarding-path-id
54205           in: path
54206           description: Unique ID of this FP
54207           required: true
54208           type: string
54209           example: __FORWARDING-PATH-ID__
54210   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
54211     put:
54212       tags:
54213         - Network
54214       summary: see node definition for valid relationships
54215       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
54216       consumes:
54217         - application/json
54218         - application/xml
54219       produces:
54220         - application/json
54221         - application/xml
54222       responses:
54223         "default":
54224           description: Response codes found in [response codes](https://wiki.onap.org/).
54225       parameters:
54226         - name: forwarding-path-id
54227           in: path
54228           description: Unique ID of this FP
54229           required: true
54230           type: string
54231           example: __FORWARDING-PATH-ID__
54232         - name: sequence
54233           in: path
54234           description: Unique ID of this segmentation
54235           required: true
54236           type: integer
54237           format: int32
54238           example: __SEQUENCE__
54239         - name: body
54240           in: body
54241           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
54242           required: true
54243           schema:
54244             $ref: "#/definitions/relationship"
54245     delete:
54246       tags:
54247         - Network
54248       summary: delete an existing relationship
54249       description: delete an existing relationship
54250       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
54251       consumes:
54252         - application/json
54253         - application/xml
54254       produces:
54255         - application/json
54256         - application/xml
54257       responses:
54258         "default":
54259           description: Response codes found in [response codes](https://wiki.onap.org/).
54260       parameters:
54261         - name: forwarding-path-id
54262           in: path
54263           description: Unique ID of this FP
54264           required: true
54265           type: string
54266           example: __FORWARDING-PATH-ID__
54267         - name: sequence
54268           in: path
54269           description: Unique ID of this segmentation
54270           required: true
54271           type: integer
54272           format: int32
54273           example: __SEQUENCE__
54274   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
54275     get:
54276       tags:
54277         - Network
54278       summary: returns forwarder
54279       description: returns forwarder
54280       operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
54281       produces:
54282         - application/json
54283         - application/xml
54284       responses:
54285         "200":
54286           description: successful operation
54287           schema:
54288               $ref: "#/getDefinitions/forwarder"
54289         "default":
54290           description: Response codes found in [response codes](https://wiki.onap.org/).
54291       parameters:
54292         - name: forwarding-path-id
54293           in: path
54294           description: Unique ID of this FP
54295           required: true
54296           type: string
54297           example: __FORWARDING-PATH-ID__
54298         - name: sequence
54299           in: path
54300           description: Unique ID of this segmentation
54301           required: true
54302           type: integer
54303           format: int32
54304           example: __SEQUENCE__
54305         - name: forwarding-path-name
54306           in: query
54307           description: Name of the FP
54308           required: false
54309           type: string
54310     put:
54311       tags:
54312         - Network
54313       summary: create or update an existing forwarder
54314       description: |
54315         Create or update an existing forwarder.
54316         #
54317         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
54318       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
54319       consumes:
54320         - application/json
54321         - application/xml
54322       produces:
54323         - application/json
54324         - application/xml
54325       responses:
54326         "default":
54327           description: Response codes found in [response codes](https://wiki.onap.org/).
54328       parameters:
54329         - name: forwarding-path-id
54330           in: path
54331           description: Unique ID of this FP
54332           required: true
54333           type: string
54334           example: __FORWARDING-PATH-ID__
54335         - name: sequence
54336           in: path
54337           description: Unique ID of this segmentation
54338           required: true
54339           type: integer
54340           format: int32
54341           example: __SEQUENCE__
54342         - name: body
54343           in: body
54344           description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
54345           required: true
54346           schema:
54347             $ref: "#/definitions/forwarder"
54348     patch:
54349       tags:
54350         - Network
54351       summary: update an existing forwarder
54352       description: |
54353         Update an existing forwarder
54354         #
54355         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
54356         The PUT operation will entirely replace an existing object.
54357         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
54358         #
54359         Other differences between PUT and PATCH are:
54360         #
54361         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
54362         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
54363         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
54364       operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
54365       consumes:
54366         - application/json
54367         - application/xml
54368       produces:
54369         - application/json
54370         - application/xml
54371       responses:
54372         "default":
54373           description: Response codes found in [response codes](https://wiki.onap.org/).
54374       parameters:
54375         - name: forwarding-path-id
54376           in: path
54377           description: Unique ID of this FP
54378           required: true
54379           type: string
54380           example: __FORWARDING-PATH-ID__
54381         - name: sequence
54382           in: path
54383           description: Unique ID of this segmentation
54384           required: true
54385           type: integer
54386           format: int32
54387           example: __SEQUENCE__
54388         - name: body
54389           in: body
54390           description: forwarder object that needs to be created or updated.
54391           required: true
54392           schema:
54393             $ref: "#/patchDefinitions/forwarder"
54394     delete:
54395       tags:
54396         - Network
54397       summary: delete an existing forwarder
54398       description: delete an existing forwarder
54399       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
54400       consumes:
54401         - application/json
54402         - application/xml
54403       produces:
54404         - application/json
54405         - application/xml
54406       responses:
54407         "default":
54408           description: Response codes found in [response codes](https://wiki.onap.org/).
54409       parameters:
54410         - name: forwarding-path-id
54411           in: path
54412           description: Unique ID of this FP
54413           required: true
54414           type: string
54415           example: __FORWARDING-PATH-ID__
54416         - name: sequence
54417           in: path
54418           description: Unique ID of this segmentation
54419           required: true
54420           type: integer
54421           format: int32
54422           example: __SEQUENCE__
54423         - name: resource-version
54424           in: query
54425           description: resource-version for concurrency
54426           required: true
54427           type: string
54428   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
54429     get:
54430       tags:
54431         - Network
54432       summary: returns forwarders
54433       description: returns forwarders
54434       operationId: getNetworkForwardingPathsForwardingPathForwarders
54435       produces:
54436         - application/json
54437         - application/xml
54438       responses:
54439         "200":
54440           description: successful operation
54441           schema:
54442               $ref: "#/getDefinitions/forwarders"
54443         "default":
54444           description: Response codes found in [response codes](https://wiki.onap.org/).
54445       parameters:
54446         - name: forwarding-path-id
54447           in: path
54448           description: Unique ID of this FP
54449           required: true
54450           type: string
54451           example: __FORWARDING-PATH-ID__
54452         - name: forwarding-path-name
54453           in: query
54454           description: Name of the FP
54455           required: false
54456           type: string
54457   /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
54458     get:
54459       tags:
54460         - Network
54461       summary: returns forwarding-path
54462       description: returns forwarding-path
54463       operationId: getNetworkForwardingPathsForwardingPath
54464       produces:
54465         - application/json
54466         - application/xml
54467       responses:
54468         "200":
54469           description: successful operation
54470           schema:
54471               $ref: "#/getDefinitions/forwarding-path"
54472         "default":
54473           description: Response codes found in [response codes](https://wiki.onap.org/).
54474       parameters:
54475         - name: forwarding-path-id
54476           in: path
54477           description: Unique ID of this FP
54478           required: true
54479           type: string
54480           example: __FORWARDING-PATH-ID__
54481         - name: forwarding-path-name
54482           in: query
54483           description: Name of the FP
54484           required: false
54485           type: string
54486     put:
54487       tags:
54488         - Network
54489       summary: create or update an existing forwarding-path
54490       description: |
54491         Create or update an existing forwarding-path.
54492         #
54493         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
54494       operationId: createOrUpdateNetworkForwardingPathsForwardingPath
54495       consumes:
54496         - application/json
54497         - application/xml
54498       produces:
54499         - application/json
54500         - application/xml
54501       responses:
54502         "default":
54503           description: Response codes found in [response codes](https://wiki.onap.org/).
54504       parameters:
54505         - name: forwarding-path-id
54506           in: path
54507           description: Unique ID of this FP
54508           required: true
54509           type: string
54510           example: __FORWARDING-PATH-ID__
54511         - name: body
54512           in: body
54513           description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
54514           required: true
54515           schema:
54516             $ref: "#/definitions/forwarding-path"
54517     patch:
54518       tags:
54519         - Network
54520       summary: update an existing forwarding-path
54521       description: |
54522         Update an existing forwarding-path
54523         #
54524         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
54525         The PUT operation will entirely replace an existing object.
54526         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
54527         #
54528         Other differences between PUT and PATCH are:
54529         #
54530         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
54531         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
54532         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
54533       operationId: UpdateNetworkForwardingPathsForwardingPath
54534       consumes:
54535         - application/json
54536         - application/xml
54537       produces:
54538         - application/json
54539         - application/xml
54540       responses:
54541         "default":
54542           description: Response codes found in [response codes](https://wiki.onap.org/).
54543       parameters:
54544         - name: forwarding-path-id
54545           in: path
54546           description: Unique ID of this FP
54547           required: true
54548           type: string
54549           example: __FORWARDING-PATH-ID__
54550         - name: body
54551           in: body
54552           description: forwarding-path object that needs to be created or updated.
54553           required: true
54554           schema:
54555             $ref: "#/patchDefinitions/forwarding-path"
54556     delete:
54557       tags:
54558         - Network
54559       summary: delete an existing forwarding-path
54560       description: delete an existing forwarding-path
54561       operationId: deleteNetworkForwardingPathsForwardingPath
54562       consumes:
54563         - application/json
54564         - application/xml
54565       produces:
54566         - application/json
54567         - application/xml
54568       responses:
54569         "default":
54570           description: Response codes found in [response codes](https://wiki.onap.org/).
54571       parameters:
54572         - name: forwarding-path-id
54573           in: path
54574           description: Unique ID of this FP
54575           required: true
54576           type: string
54577           example: __FORWARDING-PATH-ID__
54578         - name: resource-version
54579           in: query
54580           description: resource-version for concurrency
54581           required: true
54582           type: string
54583   /network/forwarding-paths:
54584     get:
54585       tags:
54586         - Network
54587       summary: returns forwarding-paths
54588       description: returns forwarding-paths
54589       operationId: getNetworkForwardingPaths
54590       produces:
54591         - application/json
54592         - application/xml
54593       responses:
54594         "200":
54595           description: successful operation
54596           schema:
54597               $ref: "#/getDefinitions/forwarding-paths"
54598         "default":
54599           description: Response codes found in [response codes](https://wiki.onap.org/).
54600 definitions:
54601   aai-internal:
54602     properties:
54603       property-name:
54604         type: string
54605       property-value:
54606         type: string
54607   action:
54608     properties:
54609       action-type:
54610         type: string
54611       action-data:
54612         type: array
54613         items:
54614           $ref: "#/definitions/action-data"
54615   action-data:
54616     properties:
54617       property-name:
54618         type: string
54619       property-value:
54620         type: string
54621   actions:
54622     description: |
54623       APIs that are more action related than REST (e.g., notify, update).
54624     properties:
54625       update:
54626         type: object
54627         $ref: "#/definitions/update"
54628       notify:
54629         type: object
54630         $ref: "#/definitions/notify"
54631   allotted-resource:
54632     description: |
54633       Represents a slice or partial piece of a resource that gets separately allotted
54634       ###### Related Nodes
54635       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
54636       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
54637       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54638       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
54639       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
54640       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
54641       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
54642       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
54643       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54644       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
54645       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
54646       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
54647       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
54648       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
54649       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
54650     required:
54651     - id
54652     properties:
54653       id:
54654         type: string
54655         description: Allotted Resource id UUID assigned to this instance.
54656       description:
54657         type: string
54658         description: The descriptive information assigned to this allotted resource instance
54659       selflink:
54660         type: string
54661         description: Link back to more information in the controller
54662       model-invariant-id:
54663         type: string
54664         description: the ASDC model id for this resource or service model.
54665       model-version-id:
54666         type: string
54667         description: the ASDC model version for this resource or service model.
54668       persona-model-version:
54669         type: string
54670         description: the ASDC model version for this resource or service model.
54671       resource-version:
54672         type: string
54673         description: Concurrency value
54674       orchestration-status:
54675         type: string
54676         description: Orchestration status
54677       operational-status:
54678         type: string
54679         description: Indicator for whether the resource is considered operational
54680       type:
54681         type: string
54682         description: Generic description of the type of allotted resource.
54683       role:
54684         type: string
54685         description: role in the network that this resource will be providing.
54686       tunnel-xconnects:
54687         type: array
54688         items:
54689           $ref: "#/definitions/tunnel-xconnect"
54690       relationship-list:
54691         type: array
54692         items:
54693           $ref: "#/definitions/relationship"
54694   allotted-resources:
54695     description: |
54696       This object is used to store slices of services being offered
54697     properties:
54698       allotted-resource:
54699         type: array
54700         items:
54701           $ref: "#/definitions/allotted-resource"
54702   availability-zone:
54703     description: |
54704       Availability zone, a collection of compute hosts/pservers
54705       ###### Related Nodes
54706       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54707       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
54708       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54709       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54710       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54711       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54712       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
54713       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54714       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
54715     required:
54716     - availability-zone-name
54717     - hypervisor-type
54718     properties:
54719       availability-zone-name:
54720         type: string
54721         description: Name of the availability zone.  Unique across a cloud region
54722       hypervisor-type:
54723         type: string
54724         description: Type of hypervisor.  Source of truth should define valid values.
54725       operational-status:
54726         type: string
54727         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
54728       resource-version:
54729         type: string
54730         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54731       relationship-list:
54732         type: array
54733         items:
54734           $ref: "#/definitions/relationship"
54735   availability-zones:
54736     description: |
54737       Collection of availability zones
54738     properties:
54739       availability-zone:
54740         type: array
54741         items:
54742           $ref: "#/definitions/availability-zone"
54743   az-and-dvs-switches:
54744     properties:
54745       dvs-switches:
54746         type: object
54747         $ref: "#/definitions/dvs-switches"
54748       availability-zone:
54749         type: object
54750         $ref: "#/definitions/availability-zone"
54751   business:
54752     description: |
54753       Namespace for business related constructs
54754     properties:
54755       connectors:
54756         type: array
54757         items:
54758           $ref: "#/definitions/connector"
54759       customers:
54760         type: array
54761         items:
54762           $ref: "#/definitions/customer"
54763       lines-of-business:
54764         type: array
54765         items:
54766           $ref: "#/definitions/line-of-business"
54767       owning-entities:
54768         type: array
54769         items:
54770           $ref: "#/definitions/owning-entity"
54771       platforms:
54772         type: array
54773         items:
54774           $ref: "#/definitions/platform"
54775       projects:
54776         type: array
54777         items:
54778           $ref: "#/definitions/project"
54779   class-of-service:
54780     description: |
54781       ###### Related Nodes
54782       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
54783     required:
54784     - cos
54785     properties:
54786       cos:
54787         type: string
54788         description: unique identifier of probe
54789       probe-id:
54790         type: string
54791         description: identifier of probe
54792       probe-type:
54793         type: string
54794         description: type of probe
54795       resource-version:
54796         type: string
54797         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54798       relationship-list:
54799         type: array
54800         items:
54801           $ref: "#/definitions/relationship"
54802   classes-of-service:
54803     description: |
54804       class-of-service of probe
54805     properties:
54806       class-of-service:
54807         type: array
54808         items:
54809           $ref: "#/definitions/class-of-service"
54810   cloud-infrastructure:
54811     description: |
54812       Namespace for cloud infrastructure.
54813     properties:
54814       complexes:
54815         type: array
54816         items:
54817           $ref: "#/definitions/complex"
54818       cloud-regions:
54819         type: array
54820         items:
54821           $ref: "#/definitions/cloud-region"
54822       network-profiles:
54823         type: array
54824         items:
54825           $ref: "#/definitions/network-profile"
54826       pservers:
54827         type: array
54828         items:
54829           $ref: "#/definitions/pserver"
54830       virtual-data-centers:
54831         type: array
54832         items:
54833           $ref: "#/definitions/virtual-data-center"
54834       operational-environments:
54835         type: array
54836         items:
54837           $ref: "#/definitions/operational-environment"
54838   cloud-region:
54839     description: |
54840       cloud-region designates an installation of a cloud cluster or region or instantiation.
54841       ###### Related Nodes
54842       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
54843       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54844       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54845       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
54846       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54847       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54848       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54849       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54850       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54851       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54852       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54853       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54854       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54855       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54856       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54857       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54858       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
54859       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
54860       - 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
54861       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
54862       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54863     required:
54864     - cloud-owner
54865     - cloud-region-id
54866     - sriov-automation
54867     properties:
54868       cloud-owner:
54869         type: string
54870         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
54871       cloud-region-id:
54872         type: string
54873         description: Identifier used by the vendor for the region. Second part of composite key
54874       cloud-type:
54875         type: string
54876         description: Type of the cloud (e.g., openstack)
54877       owner-defined-type:
54878         type: string
54879         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
54880       cloud-region-version:
54881         type: string
54882         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
54883       identity-url:
54884         type: string
54885         description: URL of the keystone identity service
54886       cloud-zone:
54887         type: string
54888         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
54889       complex-name:
54890         type: string
54891         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
54892       sriov-automation:
54893         type: boolean
54894       cloud-extra-info:
54895         type: string
54896         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
54897       cloud-epa-caps:
54898         type: string
54899         description: MultiVIM will discover and expose EPA capabilities.
54900       resource-version:
54901         type: string
54902         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54903       volume-groups:
54904         type: array
54905         items:
54906           $ref: "#/definitions/volume-group"
54907       tenants:
54908         type: array
54909         items:
54910           $ref: "#/definitions/tenant"
54911       flavors:
54912         type: array
54913         items:
54914           $ref: "#/definitions/flavor"
54915       group-assignments:
54916         type: array
54917         items:
54918           $ref: "#/definitions/group-assignment"
54919       snapshots:
54920         type: array
54921         items:
54922           $ref: "#/definitions/snapshot"
54923       images:
54924         type: array
54925         items:
54926           $ref: "#/definitions/image"
54927       dvs-switches:
54928         type: array
54929         items:
54930           $ref: "#/definitions/dvs-switch"
54931       oam-networks:
54932         type: array
54933         items:
54934           $ref: "#/definitions/oam-network"
54935       availability-zones:
54936         type: array
54937         items:
54938           $ref: "#/definitions/availability-zone"
54939       relationship-list:
54940         type: array
54941         items:
54942           $ref: "#/definitions/relationship"
54943       vip-ipv4-address-list:
54944         type: array
54945         items:
54946           $ref: "#/definitions/vip-ipv4-address-list"
54947       vip-ipv6-address-list:
54948         type: array
54949         items:
54950           $ref: "#/definitions/vip-ipv6-address-list"
54951       hpa-capabilities:
54952         type: array
54953         items:
54954           $ref: "#/definitions/hpa-capability"
54955         description: List of cloud-region specific HPA Capabilities
54956   cloud-regions:
54957     properties:
54958       cloud-region:
54959         type: array
54960         items:
54961           $ref: "#/definitions/cloud-region"
54962   complex:
54963     description: |
54964       Collection of physical locations that can house cloud-regions.
54965       ###### Related Nodes
54966       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54967       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54968       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54969       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
54970       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
54971       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
54972       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54973       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54974       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
54975       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54976       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54977       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54978       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
54979       - COMPLEX is DELETED when these are DELETED CTAG-POOL
54980     required:
54981     - physical-location-id
54982     - physical-location-type
54983     - street1
54984     - city
54985     - postal-code
54986     - country
54987     - region
54988     properties:
54989       physical-location-id:
54990         type: string
54991         description: Unique identifier for physical location, e.g., CLLI
54992       data-center-code:
54993         type: string
54994         description: Data center code which can be an alternate way to identify a complex
54995       complex-name:
54996         type: string
54997         description: Gamma complex name for LCP instance.
54998       identity-url:
54999         type: string
55000         description: URL of the keystone identity service
55001       resource-version:
55002         type: string
55003         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55004       physical-location-type:
55005         type: string
55006         description: Type, e.g., central office, data center.
55007       street1:
55008         type: string
55009       street2:
55010         type: string
55011       city:
55012         type: string
55013       state:
55014         type: string
55015       postal-code:
55016         type: string
55017       country:
55018         type: string
55019       region:
55020         type: string
55021       latitude:
55022         type: string
55023       longitude:
55024         type: string
55025       elevation:
55026         type: string
55027       lata:
55028         type: string
55029       ctag-pools:
55030         type: array
55031         items:
55032           $ref: "#/definitions/ctag-pool"
55033       relationship-list:
55034         type: array
55035         items:
55036           $ref: "#/definitions/relationship"
55037   complexes:
55038     description: |
55039       Collection of physical locations that can house cloud-regions.
55040     properties:
55041       complex:
55042         type: array
55043         items:
55044           $ref: "#/definitions/complex"
55045   configuration:
55046     description: |
55047       Port Mirror Configuration.
55048       ###### Related Nodes
55049       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
55050       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55051       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
55052       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
55053       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
55054       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
55055       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
55056       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
55057       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
55058       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
55059       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
55060       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
55061       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
55062     required:
55063     - configuration-id
55064     - configuration-type
55065     - configuration-sub-type
55066     - orchestration-status
55067     - operational-status
55068     - configuration-selflink
55069     - model-customization-id
55070     properties:
55071       configuration-id:
55072         type: string
55073         description: UUID assigned to configuration.
55074       management-option:
55075         type: string
55076         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
55077       configuration-name:
55078         type: string
55079         description: Name of the configuration.
55080       configuration-type:
55081         type: string
55082         description: port-mirroring-configuration.
55083       configuration-sub-type:
55084         type: string
55085         description: vprobe, pprobe.
55086       model-invariant-id:
55087         type: string
55088         description: the ASDC model id for this resource or service model.
55089       model-version-id:
55090         type: string
55091         description: the ASDC model version for this resource or service model.
55092       orchestration-status:
55093         type: string
55094         description: Orchestration status of the configuration.
55095       operational-status:
55096         type: string
55097         description: Indicator for whether the resource is considered operational.
55098       configuration-selflink:
55099         type: string
55100         description: URL to endpoint where AAI can get more details from SDN-GC.
55101       model-customization-id:
55102         type: string
55103         description: id of  the configuration used to customize the resource
55104       tunnel-bandwidth:
55105         type: string
55106         description: DHV Site Effective Bandwidth
55107       vendor-allowed-max-bandwidth:
55108         type: string
55109         description: Velocloud Nominal Throughput - VNT
55110       resource-version:
55111         type: string
55112         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55113       relationship-list:
55114         type: array
55115         items:
55116           $ref: "#/definitions/relationship"
55117       metadata:
55118         type: array
55119         items:
55120           $ref: "#/definitions/metadatum"
55121       forwarder-evcs:
55122         type: array
55123         items:
55124           $ref: "#/definitions/forwarder-evc"
55125       evcs:
55126         type: array
55127         items:
55128           $ref: "#/definitions/evc"
55129   configurations:
55130     description: |
55131       Collection of configurations
55132     properties:
55133       configuration:
55134         type: array
55135         items:
55136           $ref: "#/definitions/configuration"
55137   connector:
55138     description: |
55139       Collection of resource instances used to connect a variety of disparate inventory widgets
55140       ###### Related Nodes
55141       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
55142       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
55143       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
55144       - CONNECTOR is DELETED when these are DELETED METADATUM
55145     required:
55146     - resource-instance-id
55147     properties:
55148       resource-instance-id:
55149         type: string
55150         description: Unique id of resource instance.
55151       resource-version:
55152         type: string
55153         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55154       model-invariant-id:
55155         type: string
55156         description: the ASDC model id for this resource or service model.
55157       model-version-id:
55158         type: string
55159         description: the ASDC model version for this resource or service model.
55160       persona-model-version:
55161         type: string
55162         description: the ASDC model version for this resource or service model.
55163       widget-model-id:
55164         type: string
55165         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55166       widget-model-version:
55167         type: string
55168         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55169       relationship-list:
55170         type: array
55171         items:
55172           $ref: "#/definitions/relationship"
55173       metadata:
55174         type: array
55175         items:
55176           $ref: "#/definitions/metadatum"
55177   connectors:
55178     description: |
55179       Collection of resource instances used to connect a variety of disparate inventory widgets
55180     properties:
55181       connector:
55182         type: array
55183         items:
55184           $ref: "#/definitions/connector"
55185   constrained-element-set:
55186     description: |
55187       This is how we would capture constraints defining allowed sets of elements.
55188       ###### Related Nodes
55189       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
55190       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55191       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
55192       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
55193     required:
55194     - constrained-element-set-uuid
55195     - constraint-type
55196     - check-type
55197     properties:
55198       constrained-element-set-uuid:
55199         type: string
55200       constraint-type:
55201         type: string
55202       check-type:
55203         type: string
55204       resource-version:
55205         type: string
55206       element-choice-sets:
55207         type: array
55208         items:
55209           $ref: "#/definitions/element-choice-set"
55210       relationship-list:
55211         type: array
55212         items:
55213           $ref: "#/definitions/relationship"
55214   constrained-element-sets:
55215     properties:
55216       constrained-element-set:
55217         type: array
55218         items:
55219           $ref: "#/definitions/constrained-element-set"
55220   ctag-assignment:
55221     description: |
55222       ###### Related Nodes
55223       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55224       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
55225     required:
55226     - vlan-id-inner
55227     properties:
55228       vlan-id-inner:
55229         type: integer
55230         format: int64
55231         description: id.
55232       resource-version:
55233         type: string
55234         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55235       relationship-list:
55236         type: array
55237         items:
55238           $ref: "#/definitions/relationship"
55239   ctag-assignments:
55240     properties:
55241       ctag-assignment:
55242         type: array
55243         items:
55244           $ref: "#/definitions/ctag-assignment"
55245   ctag-pool:
55246     description: |
55247       A collection of C tags (vlan tags) grouped for a specific purpose.
55248       ###### Related Nodes
55249       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
55250       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
55251       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
55252       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
55253     required:
55254     - target-pe
55255     - availability-zone-name
55256     - ctag-pool-purpose
55257     properties:
55258       target-pe:
55259         type: string
55260         description: The Target provider edge router
55261       availability-zone-name:
55262         type: string
55263         description: Name of the availability zone
55264       ctag-pool-purpose:
55265         type: string
55266         description: Describes what the intended purpose of this pool is.
55267       ctag-values:
55268         type: string
55269         description: Comma separated list of ctags
55270       resource-version:
55271         type: string
55272         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55273       relationship-list:
55274         type: array
55275         items:
55276           $ref: "#/definitions/relationship"
55277   ctag-pools:
55278     properties:
55279       ctag-pool:
55280         type: array
55281         items:
55282           $ref: "#/definitions/ctag-pool"
55283   customer:
55284     description: |
55285       customer identifiers to provide linkage back to BSS information.
55286       ###### Related Nodes
55287       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
55288       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
55289     required:
55290     - global-customer-id
55291     - subscriber-name
55292     - subscriber-type
55293     properties:
55294       global-customer-id:
55295         type: string
55296         description: Global customer id used across ECOMP to uniquely identify customer.
55297       subscriber-name:
55298         type: string
55299         description: Subscriber name, an alternate way to retrieve a customer.
55300       subscriber-type:
55301         type: string
55302         description: Subscriber type, a way to provide VID with only the INFRA customers.
55303       resource-version:
55304         type: string
55305         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55306       service-subscriptions:
55307         type: array
55308         items:
55309           $ref: "#/definitions/service-subscription"
55310       relationship-list:
55311         type: array
55312         items:
55313           $ref: "#/definitions/relationship"
55314   customers:
55315     description: |
55316       Collection of customer identifiers to provide linkage back to BSS information.
55317     properties:
55318       customer:
55319         type: array
55320         items:
55321           $ref: "#/definitions/customer"
55322   cvlan-tag-entry:
55323     required:
55324     - cvlan-tag
55325     properties:
55326       cvlan-tag:
55327         type: integer
55328         format: int64
55329         description: See mis-na-virtualization-platform.yang
55330       resource-version:
55331         type: string
55332         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55333       relationship-list:
55334         type: array
55335         items:
55336           $ref: "#/definitions/relationship"
55337   cvlan-tags:
55338     properties:
55339       cvlan-tag-entry:
55340         type: array
55341         items:
55342           $ref: "#/definitions/cvlan-tag-entry"
55343   dvs-switch:
55344     description: |
55345       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.
55346       ###### Related Nodes
55347       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55348       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
55349     required:
55350     - switch-name
55351     - vcenter-url
55352     properties:
55353       switch-name:
55354         type: string
55355         description: DVS switch name
55356       vcenter-url:
55357         type: string
55358         description: URL used to reach the vcenter
55359       resource-version:
55360         type: string
55361         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55362       relationship-list:
55363         type: array
55364         items:
55365           $ref: "#/definitions/relationship"
55366   dvs-switches:
55367     description: |
55368       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
55369     properties:
55370       dvs-switch:
55371         type: array
55372         items:
55373           $ref: "#/definitions/dvs-switch"
55374   edge-prop-names:
55375     description: |
55376       Internal map to define the properties of an edge and interpret the map EdgeRules
55377     properties:
55378       edgeLabel:
55379         type: string
55380       direction:
55381         type: string
55382       multiplicityRule:
55383         type: string
55384       contains-other-v:
55385         type: string
55386       delete-other-v:
55387         type: string
55388       SVC-INFRA:
55389         type: string
55390       prevent-delete:
55391         type: string
55392       aai-uuid:
55393         type: string
55394   edge-tag-query-request:
55395     properties:
55396       edge-tag:
55397         type: string
55398       result-detail:
55399         type: string
55400       start-node-type:
55401         type: string
55402       start-node-filter:
55403         type: array
55404         items:
55405           $ref: "#/definitions/start-node-filter"
55406       include-node-filter:
55407         type: array
55408         items:
55409           $ref: "#/definitions/include-node-filter"
55410       secondary-filter:
55411         type: array
55412         items:
55413           $ref: "#/definitions/secondary-filter"
55414   edge-tag-query-result:
55415     properties:
55416       tagged-inventory-item-list:
55417         type: array
55418         items:
55419           $ref: "#/definitions/tagged-inventory-item-list"
55420   element-choice-set:
55421     description: |
55422       This is how we would capture constraints defining allowed sets of elements.
55423       ###### Related Nodes
55424       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
55425       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55426       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
55427     required:
55428     - element-choice-set-uuid
55429     - element-choice-set-name
55430     properties:
55431       element-choice-set-uuid:
55432         type: string
55433       element-choice-set-name:
55434         type: string
55435       cardinality:
55436         type: string
55437       resource-version:
55438         type: string
55439       model-elements:
55440         type: array
55441         items:
55442           $ref: "#/definitions/model-element"
55443       relationship-list:
55444         type: array
55445         items:
55446           $ref: "#/definitions/relationship"
55447   element-choice-sets:
55448     properties:
55449       element-choice-set:
55450         type: array
55451         items:
55452           $ref: "#/definitions/element-choice-set"
55453   entitlement:
55454     description: |
55455       Metadata for entitlement group.
55456       ###### Related Nodes
55457       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55458       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55459     required:
55460     - group-uuid
55461     - resource-uuid
55462     properties:
55463       group-uuid:
55464         type: string
55465         description: Unique ID for the entitlement group the resource comes from, should be uuid.
55466       resource-uuid:
55467         type: string
55468         description: Unique ID of an entitlement resource.
55469       resource-version:
55470         type: string
55471         description: Concurrency value
55472       relationship-list:
55473         type: array
55474         items:
55475           $ref: "#/definitions/relationship"
55476   entitlements:
55477     description: |
55478       Entitlements, keyed by group-uuid and resource-uuid, related to license management
55479     properties:
55480       entitlement:
55481         type: array
55482         items:
55483           $ref: "#/definitions/entitlement"
55484   esr-ems:
55485     description: |
55486       Persist EMS address information used by EMS driver.
55487       ###### Related Nodes
55488       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
55489       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
55490     required:
55491     - ems-id
55492     properties:
55493       ems-id:
55494         type: string
55495         description: Unique ID of EMS.
55496       resource-version:
55497         type: string
55498         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55499       esr-system-info-list:
55500         type: object
55501         $ref: "#/definitions/esr-system-info-list"
55502       relationship-list:
55503         type: object
55504         $ref: "#/definitions/relationship-list"
55505   esr-ems-list:
55506     properties:
55507       esr-ems:
55508         type: array
55509         items:
55510           $ref: "#/definitions/esr-ems"
55511   esr-system-info:
55512     description: |
55513       Persist common address information of external systems.
55514       ###### Related Nodes
55515       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
55516       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
55517       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
55518       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
55519     required:
55520     - esr-system-info-id
55521     - user-name
55522     - password
55523     - system-type
55524     properties:
55525       esr-system-info-id:
55526         type: string
55527         description: Unique ID of esr system info.
55528       system-name:
55529         type: string
55530         description: name of external system.
55531       type:
55532         type: string
55533         description: type of external systems.
55534       vendor:
55535         type: string
55536         description: vendor of external systems.
55537       version:
55538         type: string
55539         description: version of external systems.
55540       service-url:
55541         type: string
55542         description: url used to access external systems.
55543       user-name:
55544         type: string
55545         description: username used to access external systems.
55546       password:
55547         type: string
55548         description: password used to access external systems.
55549       system-type:
55550         type: string
55551         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
55552       protocol:
55553         type: string
55554         description: protocol of third party SDNC, for example netconf/snmp.
55555       ssl-cacert:
55556         type: string
55557         description: ca file content if enabled ssl on auth-url.
55558       ssl-insecure:
55559         type: boolean
55560         description: Whether to verify VIM's certificate.
55561       ip-address:
55562         type: string
55563         description: service IP of ftp server.
55564       port:
55565         type: string
55566         description: service port of ftp server.
55567       cloud-domain:
55568         type: string
55569         description: domain info for authentication.
55570       default-tenant:
55571         type: string
55572         description: default tenant of VIM.
55573       passive:
55574         type: boolean
55575         description: ftp passive mode or not.
55576       remote-path:
55577         type: string
55578         description: resource or performance data file path.
55579       system-status:
55580         type: string
55581         description: the status of external system.
55582       resource-version:
55583         type: string
55584         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55585       relationship-list:
55586         type: object
55587         $ref: "#/definitions/relationship-list"
55588   esr-system-info-list:
55589     description: |
55590       Collection of persistent block-level external system auth info.
55591     properties:
55592       esr-system-info:
55593         type: array
55594         items:
55595           $ref: "#/definitions/esr-system-info"
55596   esr-thirdparty-sdnc:
55597     description: |
55598       Persist SDNC address information used by ONAP SDNC.
55599       ###### Related Nodes
55600       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
55601       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
55602       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
55603     required:
55604     - thirdparty-sdnc-id
55605     properties:
55606       thirdparty-sdnc-id:
55607         type: string
55608         description: Unique ID of SDNC.
55609       location:
55610         type: string
55611         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
55612       product-name:
55613         type: string
55614         description: password used to access SDNC server.
55615       resource-version:
55616         type: string
55617         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55618       esr-system-info-list:
55619         type: object
55620         $ref: "#/definitions/esr-system-info-list"
55621       relationship-list:
55622         type: object
55623         $ref: "#/definitions/relationship-list"
55624   esr-thirdparty-sdnc-list:
55625     properties:
55626       esr-thirdparty-sdnc:
55627         type: array
55628         items:
55629           $ref: "#/definitions/esr-thirdparty-sdnc"
55630   esr-vnfm:
55631     description: |
55632       Persist VNFM address information used by VF-C.
55633       ###### Related Nodes
55634       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
55635       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
55636     required:
55637     - vnfm-id
55638     properties:
55639       vnfm-id:
55640         type: string
55641         description: Unique ID of VNFM.
55642       vim-id:
55643         type: string
55644         description: indecate the VIM to deploy VNF.
55645       certificate-url:
55646         type: string
55647         description: certificate url of VNFM.
55648       resource-version:
55649         type: string
55650         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55651       esr-system-info-list:
55652         type: object
55653         $ref: "#/definitions/esr-system-info-list"
55654       relationship-list:
55655         type: object
55656         $ref: "#/definitions/relationship-list"
55657   esr-vnfm-list:
55658     properties:
55659       esr-vnfm:
55660         type: array
55661         items:
55662           $ref: "#/definitions/esr-vnfm"
55663   evc:
55664     description: |
55665       evc object is an optional child object of the Configuration object.
55666       ###### Related Nodes
55667       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
55668     required:
55669     - evc-id
55670     properties:
55671       evc-id:
55672         type: string
55673         description: Unique/key field for the evc object
55674       forwarding-path-topology:
55675         type: string
55676         description: Point-to-Point, Multi-Point
55677       cir-value:
55678         type: string
55679         description: Commited Information Rate
55680       cir-units:
55681         type: string
55682         description: CIR units
55683       connection-diversity-group-id:
55684         type: string
55685         description: Diversity Group ID
55686       service-hours:
55687         type: string
55688         description: formerly Performance Group
55689       esp-evc-circuit-id:
55690         type: string
55691         description: EVC Circuit ID of ESP EVC
55692       esp-evc-cir-value:
55693         type: string
55694         description: Committed Information Rate (For ESP)
55695       esp-evc-cir-units:
55696         type: string
55697         description: CIR units (For ESP)
55698       esp-itu-code:
55699         type: string
55700         description: Identifies ESP
55701       collector-pop-clli:
55702         type: string
55703         description: Collector POP CLLI (from the hostname of the access pnf)
55704       inter-connect-type-ingress:
55705         type: string
55706         description: Interconnect type on ingress side of EVC.
55707       tagmode-access-ingress:
55708         type: string
55709         description: tagode for collector side of EVC
55710       tagmode-access-egress:
55711         type: string
55712         description: tagMode for network side of EVC
55713       relationship-list:
55714         type: array
55715         items:
55716           $ref: "#/definitions/relationship"
55717       resource-version:
55718         type: string
55719         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55720   evcs:
55721     properties:
55722       evc:
55723         type: array
55724         items:
55725           $ref: "#/definitions/evc"
55726   external-system:
55727     description: |
55728       Namespace for external system.
55729     properties:
55730       esr-ems-list:
55731         type: object
55732         $ref: "#/definitions/esr-ems-list"
55733       esr-vnfm-list:
55734         type: object
55735         $ref: "#/definitions/esr-vnfm-list"
55736       esr-thirdparty-sdnc-list:
55737         type: object
55738         $ref: "#/definitions/esr-thirdparty-sdnc-list"
55739   extra-properties:
55740     description: |
55741       Extra properties for inventory item for response list
55742     properties:
55743       extra-property:
55744         type: array
55745         items:
55746           $ref: "#/definitions/extra-property"
55747   extra-property:
55748     properties:
55749       property-name:
55750         type: string
55751       property-value:
55752         type: string
55753   flavor:
55754     description: |
55755       Openstack flavor.
55756       ###### Related Nodes
55757       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55758       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
55759       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
55760       - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
55761     required:
55762     - flavor-id
55763     - flavor-name
55764     - flavor-selflink
55765     properties:
55766       flavor-id:
55767         type: string
55768         description: Flavor id, expected to be unique across cloud-region.
55769       flavor-name:
55770         type: string
55771         description: Cloud Region Flavor name
55772       flavor-vcpus:
55773         type: integer
55774         format: int32
55775         description: Number of CPUs
55776       flavor-ram:
55777         type: integer
55778         format: int32
55779         description: Amount of memory
55780       flavor-disk:
55781         type: integer
55782         format: int32
55783         description: Disk space
55784       flavor-ephemeral:
55785         type: integer
55786         format: int32
55787         description: Amount of ephemeral disk space
55788       flavor-swap:
55789         type: string
55790         description: amount of swap space allocation
55791       flavor-is-public:
55792         type: boolean
55793         description: whether flavor is available to all users or private to the tenant it was created in.
55794       flavor-selflink:
55795         type: string
55796         description: URL to endpoint where AAI can get more details
55797       flavor-disabled:
55798         type: boolean
55799         description: Boolean as to whether this flavor is no longer enabled
55800       hpa-capabilities:
55801         type: array
55802         items:
55803           $ref: "#/definitions/hpa-capability"
55804         description: List of flavor specific HPA Capabilities
55805       resource-version:
55806         type: string
55807         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55808       relationship-list:
55809         type: array
55810         items:
55811           $ref: "#/definitions/relationship"
55812   flavors:
55813     description: |
55814       Collection of openstack flavors.
55815     properties:
55816       flavor:
55817         type: array
55818         items:
55819           $ref: "#/definitions/flavor"
55820   forwarder:
55821     description: |
55822       Entity describing a sequenced segment of forwarding path
55823       ###### Related Nodes
55824       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
55825       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
55826       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
55827       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
55828       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
55829       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
55830     required:
55831     - sequence
55832     properties:
55833       sequence:
55834         type: integer
55835         format: int32
55836         description: Unique ID of this segmentation
55837       forwarder-role:
55838         type: string
55839         description: ingress, intermediate, egress
55840       relationship-list:
55841         type: array
55842         items:
55843           $ref: "#/definitions/relationship"
55844       resource-version:
55845         type: string
55846         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55847   forwarder-evc:
55848     description: |
55849       forwarder object is an optional child object of the Configuration object.
55850       ###### Related Nodes
55851       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
55852     required:
55853     - forwarder-evc-id
55854     properties:
55855       forwarder-evc-id:
55856         type: string
55857         description: Key for forwarder-evc object
55858       circuit-id:
55859         type: string
55860         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
55861       ivlan:
55862         type: string
55863         description: Internal VLAN.
55864       svlan:
55865         type: string
55866         description: SVLAN value for ingress of egress forwarder.
55867       cvlan:
55868         type: string
55869         description: CVLAN value for ingress of egress forwarder.
55870       relationship-list:
55871         type: array
55872         items:
55873           $ref: "#/definitions/relationship"
55874       resource-version:
55875         type: string
55876         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55877   forwarder-evcs:
55878     properties:
55879       forwarder-evc:
55880         type: array
55881         items:
55882           $ref: "#/definitions/forwarder-evc"
55883   forwarders:
55884     properties:
55885       forwarder:
55886         type: array
55887         items:
55888           $ref: "#/definitions/forwarder"
55889   forwarding-path:
55890     description: |
55891       Entity that describes the sequenced forwarding path between interfaces of services or resources
55892       ###### Related Nodes
55893       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
55894       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
55895       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
55896       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
55897       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
55898     required:
55899     - forwarding-path-id
55900     - forwarding-path-name
55901     properties:
55902       forwarding-path-id:
55903         type: string
55904         description: Unique ID of this FP
55905       forwarding-path-name:
55906         type: string
55907         description: Name of the FP
55908       relationship-list:
55909         type: array
55910         items:
55911           $ref: "#/definitions/relationship"
55912       resource-version:
55913         type: string
55914         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55915       selflink:
55916         type: string
55917         description: the self link for this FP
55918       forwarders:
55919         type: array
55920         items:
55921           $ref: "#/definitions/forwarder"
55922   forwarding-paths:
55923     properties:
55924       forwarding-path:
55925         type: array
55926         items:
55927           $ref: "#/definitions/forwarding-path"
55928   generic-vnf:
55929     description: |
55930       General purpose VNF
55931       ###### Related Nodes
55932       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
55933       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
55934       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
55935       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
55936       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55937       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
55938       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55939       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
55940       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
55941       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
55942       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
55943       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
55944       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
55945       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
55946       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
55947       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
55948       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55949       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55950       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55951       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55952       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55953       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55954       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
55955       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55956       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55957       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55958       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
55959       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55960       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
55961       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
55962     required:
55963     - vnf-id
55964     - vnf-instance-id
55965     - vnf-name
55966     - vnf-type
55967     - vnf-package-name
55968     - vnf-discriptor-name
55969     - job-id
55970     - in-maint
55971     - is-closed-loop-disabled
55972     properties:
55973       vnf-id:
55974         type: string
55975         description: Unique id of VNF.  This is unique across the graph.
55976       vnf-instance-id:
55977         type: string
55978         description: vnf instance id.
55979       vnf-name:
55980         type: string
55981         description: Name of VNF.
55982       vnf-name2:
55983         type: string
55984         description: Alternate name of VNF.
55985       vnf-type:
55986         type: string
55987         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.
55988       service-id:
55989         type: string
55990         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
55991       regional-resource-zone:
55992         type: string
55993         description: Regional way of organizing pservers, source of truth should define values
55994       prov-status:
55995         type: string
55996         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55997       operational-status:
55998         type: string
55999         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
56000       license-key:
56001         type: string
56002         description: OBSOLETE -  do not use
56003       equipment-role:
56004         type: string
56005         description: Client should send valid enumerated value
56006       orchestration-status:
56007         type: string
56008         description: Orchestration status of this VNF, used by MSO.
56009       vnf-package-name:
56010         type: string
56011       vnf-discriptor-name:
56012         type: string
56013         description: vnf discriptor name
56014       job-id:
56015         type: string
56016         description: job id corresponding to vnf
56017       heat-stack-id:
56018         type: string
56019         description: Heat stack id corresponding to this instance, managed by MSO
56020       mso-catalog-key:
56021         type: string
56022         description: Corresponds to the SDN-C catalog id used to configure this VCE
56023       management-option:
56024         type: string
56025         description: identifier of managed by ATT or customer
56026       ipv4-oam-address:
56027         type: string
56028         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
56029       ipv4-loopback0-address:
56030         type: string
56031         description: v4 Loopback0 address
56032       nm-lan-v6-address:
56033         type: string
56034         description: v6 Loopback address
56035       management-v6-address:
56036         type: string
56037         description: v6 management address
56038       vcpu:
56039         type: integer
56040         format: int64
56041         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
56042       vcpu-units:
56043         type: string
56044         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
56045       vmemory:
56046         type: integer
56047         format: int64
56048         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
56049       vmemory-units:
56050         type: string
56051         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
56052       vdisk:
56053         type: integer
56054         format: int64
56055         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
56056       vdisk-units:
56057         type: string
56058         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
56059       nshd:
56060         type: integer
56061         format: int64
56062         description: number of associated SHD in vnf.
56063       nvm:
56064         type: integer
56065         format: int64
56066         description: number of vms in vnf.
56067       nnet:
56068         type: integer
56069         format: int64
56070         description: number of network in vnf.
56071       in-maint:
56072         type: boolean
56073       is-closed-loop-disabled:
56074         type: boolean
56075       resource-version:
56076         type: string
56077         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56078       summary-status:
56079         type: string
56080         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
56081       encrypted-access-flag:
56082         type: boolean
56083         description: indicates whether generic-vnf access uses SSH
56084       entitlement-assignment-group-uuid:
56085         type: string
56086         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
56087       entitlement-resource-uuid:
56088         type: string
56089         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
56090       license-assignment-group-uuid:
56091         type: string
56092         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
56093       license-key-uuid:
56094         type: string
56095         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
56096       model-invariant-id:
56097         type: string
56098         description: the ASDC model id for this resource or service model.
56099       model-version-id:
56100         type: string
56101         description: the ASDC model version for this resource or service model.
56102       persona-model-version:
56103         type: string
56104         description: the ASDC model version for this resource or service model.
56105       model-customization-id:
56106         type: string
56107         description: captures the id of all the configuration used to customize the resource for the service.
56108       widget-model-id:
56109         type: string
56110         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56111       widget-model-version:
56112         type: string
56113         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56114       as-number:
56115         type: string
56116         description: as-number of the VNF
56117       regional-resource-subzone:
56118         type: string
56119         description: represents sub zone of the rr plane
56120       nf-type:
56121         type: string
56122         description: Generic description of the type of NF
56123       nf-function:
56124         type: string
56125         description: English description of Network function that the specific VNF deployment is providing
56126       nf-role:
56127         type: string
56128         description: role in the network that this model will be providing
56129       nf-naming-code:
56130         type: string
56131         description: string assigned to this model used for naming purposes
56132       selflink:
56133         type: string
56134         description: Path to the controller object.
56135       ipv4-oam-gateway-address:
56136         type: string
56137         description: Gateway address
56138       ipv4-oam-gateway-address-prefix-length:
56139         type: integer
56140         format: int32
56141         description: Prefix length for oam-address
56142       vlan-id-outer:
56143         type: integer
56144         format: int64
56145         description: Temporary location for S-TAG to get to VCE
56146       nm-profile-name:
56147         type: string
56148         description: Network Management profile of this VNF
56149       relationship-list:
56150         type: array
56151         items:
56152           $ref: "#/definitions/relationship"
56153       l-interfaces:
56154         type: array
56155         items:
56156           $ref: "#/definitions/l-interface"
56157       lag-interfaces:
56158         type: array
56159         items:
56160           $ref: "#/definitions/lag-interface"
56161       vf-modules:
56162         type: array
56163         items:
56164           $ref: "#/definitions/vf-module"
56165       licenses:
56166         type: array
56167         items:
56168           $ref: "#/definitions/license"
56169       entitlements:
56170         type: array
56171         items:
56172           $ref: "#/definitions/entitlement"
56173   generic-vnfs:
56174     description: |
56175       Collection of VNFs
56176     properties:
56177       generic-vnf:
56178         type: array
56179         items:
56180           $ref: "#/definitions/generic-vnf"
56181   group-assignment:
56182     description: |
56183       Openstack group-assignment used to store exclusivity groups (EG).
56184       ###### Related Nodes
56185       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56186       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
56187       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
56188     required:
56189     - group-id
56190     - group-type
56191     - group-name
56192     properties:
56193       group-id:
56194         type: string
56195         description: Group id, expected to be unique across cloud-region.
56196       group-type:
56197         type: string
56198         description: Group type - the type of group this instance refers to
56199       group-name:
56200         type: string
56201         description: Group name - name assigned to the group
56202       group-description:
56203         type: string
56204         description: Group description - description of the group
56205       resource-version:
56206         type: string
56207         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56208       relationship-list:
56209         type: array
56210         items:
56211           $ref: "#/definitions/relationship"
56212   group-assignments:
56213     description: |
56214       Collection of openstack group assignments
56215     properties:
56216       group-assignment:
56217         type: array
56218         items:
56219           $ref: "#/definitions/group-assignment"
56220   host-route:
56221     description: |
56222       ###### Related Nodes
56223       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
56224     required:
56225     - host-route-id
56226     - route-prefix
56227     - next-hop
56228     properties:
56229       host-route-id:
56230         type: string
56231         description: host-route id
56232       route-prefix:
56233         type: string
56234         description: subnet prefix
56235       next-hop:
56236         type: string
56237         description: Could be ip-address, hostname, or service-instance
56238       next-hop-type:
56239         type: string
56240         description: Should be ip-address, hostname, or service-instance to match next-hop
56241       resource-version:
56242         type: string
56243         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56244       relationship-list:
56245         type: array
56246         items:
56247           $ref: "#/definitions/relationship"
56248   host-routes:
56249     properties:
56250       host-route:
56251         type: array
56252         items:
56253           $ref: "#/definitions/host-route"
56254   hpa-capabilities:
56255     description: |
56256       Collection of HPA Capabilities
56257     properties:
56258       hpa-capability:
56259         type: array
56260         items:
56261           $ref: "#/definitions/hpa-capability"
56262   hpa-capability:
56263     description: |
56264       Represents a HPA capability
56265       ###### Related Nodes
56266       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
56267       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56268       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
56269       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
56270     required:
56271     - hpa-capability-id
56272     - hpa-feature
56273     properties:
56274       hpa-capability-id:
56275         type: string
56276         description: UUID to uniquely identify a HPA capability
56277       hpa-feature:
56278         type: string
56279         description: Name of the HPACapability
56280       hpa-version:
56281         type: string
56282         description: HPA schema version
56283       architecture:
56284         type: string
56285         description: Hardware architecture
56286       resource-version:
56287         type: string
56288         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56289       relationship-list:
56290         type: array
56291         items:
56292           $ref: "#/definitions/relationship"
56293       hpa-feature-attributes:
56294         type: array
56295         items:
56296           $ref: "#/definitions/hpa-feature-attributes"
56297   hpa-feature-attributes:
56298     description: |
56299       HPA Capability Feature attributes
56300       ###### Related Nodes
56301       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
56302     required:
56303     - hpa-attribute-key
56304     properties:
56305       hpa-attribute-key:
56306         type: string
56307         description: name of the specific HPA attribute
56308       hpa-attribute-value:
56309         type: string
56310         description: JSON string specifying the value, unit and type of the specific HPA attribute
56311       resource-version:
56312         type: string
56313         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56314       relationship-list:
56315         type: array
56316         items:
56317           $ref: "#/definitions/relationship"
56318   image:
56319     description: |
56320       Openstack image.
56321       ###### Related Nodes
56322       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56323       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
56324       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
56325       - IMAGE cannot be deleted if linked to VSERVER
56326       - IMAGE is DELETED when these are DELETED METADATUM
56327     required:
56328     - image-id
56329     - image-name
56330     - image-os-distro
56331     - image-os-version
56332     - image-selflink
56333     properties:
56334       image-id:
56335         type: string
56336         description: Image id, expected to be unique across cloud region
56337       image-name:
56338         type: string
56339         description: Image name
56340       image-architecture:
56341         type: string
56342         description: Operating system architecture.
56343       image-os-distro:
56344         type: string
56345         description: The common name of the operating system distribution in lowercase
56346       image-os-version:
56347         type: string
56348         description: The operating system version as specified by the distributor.
56349       application:
56350         type: string
56351         description: The application that the image instantiates.
56352       application-vendor:
56353         type: string
56354         description: The vendor of the application.
56355       application-version:
56356         type: string
56357         description: The version of the application.
56358       image-selflink:
56359         type: string
56360         description: URL to endpoint where AAI can get more details
56361       resource-version:
56362         type: string
56363         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56364       relationship-list:
56365         type: array
56366         items:
56367           $ref: "#/definitions/relationship"
56368       metadata:
56369         type: array
56370         items:
56371           $ref: "#/definitions/metadatum"
56372   images:
56373     description: |
56374       Collectio of Openstack images.
56375     properties:
56376       image:
56377         type: array
56378         items:
56379           $ref: "#/definitions/image"
56380   include-node-filter:
56381     properties:
56382       include-node-type:
56383         type: string
56384   instance-filter:
56385     description: |
56386       InstanceFilter for performing a named-query or model query
56387   instance-filters:
56388     description: |
56389       InstanceFilters for performing a named-query or model query
56390     properties:
56391       instance-filter:
56392         type: array
56393         items:
56394           $ref: "#/definitions/instance-filter"
56395   instance-group:
56396     description: |
56397       General mechanism for grouping instances
56398       ###### Related Nodes
56399       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
56400       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56401       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56402       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56403       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56404       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56405       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56406       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56407       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56408       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56409       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56410       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56411     required:
56412     - instance-group-role
56413     - model-invariant-id
56414     - model-version-id
56415     - id
56416     - description
56417     - type
56418     properties:
56419       instance-group-role:
56420         type: string
56421         description: role of the instance group.
56422       model-invariant-id:
56423         type: string
56424         description: ASDC model id for this resource or service model.
56425       model-version-id:
56426         type: string
56427         description: ASDC model version uid for this resource model.
56428       id:
56429         type: string
56430         description: Instance Group ID, UUID assigned to this instance.
56431       description:
56432         type: string
56433         description: Descriptive text to help identify the usage of this instance-group
56434       type:
56435         type: string
56436         description: Only valid value today is lower case ha for high availability
56437       sub-type:
56438         type: string
56439         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
56440       resource-version:
56441         type: string
56442         description: Concurrency value
56443       relationship-list:
56444         type: array
56445         items:
56446           $ref: "#/definitions/relationship"
56447   instance-groups:
56448     description: |
56449       Collection of openstack route table references
56450     properties:
56451       instance-group:
56452         type: array
56453         items:
56454           $ref: "#/definitions/instance-group"
56455   inventory:
56456     properties:
56457       search:
56458         type: object
56459         $ref: "#/definitions/search"
56460       actions:
56461         type: object
56462         $ref: "#/definitions/actions"
56463       cloud-infrastructure:
56464         type: object
56465         $ref: "#/definitions/cloud-infrastructure"
56466       external-system:
56467         type: object
56468         $ref: "#/definitions/external-system"
56469       business:
56470         type: object
56471         $ref: "#/definitions/business"
56472       service-design-and-creation:
56473         type: object
56474         $ref: "#/definitions/service-design-and-creation"
56475       network:
56476         type: object
56477         $ref: "#/definitions/network"
56478       aai-internal:
56479         type: object
56480         $ref: "#/definitions/aai-internal"
56481       nodes:
56482         type: array
56483         items:
56484           $ref: "#/definitions/aai-internal"
56485   inventory-item:
56486     properties:
56487       inventory-item-type:
56488         type: string
56489       inventory-item-link:
56490         type: string
56491       inventory-item-data:
56492         type: array
56493         items:
56494           $ref: "#/definitions/inventory-item-data"
56495       tagged-inventory-item-list:
56496         type: array
56497         items:
56498           $ref: "#/definitions/tagged-inventory-item-list"
56499   inventory-item-data:
56500     properties:
56501       property-name:
56502         type: string
56503       property-value:
56504         type: string
56505   inventory-response-item:
56506     description: |
56507       Inventory item for response list
56508     properties:
56509       model-name:
56510         type: string
56511       extra-properties:
56512         type: object
56513         $ref: "#/definitions/extra-properties"
56514       inventory-response-items:
56515         type: object
56516         $ref: "#/definitions/inventory-response-items"
56517   inventory-response-items:
56518     description: |
56519       Container for inventory items in response list
56520     properties:
56521       inventory-response-item:
56522         type: array
56523         items:
56524           $ref: "#/definitions/inventory-response-item"
56525   ipsec-configuration:
56526     description: |
56527       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
56528       ###### Related Nodes
56529       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
56530       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
56531       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
56532     required:
56533     - ipsec-configuration-id
56534     properties:
56535       ipsec-configuration-id:
56536         type: string
56537         description: UUID of this configuration
56538       requested-vig-address-type:
56539         type: string
56540         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
56541       requested-encryption-strength:
56542         type: string
56543         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
56544       requested-dmz-type:
56545         type: string
56546         description: ATT can offer a shared DMZ or a DMZ specific to a customer
56547       shared-dmz-network-address:
56548         type: string
56549         description: Network address of shared DMZ
56550       requested-customer-name:
56551         type: string
56552         description: If the DMZ is a custom DMZ, this field will indicate the customer information
56553       ike-version:
56554         type: string
56555         description: can be 1 or 2
56556       ikev1-authentication:
56557         type: string
56558         description: Contains values like md5, sha1, sha256, sha384
56559       ikev1-encryption:
56560         type: string
56561         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
56562       ikev1-dh-group:
56563         type: string
56564         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
56565       ikev1-am-group-id:
56566         type: string
56567         description: Group name defined in VIG for clients using aggressive mode
56568       ikev1-am-password:
56569         type: string
56570         description: pre-shared key for the above group name
56571       ikev1-sa-lifetime:
56572         type: string
56573         description: Lifetime for IKEv1 SA
56574       ipsec-authentication:
56575         type: string
56576         description: md5, sha1, sha256, sha384
56577       ipsec-encryption:
56578         type: string
56579         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
56580       ipsec-sa-lifetime:
56581         type: string
56582         description: Life time for IPSec SA
56583       ipsec-pfs:
56584         type: string
56585         description: enable PFS or not
56586       xauth-userid:
56587         type: string
56588         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
56589       xauth-user-password:
56590         type: string
56591         description: Encrypted using the Juniper $9$ algorithm
56592       dpd-interval:
56593         type: string
56594         description: The time between DPD probe
56595       dpd-frequency:
56596         type: string
56597         description: Maximum number of DPD before claiming the tunnel is down
56598       resource-version:
56599         type: string
56600         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56601       relationship-list:
56602         type: array
56603         items:
56604           $ref: "#/definitions/relationship"
56605       vig-servers:
56606         type: array
56607         items:
56608           $ref: "#/definitions/vig-server"
56609   ipsec-configurations:
56610     properties:
56611       ipsec-configuration:
56612         type: array
56613         items:
56614           $ref: "#/definitions/ipsec-configuration"
56615   key-data:
56616     properties:
56617       key-name:
56618         type: string
56619       key-value:
56620         type: string
56621   l-interface:
56622     description: |
56623       Logical interfaces, e.g., a vnic.
56624       ###### Related Nodes
56625       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56626       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
56627       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56628       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56629       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
56630       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
56631       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
56632       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
56633       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
56634       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56635       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56636       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
56637       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
56638       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56639       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
56640       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
56641       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
56642       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56643       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
56644       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56645     required:
56646     - interface-name
56647     - is-port-mirrored
56648     - in-maint
56649     - is-ip-unnumbered
56650     properties:
56651       interface-name:
56652         type: string
56653         description: Name given to the interface
56654       interface-role:
56655         type: string
56656         description: E.g., CUSTOMER, UPLINK, etc.
56657       v6-wan-link-ip:
56658         type: string
56659         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
56660       selflink:
56661         type: string
56662         description: URL to endpoint where AAI can get more details
56663       interface-id:
56664         type: string
56665         description: ID of interface
56666       macaddr:
56667         type: string
56668         description: MAC address for the interface
56669       network-name:
56670         type: string
56671         description: Name of the network
56672       management-option:
56673         type: string
56674         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
56675       interface-description:
56676         type: string
56677         description: Human friendly text regarding this interface.
56678       is-port-mirrored:
56679         type: boolean
56680       resource-version:
56681         type: string
56682         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56683       in-maint:
56684         type: boolean
56685       prov-status:
56686         type: string
56687         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
56688       is-ip-unnumbered:
56689         type: boolean
56690       allowed-address-pairs:
56691         type: string
56692         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
56693       vlans:
56694         type: array
56695         items:
56696           $ref: "#/definitions/vlan"
56697       sriov-vfs:
56698         type: array
56699         items:
56700           $ref: "#/definitions/sriov-vf"
56701       l-interfaces:
56702         type: array
56703         items:
56704           $ref: "#/definitions/l-interface"
56705       relationship-list:
56706         type: array
56707         items:
56708           $ref: "#/definitions/relationship"
56709       l3-interface-ipv4-address-list:
56710         type: array
56711         items:
56712           $ref: "#/definitions/l3-interface-ipv4-address-list"
56713       l3-interface-ipv6-address-list:
56714         type: array
56715         items:
56716           $ref: "#/definitions/l3-interface-ipv6-address-list"
56717   l-interfaces:
56718     description: |
56719       Collection of logical interfaces.
56720     properties:
56721       l-interface:
56722         type: array
56723         items:
56724           $ref: "#/definitions/l-interface"
56725   l3-interface-ipv4-address-list:
56726     description: |
56727       IPv4 Address Range
56728       ###### Related Nodes
56729       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56730       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56731       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56732       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56733       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56734       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
56735     required:
56736     - l3-interface-ipv4-address
56737     properties:
56738       l3-interface-ipv4-address:
56739         type: string
56740         description: IP address
56741       l3-interface-ipv4-prefix-length:
56742         type: integer
56743         format: int64
56744         description: Prefix length, 32 for single address
56745       vlan-id-inner:
56746         type: integer
56747         format: int64
56748         description: Inner VLAN tag
56749       vlan-id-outer:
56750         type: integer
56751         format: int64
56752         description: Outer VLAN tag
56753       is-floating:
56754         type: boolean
56755         description: Indicator of fixed or floating address
56756       resource-version:
56757         type: string
56758         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56759       neutron-network-id:
56760         type: string
56761         description: Neutron network id of the interface that address belongs to
56762       neutron-subnet-id:
56763         type: string
56764         description: Neutron id of subnet that address belongs to
56765       relationship-list:
56766         type: array
56767         items:
56768           $ref: "#/definitions/relationship"
56769   l3-interface-ipv6-address-list:
56770     description: |
56771       IPv6 Address Range
56772       ###### Related Nodes
56773       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56774       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56775       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56776       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56777       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56778       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
56779     required:
56780     - l3-interface-ipv6-address
56781     properties:
56782       l3-interface-ipv6-address:
56783         type: string
56784         description: IP address
56785       l3-interface-ipv6-prefix-length:
56786         type: integer
56787         format: int64
56788         description: Prefix length, 128 for single address
56789       vlan-id-inner:
56790         type: integer
56791         format: int64
56792         description: Inner VLAN tag
56793       vlan-id-outer:
56794         type: integer
56795         format: int64
56796         description: Outer VLAN tag
56797       is-floating:
56798         type: boolean
56799         description: Indicator of fixed or floating address
56800       resource-version:
56801         type: string
56802         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56803       neutron-network-id:
56804         type: string
56805         description: Neutron network id of the interface that address belongs to
56806       neutron-subnet-id:
56807         type: string
56808         description: Neutron id of subnet that address belongs to
56809       relationship-list:
56810         type: array
56811         items:
56812           $ref: "#/definitions/relationship"
56813   l3-network:
56814     description: |
56815       Generic network definition
56816       ###### Related Nodes
56817       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56818       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
56819       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56820       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56821       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
56822       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
56823       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56824       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56825       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56826       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56827       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56828       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56829       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56830       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56831       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56832       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56833       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
56834       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
56835     required:
56836     - network-id
56837     - network-name
56838     - is-bound-to-vpn
56839     - is-provider-network
56840     - is-shared-network
56841     - is-external-network
56842     properties:
56843       network-id:
56844         type: string
56845         description: Network ID, should be uuid. Unique across A&AI.
56846       network-name:
56847         type: string
56848         description: Name of the network, governed by some naming convention..
56849       network-type:
56850         type: string
56851         description: Type of the network - who defines these values?
56852       network-role:
56853         type: string
56854         description: Role the network plans - who defines these values?
56855       network-technology:
56856         type: string
56857         description: Network technology - who defines these values?
56858       neutron-network-id:
56859         type: string
56860         description: Neutron network id of this Interface
56861       is-bound-to-vpn:
56862         type: boolean
56863       service-id:
56864         type: string
56865         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
56866       network-role-instance:
56867         type: integer
56868         format: int64
56869         description: network role instance
56870       resource-version:
56871         type: string
56872         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56873       orchestration-status:
56874         type: string
56875         description: Orchestration status of this VNF, mastered by MSO
56876       heat-stack-id:
56877         type: string
56878         description: Heat stack id corresponding to this instance, managed by MSO
56879       mso-catalog-key:
56880         type: string
56881         description: Corresponds to the SDN-C catalog id used to configure this VCE
56882       contrail-network-fqdn:
56883         type: string
56884         description: Contrail FQDN for the network
56885       model-invariant-id:
56886         type: string
56887         description: the ASDC model id for this resource or service model.
56888       model-version-id:
56889         type: string
56890         description: the ASDC model version for this resource or service model.
56891       persona-model-version:
56892         type: string
56893         description: the ASDC model version for this resource or service model.
56894       model-customization-id:
56895         type: string
56896         description: captures the id of all the configuration used to customize the resource for the service.
56897       widget-model-id:
56898         type: string
56899         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56900       widget-model-version:
56901         type: string
56902         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56903       physical-network-name:
56904         type: string
56905         description: Name associated with the physical network.
56906       is-provider-network:
56907         type: boolean
56908       is-shared-network:
56909         type: boolean
56910       is-external-network:
56911         type: boolean
56912       selflink:
56913         type: string
56914         description: Path to the controller object.
56915       operational-status:
56916         type: string
56917         description: Indicator for whether the resource is considered operational.
56918       subnets:
56919         type: array
56920         items:
56921           $ref: "#/definitions/subnet"
56922       ctag-assignments:
56923         type: array
56924         items:
56925           $ref: "#/definitions/ctag-assignment"
56926       segmentation-assignments:
56927         type: array
56928         items:
56929           $ref: "#/definitions/segmentation-assignment"
56930       relationship-list:
56931         type: array
56932         items:
56933           $ref: "#/definitions/relationship"
56934         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
56935   l3-networks:
56936     properties:
56937       l3-network:
56938         type: array
56939         items:
56940           $ref: "#/definitions/l3-network"
56941   lag-interface:
56942     description: |
56943       Link aggregate interface
56944       ###### Related Nodes
56945       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56946       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
56947       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56948       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
56949       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56950       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56951       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56952       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
56953       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
56954       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
56955       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
56956     required:
56957     - interface-name
56958     - in-maint
56959     properties:
56960       interface-name:
56961         type: string
56962         description: Name that identifies the link aggregate interface
56963       interface-description:
56964         type: string
56965         description: Human friendly text regarding this interface.
56966       resource-version:
56967         type: string
56968         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56969       speed-value:
56970         type: string
56971         description: Captures the numeric part of the speed
56972       speed-units:
56973         type: string
56974         description: Captures the units corresponding to the speed
56975       interface-id:
56976         type: string
56977         description: ID of interface
56978       interface-role:
56979         type: string
56980         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
56981       prov-status:
56982         type: string
56983         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56984       in-maint:
56985         type: boolean
56986       relationship-list:
56987         type: array
56988         items:
56989           $ref: "#/definitions/relationship"
56990       l-interfaces:
56991         type: array
56992         items:
56993           $ref: "#/definitions/l-interface"
56994   lag-interfaces:
56995     description: |
56996       Collection of link aggregate interfaces.
56997     properties:
56998       lag-interface:
56999         type: array
57000         items:
57001           $ref: "#/definitions/lag-interface"
57002   lag-link:
57003     description: |
57004       LAG links can connect lag-interfaces
57005       ###### Related Nodes
57006       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
57007       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
57008     required:
57009     - link-name
57010     properties:
57011       link-name:
57012         type: string
57013         description: Alphabetical concatenation of lag-interface names
57014       resource-version:
57015         type: string
57016         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57017       relationship-list:
57018         type: array
57019         items:
57020           $ref: "#/definitions/relationship"
57021   lag-links:
57022     description: |
57023       Collection of link aggregation connections
57024     properties:
57025       lag-link:
57026         type: array
57027         items:
57028           $ref: "#/definitions/lag-link"
57029   license:
57030     description: |
57031       Metadata for license group.
57032       ###### Related Nodes
57033       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57034       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57035     required:
57036     - group-uuid
57037     - resource-uuid
57038     properties:
57039       group-uuid:
57040         type: string
57041         description: Unique ID for the license group the resource belongs to, should be uuid.
57042       resource-uuid:
57043         type: string
57044         description: Unique ID of a license resource.
57045       resource-version:
57046         type: string
57047         description: Concurrency value
57048       relationship-list:
57049         type: array
57050         items:
57051           $ref: "#/definitions/relationship"
57052   licenses:
57053     description: |
57054       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
57055     properties:
57056       license:
57057         type: array
57058         items:
57059           $ref: "#/definitions/license"
57060   line-of-business:
57061     description: |
57062       describes a line-of-business
57063       ###### Related Nodes
57064       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
57065     required:
57066     - line-of-business-name
57067     properties:
57068       line-of-business-name:
57069         type: string
57070         description: Name of the line-of-business (product)
57071       resource-version:
57072         type: string
57073         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57074       relationship-list:
57075         type: array
57076         items:
57077           $ref: "#/definitions/relationship"
57078   lines-of-business:
57079     description: |
57080       Collection of lines-of-business
57081     properties:
57082       line-of-business:
57083         type: array
57084         items:
57085           $ref: "#/definitions/line-of-business"
57086   logical-link:
57087     description: |
57088       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
57089       ###### Related Nodes
57090       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
57091       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
57092       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
57093       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
57094       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
57095       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57096       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
57097       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
57098       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57099       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57100       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
57101       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
57102       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57103       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
57104       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
57105       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
57106       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57107       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57108     required:
57109     - link-name
57110     - in-maint
57111     - link-type
57112     properties:
57113       link-name:
57114         type: string
57115         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
57116       in-maint:
57117         type: boolean
57118       link-type:
57119         type: string
57120         description: Type of logical link, e.g., evc
57121       speed-value:
57122         type: string
57123         description: Captures the numeric part of the speed
57124       speed-units:
57125         type: string
57126         description: Captures the units corresponding to the speed
57127       ip-version:
57128         type: string
57129         description: v4, v6, or ds for dual stack
57130       routing-protocol:
57131         type: string
57132         description: For example, static or BGP
57133       resource-version:
57134         type: string
57135         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57136       model-invariant-id:
57137         type: string
57138         description: the ASDC model id for this resource or service model.
57139       model-version-id:
57140         type: string
57141         description: the ASDC model version for this resource or service model.
57142       persona-model-version:
57143         type: string
57144         description: the ASDC model version for this resource or service model.
57145       widget-model-id:
57146         type: string
57147         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57148       widget-model-version:
57149         type: string
57150         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57151       operational-status:
57152         type: string
57153         description: Indication of operational status of the logical link.
57154       prov-status:
57155         type: string
57156         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57157       link-role:
57158         type: string
57159         description: Indication of the network use of the logical link.
57160       link-name2:
57161         type: string
57162         description: Alias or alternate name (CLCI or D1 name).
57163       link-id:
57164         type: string
57165         description: UUID of the logical-link, SDNC generates this.
57166       circuit-id:
57167         type: string
57168         description: Circuit id
57169       purpose:
57170         type: string
57171         description: Reason for this entity, role it is playing
57172       relationship-list:
57173         type: array
57174         items:
57175           $ref: "#/definitions/relationship"
57176   logical-links:
57177     description: |
57178       Collection of logical connections
57179     properties:
57180       logical-link:
57181         type: array
57182         items:
57183           $ref: "#/definitions/logical-link"
57184   metadata:
57185     description: |
57186       Collection of metadatum (key/value pairs)
57187     properties:
57188       metadatum:
57189         type: array
57190         items:
57191           $ref: "#/definitions/metadatum"
57192   metadatum:
57193     description: |
57194       Key/value pairs
57195       ###### Related Nodes
57196       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
57197       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
57198       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
57199       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
57200       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
57201     required:
57202     - metaname
57203     - metaval
57204     properties:
57205       metaname:
57206         type: string
57207       metaval:
57208         type: string
57209       resource-version:
57210         type: string
57211         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57212   model:
57213     description: |
57214       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
57215       ###### Related Nodes
57216       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
57217       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
57218       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
57219       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
57220       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
57221       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
57222       - MODEL is DELETED when these are DELETED MODEL-VER
57223     required:
57224     - model-invariant-id
57225     - model-type
57226     properties:
57227       model-invariant-id:
57228         type: string
57229         description: Unique identifier corresponding to the main definition of a model in ASDC
57230       model-type:
57231         type: string
57232         description: Type of the model, e.g., service, resource, widget, etc.
57233       resource-version:
57234         type: string
57235         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57236       model-vers:
57237         type: array
57238         items:
57239           $ref: "#/definitions/model-ver"
57240       relationship-list:
57241         type: array
57242         items:
57243           $ref: "#/definitions/relationship"
57244   model-and-named-query-search:
57245     description: |
57246       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
57247     properties:
57248       query-parameters:
57249         type: object
57250         $ref: "#/definitions/query-parameters"
57251       instance-filters:
57252         type: object
57253         $ref: "#/definitions/instance-filters"
57254       secondary-filts:
57255         type: object
57256         $ref: "#/definitions/secondary-filts"
57257       top-node-type:
57258         type: string
57259       secondary-filter-cut-point:
57260         type: string
57261   model-constraint:
57262     description: |
57263       This is how we would capture constraints defining allowed sets of elements.
57264       ###### Related Nodes
57265       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57266       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
57267       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
57268     required:
57269     - model-constraint-uuid
57270     - constrained-element-set-uuid-to-replace
57271     properties:
57272       model-constraint-uuid:
57273         type: string
57274       constrained-element-set-uuid-to-replace:
57275         type: string
57276       constrained-element-sets:
57277         type: array
57278         items:
57279           $ref: "#/definitions/constrained-element-set"
57280       resource-version:
57281         type: string
57282         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57283   model-constraints:
57284     properties:
57285       model-constraint:
57286         type: array
57287         items:
57288           $ref: "#/definitions/model-constraint"
57289   model-element:
57290     description: |
57291       Defines how other models combine to make up a higher-level model.
57292       ###### Related Nodes
57293       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
57294       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57295       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
57296       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
57297       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57298       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57299       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57300       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
57301     required:
57302     - model-element-uuid
57303     - new-data-del-flag
57304     - cardinality
57305     properties:
57306       model-element-uuid:
57307         type: string
57308       new-data-del-flag:
57309         type: string
57310         description: Indicates whether this element was created as part of instantiation from this model
57311       cardinality:
57312         type: string
57313         description: How many of this type of element are required/allowed
57314       linkage-points:
57315         type: string
57316       resource-version:
57317         type: string
57318         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57319       model-elements:
57320         type: array
57321         items:
57322           $ref: "#/definitions/model-element"
57323         description: Defines how other models combine to make up a higher-level model
57324       model-constraints:
57325         type: array
57326         items:
57327           $ref: "#/definitions/model-constraint"
57328         description: Describes new constraints on this model element that are not part of that model's definition
57329       relationship-list:
57330         type: array
57331         items:
57332           $ref: "#/definitions/relationship"
57333   model-elements:
57334     properties:
57335       model-element:
57336         type: array
57337         items:
57338           $ref: "#/definitions/model-element"
57339   model-ver:
57340     description: |
57341       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
57342       ###### Related Nodes
57343       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
57344       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
57345       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
57346       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
57347       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
57348       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
57349       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
57350       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
57351       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
57352       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
57353       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
57354       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
57355     required:
57356     - model-version-id
57357     - model-name
57358     - model-version
57359     properties:
57360       model-version-id:
57361         type: string
57362         description: Unique identifier corresponding to one version of a model in ASDC
57363       model-name:
57364         type: string
57365         description: Name of the model, which can change from version to version.
57366       model-version:
57367         type: string
57368         description: Version
57369       distribution-status:
57370         type: string
57371         description: Distribution Status
57372       model-description:
57373         type: string
57374         description: Description
57375       resource-version:
57376         type: string
57377         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57378       model-elements:
57379         type: array
57380         items:
57381           $ref: "#/definitions/model-element"
57382       metadata:
57383         type: array
57384         items:
57385           $ref: "#/definitions/metadatum"
57386       relationship-list:
57387         type: array
57388         items:
57389           $ref: "#/definitions/relationship"
57390   model-vers:
57391     properties:
57392       model-ver:
57393         type: array
57394         items:
57395           $ref: "#/definitions/model-ver"
57396   models:
57397     description: |
57398       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
57399     properties:
57400       model:
57401         type: array
57402         items:
57403           $ref: "#/definitions/model"
57404   multicast-configuration:
57405     description: |
57406       ###### Related Nodes
57407       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57408     required:
57409     - multicast-configuration-id
57410     - multicast-protocol
57411     - rp-type
57412     properties:
57413       multicast-configuration-id:
57414         type: string
57415         description: Unique id of multicast configuration.
57416       multicast-protocol:
57417         type: string
57418         description: protocol of multicast configuration
57419       rp-type:
57420         type: string
57421         description: rp type of multicast configuration
57422       resource-version:
57423         type: string
57424         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57425       relationship-list:
57426         type: array
57427         items:
57428           $ref: "#/definitions/relationship"
57429   multicast-configurations:
57430     description: |
57431       multicast configuration of generic-vnf ip-address
57432     properties:
57433       multicast-configuration:
57434         type: array
57435         items:
57436           $ref: "#/definitions/multicast-configuration"
57437   named-queries:
57438     properties:
57439       named-query:
57440         type: array
57441         items:
57442           $ref: "#/definitions/named-query"
57443   named-query:
57444     description: |
57445       TBD
57446       ###### Related Nodes
57447       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
57448       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
57449       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
57450       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
57451     required:
57452     - named-query-uuid
57453     - named-query-name
57454     - named-query-version
57455     properties:
57456       named-query-uuid:
57457         type: string
57458       named-query-name:
57459         type: string
57460       named-query-version:
57461         type: string
57462       required-input-param:
57463         type: string
57464       description:
57465         type: string
57466       resource-version:
57467         type: string
57468       named-query-elements:
57469         type: array
57470         items:
57471           $ref: "#/definitions/named-query-element"
57472       relationship-list:
57473         type: array
57474         items:
57475           $ref: "#/definitions/relationship"
57476   named-query-element:
57477     description: |
57478       TBD
57479       ###### Related Nodes
57480       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
57481       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
57482       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57483       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57484       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57485       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57486       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
57487     required:
57488     - named-query-element-uuid
57489     properties:
57490       named-query-element-uuid:
57491         type: string
57492       property-collect-list:
57493         type: string
57494       resource-version:
57495         type: string
57496       property-limit-desc:
57497         type: string
57498       do-not-output:
57499         type: string
57500       named-query-elements:
57501         type: array
57502         items:
57503           $ref: "#/definitions/named-query-element"
57504       related-lookups:
57505         type: array
57506         items:
57507           $ref: "#/definitions/related-lookup"
57508       property-constraints:
57509         type: array
57510         items:
57511           $ref: "#/definitions/property-constraint"
57512       relationship-list:
57513         type: array
57514         items:
57515           $ref: "#/definitions/relationship"
57516   named-query-elements:
57517     properties:
57518       named-query-element:
57519         type: array
57520         items:
57521           $ref: "#/definitions/named-query-element"
57522   network:
57523     description: |
57524       Namespace for network inventory resources.
57525     properties:
57526       logical-links:
57527         type: array
57528         items:
57529           $ref: "#/definitions/logical-link"
57530       site-pair-sets:
57531         type: array
57532         items:
57533           $ref: "#/definitions/site-pair-set"
57534       vpn-bindings:
57535         type: array
57536         items:
57537           $ref: "#/definitions/vpn-binding"
57538       vpls-pes:
57539         type: array
57540         items:
57541           $ref: "#/definitions/vpls-pe"
57542       multicast-configurations:
57543         type: array
57544         items:
57545           $ref: "#/definitions/multicast-configuration"
57546       vces:
57547         type: array
57548         items:
57549           $ref: "#/definitions/vce"
57550       vnfcs:
57551         type: array
57552         items:
57553           $ref: "#/definitions/vnfc"
57554       l3-networks:
57555         type: array
57556         items:
57557           $ref: "#/definitions/l3-network"
57558       network-policies:
57559         type: array
57560         items:
57561           $ref: "#/definitions/network-policy"
57562       generic-vnfs:
57563         type: array
57564         items:
57565           $ref: "#/definitions/generic-vnf"
57566       lag-links:
57567         type: array
57568         items:
57569           $ref: "#/definitions/lag-link"
57570       newvces:
57571         type: array
57572         items:
57573           $ref: "#/definitions/newvce"
57574       pnfs:
57575         type: array
57576         items:
57577           $ref: "#/definitions/pnf"
57578       physical-links:
57579         type: array
57580         items:
57581           $ref: "#/definitions/physical-link"
57582       ipsec-configurations:
57583         type: array
57584         items:
57585           $ref: "#/definitions/ipsec-configuration"
57586       route-table-references:
57587         type: array
57588         items:
57589           $ref: "#/definitions/route-table-reference"
57590       instance-groups:
57591         type: array
57592         items:
57593           $ref: "#/definitions/instance-group"
57594       zones:
57595         type: array
57596         items:
57597           $ref: "#/definitions/zone"
57598       configurations:
57599         type: array
57600         items:
57601           $ref: "#/definitions/configuration"
57602       forwarding-paths:
57603         type: array
57604         items:
57605           $ref: "#/definitions/forwarding-path"
57606   network-policies:
57607     properties:
57608       network-policy:
57609         type: array
57610         items:
57611           $ref: "#/definitions/network-policy"
57612   network-policy:
57613     description: |
57614       ###### Related Nodes
57615       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
57616       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
57617     required:
57618     - network-policy-id
57619     properties:
57620       network-policy-id:
57621         type: string
57622         description: UUID representing unique key to this instance
57623       network-policy-fqdn:
57624         type: string
57625         description: Contrail FQDN for the policy
57626       heat-stack-id:
57627         type: string
57628         description: ID for the openStack Heat instance
57629       resource-version:
57630         type: string
57631         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57632       relationship-list:
57633         type: array
57634         items:
57635           $ref: "#/definitions/relationship"
57636   network-profile:
57637     description: |
57638       Network profile populated by SDN-GP for SNMP
57639       ###### Related Nodes
57640       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
57641     required:
57642     - nm-profile-name
57643     properties:
57644       nm-profile-name:
57645         type: string
57646         description: Unique name of network profile.
57647       community-string:
57648         type: string
57649         description: Encrypted SNMP community string
57650       resource-version:
57651         type: string
57652         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57653       relationship-list:
57654         type: array
57655         items:
57656           $ref: "#/definitions/relationship"
57657   network-profiles:
57658     description: |
57659       Collection of network profiles
57660     properties:
57661       network-profile:
57662         type: array
57663         items:
57664           $ref: "#/definitions/network-profile"
57665   newvce:
57666     description: |
57667       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
57668       ###### Related Nodes
57669       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
57670       - NEWVCE is DELETED when these are DELETED L-INTERFACE
57671     required:
57672     - vnf-id2
57673     - vnf-name
57674     - vnf-type
57675     properties:
57676       vnf-id2:
57677         type: string
57678         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
57679       vnf-name:
57680         type: string
57681         description: Name of VNF.
57682       vnf-name2:
57683         type: string
57684         description: Alternate name of VNF.
57685       vnf-type:
57686         type: string
57687         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.
57688       prov-status:
57689         type: string
57690         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57691       operational-status:
57692         type: string
57693         description: Indicator for whether the resource is considered operational
57694       license-key:
57695         type: string
57696         description: OBSOLETE -  do not use
57697       ipv4-oam-address:
57698         type: string
57699         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).
57700       equipment-role:
57701         type: string
57702         description: Client should send valid enumerated value.
57703       resource-version:
57704         type: string
57705         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57706       ipv4-loopback0-address:
57707         type: string
57708         description: v4 Loopback0 address
57709       orchestration-status:
57710         type: string
57711         description: Orchestration status of this VNF, mastered by MSO.
57712       heat-stack-id:
57713         type: string
57714         description: Heat stack id corresponding to this instance, managed by MSO
57715       mso-catalog-key:
57716         type: string
57717         description: Corresponds to the SDN-C catalog id used to configure this VCE
57718       relationship-list:
57719         type: array
57720         items:
57721           $ref: "#/definitions/relationship"
57722       l-interfaces:
57723         type: array
57724         items:
57725           $ref: "#/definitions/l-interface"
57726   newvces:
57727     description: |
57728       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
57729     properties:
57730       newvce:
57731         type: array
57732         items:
57733           $ref: "#/definitions/newvce"
57734   notification-event:
57735     properties:
57736       cambria.partition:
57737         type: string
57738       notification-event-header:
57739         type: object
57740         $ref: "#/definitions/notification-event-header"
57741   notification-event-header:
57742     properties:
57743       id:
57744         type: string
57745       timestamp:
57746         type: string
57747       source-name:
57748         type: string
57749       domain:
57750         type: string
57751       sequence-number:
57752         type: string
57753       severity:
57754         type: string
57755       event-type:
57756         type: string
57757       version:
57758         type: string
57759       action:
57760         type: string
57761       entity-type:
57762         type: string
57763       top-entity-type:
57764         type: string
57765       entity-link:
57766         type: string
57767       status:
57768         type: string
57769   notify:
57770     required:
57771     - event-id
57772     properties:
57773       event-id:
57774         type: string
57775       node-type:
57776         type: string
57777       event-trigger:
57778         type: string
57779       key-data:
57780         type: array
57781         items:
57782           $ref: "#/definitions/key-data"
57783       selflink:
57784         type: string
57785   oam-network:
57786     description: |
57787       OAM network, to be deprecated shortly.  Do not use for new purposes.
57788       ###### Related Nodes
57789       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57790       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
57791       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57792     required:
57793     - network-uuid
57794     - network-name
57795     - cvlan-tag
57796     properties:
57797       network-uuid:
57798         type: string
57799         description: UUID of the network. Unique across a cloud-region
57800       network-name:
57801         type: string
57802         description: Name of the network.
57803       cvlan-tag:
57804         type: integer
57805         format: int64
57806         description: cvlan-id
57807       ipv4-oam-gateway-address:
57808         type: string
57809         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
57810       ipv4-oam-gateway-address-prefix-length:
57811         type: integer
57812         format: int32
57813         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
57814       resource-version:
57815         type: string
57816         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57817       relationship-list:
57818         type: array
57819         items:
57820           $ref: "#/definitions/relationship"
57821   oam-networks:
57822     description: |
57823       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
57824     properties:
57825       oam-network:
57826         type: array
57827         items:
57828           $ref: "#/definitions/oam-network"
57829   operational-environment:
57830     description: |
57831       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
57832       ###### Related Nodes
57833       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
57834       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
57835     required:
57836     - operational-environment-id
57837     - operational-environment-name
57838     - operational-environment-type
57839     - operational-environment-status
57840     - tenant-context
57841     - workload-context
57842     properties:
57843       operational-environment-id:
57844         type: string
57845         description: UUID of an operational environment
57846       operational-environment-name:
57847         type: string
57848         description: Operational Environment name
57849       operational-environment-type:
57850         type: string
57851         description: Operational Environment Type.
57852       operational-environment-status:
57853         type: string
57854         description: Status
57855       tenant-context:
57856         type: string
57857         description: Tenant Context.
57858       workload-context:
57859         type: string
57860         description: Workload Context.
57861       resource-version:
57862         type: string
57863         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57864       relationship-list:
57865         type: array
57866         items:
57867           $ref: "#/definitions/relationship"
57868   operational-environments:
57869     description: |
57870       a logical partition of the cloud which allows to have multiple environments in the production AIC.
57871     properties:
57872       operational-environment:
57873         type: array
57874         items:
57875           $ref: "#/definitions/operational-environment"
57876   overloaded-model:
57877     description: |
57878       Allows for legacy POST of old-style and new-style models
57879     required:
57880     - model-invariant-id
57881     - model-name-version-id
57882     - model-type
57883     - model-name
57884     - model-id
57885     - model-version
57886     properties:
57887       model-invariant-id:
57888         type: string
57889         description: Unique identifier corresponding to the main definition of a model in ASDC
57890       model-name-version-id:
57891         type: string
57892         description: Unique identifier corresponding to one version of a model in ASDC
57893       model-type:
57894         type: string
57895         description: Type of the model, e.g., service, resource, widget, etc.
57896       model-name:
57897         type: string
57898         description: Name of the model, which can change from version to version.
57899       model-id:
57900         type: string
57901         description: Invariant unique ID which does not change from version to version
57902       model-version:
57903         type: string
57904         description: Version
57905       model-description:
57906         type: string
57907         description: Description
57908       resource-version:
57909         type: string
57910         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57911       model-vers:
57912         type: object
57913         $ref: "#/definitions/model-vers"
57914       relationship-list:
57915         type: object
57916         $ref: "#/definitions/relationship-list"
57917   owning-entities:
57918     description: |
57919       Collection of owning-entities
57920     properties:
57921       owning-entity:
57922         type: array
57923         items:
57924           $ref: "#/definitions/owning-entity"
57925   owning-entity:
57926     description: |
57927       describes an owning-entity
57928       ###### Related Nodes
57929       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
57930     required:
57931     - owning-entity-id
57932     - owning-entity-name
57933     properties:
57934       owning-entity-id:
57935         type: string
57936         description: UUID of an owning entity
57937       owning-entity-name:
57938         type: string
57939         description: Owning entity name
57940       resource-version:
57941         type: string
57942         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57943       relationship-list:
57944         type: array
57945         items:
57946           $ref: "#/definitions/relationship"
57947   p-interface:
57948     description: |
57949       Physical interface (e.g., nic)
57950       ###### Related Nodes
57951       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
57952       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
57953       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
57954       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
57955       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57956       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
57957       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
57958       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
57959       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
57960       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
57961       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
57962     required:
57963     - interface-name
57964     - in-maint
57965     properties:
57966       interface-name:
57967         type: string
57968         description: Name that identifies the physical interface
57969       selflink:
57970         type: string
57971         description: URL to endpoint where AAI can get more details.
57972       speed-value:
57973         type: string
57974         description: Captures the numeric part of the speed
57975       speed-units:
57976         type: string
57977         description: Captures the units corresponding to the speed
57978       port-description:
57979         type: string
57980         description: Nature of the services and connectivity on this port.
57981       equipment-identifier:
57982         type: string
57983         description: CLEI or other specification for p-interface hardware.
57984       interface-role:
57985         type: string
57986         description: Role specification for p-interface hardware.
57987       interface-type:
57988         type: string
57989         description: Indicates the physical properties of the interface.
57990       prov-status:
57991         type: string
57992         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57993       mac-addresss:
57994         type: string
57995         description: MAC Address of the p-interface.
57996       resource-version:
57997         type: string
57998         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57999       in-maint:
58000         type: boolean
58001       inv-status:
58002         type: string
58003         description: inventory status
58004       relationship-list:
58005         type: array
58006         items:
58007           $ref: "#/definitions/relationship"
58008       sriov-pfs:
58009         type: array
58010         items:
58011           $ref: "#/definitions/sriov-pf"
58012       l-interfaces:
58013         type: array
58014         items:
58015           $ref: "#/definitions/l-interface"
58016   p-interfaces:
58017     description: |
58018       Collection of physical interfaces.
58019     properties:
58020       p-interface:
58021         type: array
58022         items:
58023           $ref: "#/definitions/p-interface"
58024   physical-link:
58025     description: |
58026       Collection of physical connections, typically between p-interfaces
58027       ###### Related Nodes
58028       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
58029     required:
58030     - link-name
58031     properties:
58032       link-name:
58033         type: string
58034         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
58035       speed-value:
58036         type: string
58037         description: Captures the numeric part of the speed
58038       speed-units:
58039         type: string
58040         description: Captures the units corresponding to the speed
58041       circuit-id:
58042         type: string
58043         description: Circuit it
58044       dual-mode:
58045         type: string
58046         description: Dual access mode (e.g., primary, secondary
58047       management-option:
58048         type: string
58049         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
58050       service-provider-name:
58051         type: string
58052         description: Name of the service Provider on this link.
58053       service-provider-bandwidth-up-value:
58054         type: integer
58055         format: int32
58056         description: Upstream Bandwidth value agreed with the service provider
58057       service-provider-bandwidth-up-units:
58058         type: string
58059         description: Units for the upstream BW value
58060       service-provider-bandwidth-down-value:
58061         type: integer
58062         format: int32
58063         description: Downstream Bandwidth value agreed with the service provider
58064       service-provider-bandwidth-down-units:
58065         type: string
58066         description: Units for downstream BW value
58067       resource-version:
58068         type: string
58069         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58070       relationship-list:
58071         type: array
58072         items:
58073           $ref: "#/definitions/relationship"
58074   physical-links:
58075     description: |
58076       Collection of physical connections, typically between p-interfaces
58077     properties:
58078       physical-link:
58079         type: array
58080         items:
58081           $ref: "#/definitions/physical-link"
58082   platform:
58083     description: |
58084       describes a platform
58085       ###### Related Nodes
58086       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
58087     required:
58088     - platform-name
58089     properties:
58090       platform-name:
58091         type: string
58092         description: Name of the platform
58093       resource-version:
58094         type: string
58095         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58096       relationship-list:
58097         type: array
58098         items:
58099           $ref: "#/definitions/relationship"
58100   platforms:
58101     description: |
58102       Collection of platforms
58103     properties:
58104       platform:
58105         type: array
58106         items:
58107           $ref: "#/definitions/platform"
58108   pnf:
58109     description: |
58110       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.
58111       ###### Related Nodes
58112       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58113       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58114       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58115       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
58116       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
58117       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
58118       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
58119       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
58120       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
58121       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
58122       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
58123     required:
58124     - pnf-name
58125     - in-maint
58126     properties:
58127       pnf-name:
58128         type: string
58129         description: unique name of Physical Network Function.
58130       pnf-name2:
58131         type: string
58132         description: name of Physical Network Function.
58133       selflink:
58134         type: string
58135         description: URL to endpoint where AAI can get more details.
58136       pnf-name2-source:
58137         type: string
58138         description: source of name2
58139       pnf-id:
58140         type: string
58141         description: id of pnf
58142       equip-type:
58143         type: string
58144         description: Equipment type.  Source of truth should define valid values.
58145       equip-vendor:
58146         type: string
58147         description: Equipment vendor.  Source of truth should define valid values.
58148       equip-model:
58149         type: string
58150         description: Equipment model.  Source of truth should define valid values.
58151       management-option:
58152         type: string
58153         description: identifier of managed by ATT or customer
58154       ipaddress-v4-oam:
58155         type: string
58156         description: ipv4-oam-address with new naming convention for IP addresses
58157       sw-version:
58158         type: string
58159         description: sw-version is the version of SW for the hosted application on the PNF.
58160       in-maint:
58161         type: boolean
58162       frame-id:
58163         type: string
58164         description: ID of the physical frame (relay rack) where pnf is installed.
58165       serial-number:
58166         type: string
58167         description: Serial number of the device
58168       ipaddress-v4-loopback-0:
58169         type: string
58170         description: IPV4 Loopback 0 address
58171       ipaddress-v6-loopback-0:
58172         type: string
58173         description: IPV6 Loopback 0 address
58174       ipaddress-v4-aim:
58175         type: string
58176         description: IPV4 AIM address
58177       ipaddress-v6-aim:
58178         type: string
58179         description: IPV6 AIM address
58180       ipaddress-v6-oam:
58181         type: string
58182         description: IPV6 OAM address
58183       inv-status:
58184         type: string
58185         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
58186       resource-version:
58187         type: string
58188         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58189       prov-status:
58190         type: string
58191         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58192       nf-role:
58193         type: string
58194         description: Nf Role is the role performed by this instance in the network.
58195       relationship-list:
58196         type: array
58197         items:
58198           $ref: "#/definitions/relationship"
58199       p-interfaces:
58200         type: array
58201         items:
58202           $ref: "#/definitions/p-interface"
58203       lag-interfaces:
58204         type: array
58205         items:
58206           $ref: "#/definitions/lag-interface"
58207   pnfs:
58208     description: |
58209       Collection of Physical Network Functions.
58210     properties:
58211       pnf:
58212         type: array
58213         items:
58214           $ref: "#/definitions/pnf"
58215   port-group:
58216     description: |
58217       Used to capture the network interfaces of this VCE
58218       ###### Related Nodes
58219       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58220       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
58221       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
58222     required:
58223     - interface-id
58224     - orchestration-status
58225     properties:
58226       interface-id:
58227         type: string
58228         description: Unique ID of the interface
58229       neutron-network-id:
58230         type: string
58231         description: Neutron network id of this Interface
58232       neutron-network-name:
58233         type: string
58234         description: Neutron network name of this Interface
58235       interface-role:
58236         type: string
58237         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
58238       resource-version:
58239         type: string
58240         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58241       port-group-id:
58242         type: string
58243         description: Unique ID for port group in vmware
58244       port-group-name:
58245         type: string
58246         description: Likely to duplicate value of neutron network name
58247       switch-name:
58248         type: string
58249         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
58250       orchestration-status:
58251         type: string
58252         description: Orchestration status of this VNF, mastered by MSO
58253       heat-stack-id:
58254         type: string
58255         description: Heat stack id corresponding to this instance, managed by MSO
58256       mso-catalog-key:
58257         type: string
58258         description: Corresponds to the SDN-C catalog id used to configure this VCE
58259       cvlan-tags:
58260         type: array
58261         items:
58262           $ref: "#/definitions/cvlan-tag-entry"
58263       relationship-list:
58264         type: array
58265         items:
58266           $ref: "#/definitions/relationship"
58267   port-groups:
58268     properties:
58269       port-group:
58270         type: array
58271         items:
58272           $ref: "#/definitions/port-group"
58273   project:
58274     description: |
58275       describes the project
58276       ###### Related Nodes
58277       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
58278     required:
58279     - project-name
58280     properties:
58281       project-name:
58282         type: string
58283         description: Name of the project deploying a service
58284       resource-version:
58285         type: string
58286         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58287       relationship-list:
58288         type: array
58289         items:
58290           $ref: "#/definitions/relationship"
58291   projects:
58292     description: |
58293       Collection of projects
58294     properties:
58295       project:
58296         type: array
58297         items:
58298           $ref: "#/definitions/project"
58299   properties:
58300     description: |
58301       Property holder for query properties or instance properties
58302     properties:
58303       property-name:
58304         type: string
58305       property-value:
58306         type: string
58307   property-constraint:
58308     description: |
58309       TBD
58310       ###### Related Nodes
58311       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
58312     required:
58313     - property-constraint-uuid
58314     - constraint-type
58315     - property-name
58316     - property-value
58317     properties:
58318       property-constraint-uuid:
58319         type: string
58320       constraint-type:
58321         type: string
58322       property-name:
58323         type: string
58324       property-value:
58325         type: string
58326       resource-version:
58327         type: string
58328   property-constraints:
58329     properties:
58330       property-constraint:
58331         type: array
58332         items:
58333           $ref: "#/definitions/property-constraint"
58334   pserver:
58335     description: |
58336       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
58337       ###### Related Nodes
58338       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
58339       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
58340       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
58341       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58342       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58343       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
58344       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
58345       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
58346       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
58347       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
58348       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
58349       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
58350       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
58351     required:
58352     - hostname
58353     - in-maint
58354     properties:
58355       hostname:
58356         type: string
58357         description: Value from executing hostname on the compute node.
58358       ptnii-equip-name:
58359         type: string
58360         description: PTNII name
58361       number-of-cpus:
58362         type: integer
58363         format: int32
58364         description: Number of cpus
58365       disk-in-gigabytes:
58366         type: integer
58367         format: int32
58368         description: Disk size, in GBs
58369       ram-in-megabytes:
58370         type: integer
58371         format: int32
58372         description: RAM size, in MBs
58373       equip-type:
58374         type: string
58375         description: Equipment type.  Source of truth should define valid values.
58376       equip-vendor:
58377         type: string
58378         description: Equipment vendor.  Source of truth should define valid values.
58379       equip-model:
58380         type: string
58381         description: Equipment model.  Source of truth should define valid values.
58382       fqdn:
58383         type: string
58384         description: Fully-qualified domain name
58385       pserver-selflink:
58386         type: string
58387         description: URL to endpoint where AAI can get more details
58388       ipv4-oam-address:
58389         type: string
58390         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
58391       serial-number:
58392         type: string
58393         description: Serial number, may be queried
58394       ipaddress-v4-loopback-0:
58395         type: string
58396         description: IPV4 Loopback 0 address
58397       ipaddress-v6-loopback-0:
58398         type: string
58399         description: IPV6 Loopback 0 address
58400       ipaddress-v4-aim:
58401         type: string
58402         description: IPV4 AIM address
58403       ipaddress-v6-aim:
58404         type: string
58405         description: IPV6 AIM address
58406       ipaddress-v6-oam:
58407         type: string
58408         description: IPV6 OAM address
58409       inv-status:
58410         type: string
58411         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
58412       pserver-id:
58413         type: string
58414         description: ID of Pserver
58415       internet-topology:
58416         type: string
58417         description: internet topology of Pserver
58418       in-maint:
58419         type: boolean
58420       resource-version:
58421         type: string
58422         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58423       pserver-name2:
58424         type: string
58425         description: alternative pserver name
58426       purpose:
58427         type: string
58428         description: purpose of pserver
58429       prov-status:
58430         type: string
58431         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58432       management-option:
58433         type: string
58434         description: Indicates who owns and or manages the device.
58435       host-profile:
58436         type: string
58437         description: The host profile that defines the configuration of the pserver.
58438       relationship-list:
58439         type: array
58440         items:
58441           $ref: "#/definitions/relationship"
58442       p-interfaces:
58443         type: array
58444         items:
58445           $ref: "#/definitions/p-interface"
58446       lag-interfaces:
58447         type: array
58448         items:
58449           $ref: "#/definitions/lag-interface"
58450   pservers:
58451     description: |
58452       Collection of compute hosts.
58453     properties:
58454       pserver:
58455         type: array
58456         items:
58457           $ref: "#/definitions/pserver"
58458   query-parameters:
58459     description: |
58460       QueryParameters for performing a named-query or model query
58461     properties:
58462       named-query:
58463         type: object
58464         $ref: "#/definitions/named-query"
58465       overloaded-model:
58466         type: object
58467         $ref: "#/definitions/overloaded-model"
58468   related-lookup:
58469     description: |
58470       TBD
58471       ###### Related Nodes
58472       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
58473     required:
58474     - related-lookup-uuid
58475     - source-node-type
58476     - source-node-property
58477     - target-node-type
58478     - target-node-property
58479     properties:
58480       related-lookup-uuid:
58481         type: string
58482       source-node-type:
58483         type: string
58484       source-node-property:
58485         type: string
58486       target-node-type:
58487         type: string
58488       target-node-property:
58489         type: string
58490       property-collect-list:
58491         type: string
58492       resource-version:
58493         type: string
58494       relationship-list:
58495         type: array
58496         items:
58497           $ref: "#/definitions/relationship"
58498   related-lookups:
58499     properties:
58500       related-lookup:
58501         type: array
58502         items:
58503           $ref: "#/definitions/related-lookup"
58504   related-to-property:
58505     properties:
58506       property-key:
58507         type: string
58508         description: Key part of a key/value pair
58509       property-value:
58510         type: string
58511         description: Value part of a key/value pair
58512   relationship:
58513     properties:
58514       related-to:
58515         type: string
58516         description: A keyword provided by A&AI to indicate type of node.
58517       relationship-label:
58518         type: string
58519         description: The edge label for this relationship.
58520       related-link:
58521         type: string
58522         description: URL to the object in A&AI.
58523       relationship-data:
58524         type: array
58525         items:
58526           $ref: "#/definitions/relationship-data"
58527   relationship-data:
58528     required:
58529     - relationship-key
58530     - relationship-value
58531     properties:
58532       relationship-key:
58533         type: string
58534         description: A keyword provided by A&AI to indicate an attribute.
58535       relationship-value:
58536         type: string
58537         description: Value of the attribute.
58538   relationship-list:
58539     properties:
58540       relationship:
58541         type: array
58542         items:
58543           $ref: "#/definitions/relationship"
58544   reserved-prop-names:
58545     description: |
58546       Internal map to define some reserved properties of a vertex
58547     properties:
58548       last-mod-source-of-truth:
58549         type: string
58550       aai-node-type:
58551         type: string
58552       aai-created-ts:
58553         type: integer
58554         format: int64
58555       aai-unique-key:
58556         type: string
58557       aai-last-mod-ts:
58558         type: integer
58559         format: int64
58560       source-of-truth:
58561         type: string
58562       aai-uri:
58563         type: string
58564   response-list:
58565     description: |
58566       Response container for the results of a named-query or model query
58567     properties:
58568       inventory-response-items:
58569         type: object
58570         $ref: "#/definitions/inventory-response-items"
58571   result-data:
58572     properties:
58573       resource-type:
58574         type: string
58575         description: The specific type of node in the A&AI graph
58576       resource-link:
58577         type: string
58578         description: The URL to the specific resource
58579   route-table-reference:
58580     description: |
58581       Openstack route table reference.
58582       ###### Related Nodes
58583       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
58584     required:
58585     - route-table-reference-id
58586     - route-table-reference-fqdn
58587     properties:
58588       route-table-reference-id:
58589         type: string
58590         description: Route Table Reference id, UUID assigned to this instance.
58591       route-table-reference-fqdn:
58592         type: string
58593         description: FQDN entry in the route table.
58594       resource-version:
58595         type: string
58596         description: Concurrency value
58597       relationship-list:
58598         type: array
58599         items:
58600           $ref: "#/definitions/relationship"
58601   route-table-references:
58602     description: |
58603       Collection of openstack route table references
58604     properties:
58605       route-table-reference:
58606         type: array
58607         items:
58608           $ref: "#/definitions/route-table-reference"
58609   route-target:
58610     description: |
58611       Route target information
58612       ###### Related Nodes
58613       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
58614     required:
58615     - global-route-target
58616     - route-target-role
58617     properties:
58618       global-route-target:
58619         type: string
58620         description: Number used to identify an RT, globally unique in the network
58621       route-target-role:
58622         type: string
58623         description: Role assigned to this route target
58624       resource-version:
58625         type: string
58626         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58627       relationship-list:
58628         type: array
58629         items:
58630           $ref: "#/definitions/relationship"
58631   route-targets:
58632     description: |
58633       Collection of route target information
58634     properties:
58635       route-target:
58636         type: array
58637         items:
58638           $ref: "#/definitions/route-target"
58639   routing-instance:
58640     description: |
58641       ###### Related Nodes
58642       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
58643       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
58644       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
58645     required:
58646     - routing-instance-id
58647     properties:
58648       routing-instance-id:
58649         type: string
58650         description: Unique id of routing instance
58651       rpm-owner:
58652         type: string
58653         description: rpm owner
58654       resource-version:
58655         type: string
58656         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58657       site-pairs:
58658         type: array
58659         items:
58660           $ref: "#/definitions/site-pair"
58661       relationship-list:
58662         type: array
58663         items:
58664           $ref: "#/definitions/relationship"
58665   routing-instances:
58666     description: |
58667       set of probes related to generic-vnf routing instance
58668     properties:
58669       routing-instance:
58670         type: array
58671         items:
58672           $ref: "#/definitions/routing-instance"
58673   sdn-zone-response:
58674     properties:
58675       oam-networks:
58676         type: object
58677         $ref: "#/definitions/oam-networks"
58678       az-and-dvs-switches:
58679         type: array
58680         items:
58681           $ref: "#/definitions/az-and-dvs-switches"
58682   search:
58683     properties:
58684       edge-tag-query-result:
58685         type: object
58686         $ref: "#/definitions/edge-tag-query-result"
58687       edge-tag-query-request:
58688         type: object
58689         $ref: "#/definitions/edge-tag-query-request"
58690       search-results:
58691         type: object
58692         $ref: "#/definitions/search-results"
58693       sdn-zone-response:
58694         type: object
58695         $ref: "#/definitions/sdn-zone-response"
58696   search-results:
58697     properties:
58698       result-data:
58699         type: array
58700         items:
58701           $ref: "#/definitions/result-data"
58702   secondary-filt:
58703     description: |
58704       SecondaryFilt for performing a named-query or model query
58705   secondary-filter:
58706     properties:
58707       property-name:
58708         type: string
58709       filter-type:
58710         type: string
58711       property-value:
58712         type: string
58713   secondary-filts:
58714     description: |
58715       SecondaryFilts for performing a named-query or model query
58716     properties:
58717       secondary-filt:
58718         type: array
58719         items:
58720           $ref: "#/definitions/secondary-filt"
58721   segmentation-assignment:
58722     description: |
58723       Openstack segmentation assignment.
58724       ###### Related Nodes
58725       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58726     required:
58727     - segmentation-id
58728     properties:
58729       segmentation-id:
58730         type: string
58731         description: Route Table Reference id, UUID assigned to this instance.
58732       resource-version:
58733         type: string
58734         description: Concurrency value
58735       relationship-list:
58736         type: array
58737         items:
58738           $ref: "#/definitions/relationship"
58739   segmentation-assignments:
58740     description: |
58741       Collection of openstack segmentation assignments
58742     properties:
58743       segmentation-assignment:
58744         type: array
58745         items:
58746           $ref: "#/definitions/segmentation-assignment"
58747   service:
58748     description: |
58749       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
58750     required:
58751     - service-id
58752     - service-description
58753     properties:
58754       service-id:
58755         type: string
58756         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
58757       service-description:
58758         type: string
58759         description: Description of the service
58760       service-selflink:
58761         type: string
58762         description: URL to endpoint where AAI can get more details
58763       resource-version:
58764         type: string
58765         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58766       service-version:
58767         type: string
58768         description: service version
58769       relationship-list:
58770         type: array
58771         items:
58772           $ref: "#/definitions/relationship"
58773   service-capabilities:
58774     description: |
58775       Collection of service capabilities.
58776     properties:
58777       service-capability:
58778         type: array
58779         items:
58780           $ref: "#/definitions/service-capability"
58781   service-capability:
58782     description: |
58783       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
58784       ###### Related Nodes
58785       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
58786       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
58787       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
58788     required:
58789     - service-type
58790     - vnf-type
58791     properties:
58792       service-type:
58793         type: string
58794         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
58795       vnf-type:
58796         type: string
58797         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.
58798       resource-version:
58799         type: string
58800         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58801       relationship-list:
58802         type: array
58803         items:
58804           $ref: "#/definitions/relationship"
58805   service-design-and-creation:
58806     description: |
58807       Namespace for objects managed by ASDC
58808     properties:
58809       vnf-images:
58810         type: array
58811         items:
58812           $ref: "#/definitions/vnf-image"
58813       services:
58814         type: array
58815         items:
58816           $ref: "#/definitions/service"
58817       service-capabilities:
58818         type: array
58819         items:
58820           $ref: "#/definitions/service-capability"
58821       models:
58822         type: array
58823         items:
58824           $ref: "#/definitions/model"
58825       named-queries:
58826         type: array
58827         items:
58828           $ref: "#/definitions/named-query"
58829   service-instance:
58830     description: |
58831       Instance of a service
58832       ###### Related Nodes
58833       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
58834       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
58835       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
58836       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
58837       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58838       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
58839       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
58840       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
58841       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58842       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58843       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
58844       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
58845       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
58846       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58847       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
58848       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
58849       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
58850       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
58851       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
58852       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
58853       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
58854       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
58855       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
58856       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
58857     required:
58858     - service-instance-id
58859     - service-type
58860     - service-role
58861     - created-at
58862     - updated-at
58863     - description
58864     properties:
58865       service-instance-id:
58866         type: string
58867         description: Uniquely identifies this instance of a service
58868       service-instance-name:
58869         type: string
58870         description: This field will store a name assigned to the service-instance.
58871       service-type:
58872         type: string
58873         description: String capturing type of service.
58874       service-role:
58875         type: string
58876         description: String capturing the service role.
58877       environment-context:
58878         type: string
58879         description: This field will store the environment context assigned to the service-instance.
58880       workload-context:
58881         type: string
58882         description: This field will store the workload context assigned to the service-instance.
58883       created-at:
58884         type: string
58885         description: create time of Network Service.
58886       updated-at:
58887         type: string
58888         description: last update of Network Service.
58889       description:
58890         type: string
58891         description: short description for service-instance.
58892       model-invariant-id:
58893         type: string
58894         description: the ASDC model id for this resource or service model.
58895       model-version-id:
58896         type: string
58897         description: the ASDC model version for this resource or service model.
58898       persona-model-version:
58899         type: string
58900         description: the ASDC model version for this resource or service model.
58901       widget-model-id:
58902         type: string
58903         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58904       widget-model-version:
58905         type: string
58906         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58907       bandwidth-total:
58908         type: string
58909         description: Indicates the total bandwidth to be used for this service.
58910       bandwidth-up-wan1:
58911         type: string
58912         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
58913       bandwidth-down-wan1:
58914         type: string
58915         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
58916       bandwidth-up-wan2:
58917         type: string
58918         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
58919       bandwidth-down-wan2:
58920         type: string
58921         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
58922       vhn-portal-url:
58923         type: string
58924         description: URL customers will use to access the vHN Portal.
58925       service-instance-location-id:
58926         type: string
58927         description: An identifier that customers assign to the location where this service is being used.
58928       resource-version:
58929         type: string
58930         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58931       selflink:
58932         type: string
58933         description: Path to the controller object.
58934       orchestration-status:
58935         type: string
58936         description: Orchestration status of this service.
58937       relationship-list:
58938         type: array
58939         items:
58940           $ref: "#/definitions/relationship"
58941       metadata:
58942         type: array
58943         items:
58944           $ref: "#/definitions/metadatum"
58945       allotted-resources:
58946         type: array
58947         items:
58948           $ref: "#/definitions/allotted-resource"
58949   service-instances:
58950     description: |
58951       Collection of service instances
58952     properties:
58953       service-instance:
58954         type: array
58955         items:
58956           $ref: "#/definitions/service-instance"
58957   service-subscription:
58958     description: |
58959       Object that group service instances.
58960       ###### Related Nodes
58961       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
58962       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
58963       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
58964       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
58965     required:
58966     - service-type
58967     properties:
58968       service-type:
58969         type: string
58970         description: Value defined by orchestration to identify this service across ECOMP.
58971       temp-ub-sub-account-id:
58972         type: string
58973         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
58974       resource-version:
58975         type: string
58976         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58977       service-instances:
58978         type: array
58979         items:
58980           $ref: "#/definitions/service-instance"
58981       relationship-list:
58982         type: array
58983         items:
58984           $ref: "#/definitions/relationship"
58985   service-subscriptions:
58986     description: |
58987       Collection of objects that group service instances.
58988     properties:
58989       service-subscription:
58990         type: array
58991         items:
58992           $ref: "#/definitions/service-subscription"
58993   services:
58994     description: |
58995       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
58996     properties:
58997       service:
58998         type: array
58999         items:
59000           $ref: "#/definitions/service"
59001   site-pair:
59002     description: |
59003       ###### Related Nodes
59004       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
59005       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
59006       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
59007     required:
59008     - site-pair-id
59009     properties:
59010       site-pair-id:
59011         type: string
59012         description: unique identifier of probe
59013       source-ip:
59014         type: string
59015         description: Prefix address
59016       destination-ip:
59017         type: string
59018         description: Prefix address
59019       ip-version:
59020         type: string
59021         description: ip version, v4, v6
59022       destination-hostname:
59023         type: string
59024         description: Hostname of the destination equipment to which SLAs are measured against.
59025       destination-equip-type:
59026         type: string
59027         description: The type of destinatination equipment. Could be Router, UCPE, etc.
59028       resource-version:
59029         type: string
59030         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59031       classes-of-service:
59032         type: array
59033         items:
59034           $ref: "#/definitions/class-of-service"
59035       relationship-list:
59036         type: array
59037         items:
59038           $ref: "#/definitions/relationship"
59039   site-pair-set:
59040     description: |
59041       Set of instances for probes used to measure service level agreements
59042       ###### Related Nodes
59043       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59044       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
59045       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
59046     required:
59047     - site-pair-set-id
59048     properties:
59049       site-pair-set-id:
59050         type: string
59051         description: Unique id of site pair set.
59052       resource-version:
59053         type: string
59054         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59055       routing-instances:
59056         type: array
59057         items:
59058           $ref: "#/definitions/routing-instance"
59059       relationship-list:
59060         type: array
59061         items:
59062           $ref: "#/definitions/relationship"
59063   site-pair-sets:
59064     description: |
59065       Collection of sets of instances for probes related to generic-vnf
59066     properties:
59067       site-pair-set:
59068         type: array
59069         items:
59070           $ref: "#/definitions/site-pair-set"
59071   site-pairs:
59072     description: |
59073       probe within a set
59074     properties:
59075       site-pair:
59076         type: array
59077         items:
59078           $ref: "#/definitions/site-pair"
59079   snapshot:
59080     description: |
59081       Openstack snapshot
59082       ###### Related Nodes
59083       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59084       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
59085     required:
59086     - snapshot-id
59087     properties:
59088       snapshot-id:
59089         type: string
59090         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
59091       snapshot-name:
59092         type: string
59093         description: Snapshot name
59094       snapshot-architecture:
59095         type: string
59096         description: Operating system architecture
59097       snapshot-os-distro:
59098         type: string
59099         description: The common name of the operating system distribution in lowercase
59100       snapshot-os-version:
59101         type: string
59102         description: The operating system version as specified by the distributor.
59103       application:
59104         type: string
59105         description: The application that the image instantiates.
59106       application-vendor:
59107         type: string
59108         description: The vendor of the application.
59109       application-version:
59110         type: string
59111         description: The version of the application.
59112       snapshot-selflink:
59113         type: string
59114         description: URL to endpoint where AAI can get more details
59115       prev-snapshot-id:
59116         type: string
59117         description: This field contains the UUID of the previous snapshot (if any).
59118       resource-version:
59119         type: string
59120         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59121       relationship-list:
59122         type: array
59123         items:
59124           $ref: "#/definitions/relationship"
59125   snapshots:
59126     description: |
59127       Collection of openstack snapshots
59128     properties:
59129       snapshot:
59130         type: array
59131         items:
59132           $ref: "#/definitions/snapshot"
59133   sriov-pf:
59134     description: |
59135       SR-IOV Physical Function
59136       ###### Related Nodes
59137       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
59138       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
59139     required:
59140     - pf-pci-id
59141     properties:
59142       pf-pci-id:
59143         type: string
59144         description: Identifier for the sriov-pf
59145       resource-version:
59146         type: string
59147         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59148       relationship-list:
59149         type: array
59150         items:
59151           $ref: "#/definitions/relationship"
59152   sriov-pfs:
59153     description: |
59154       Collection of SR-IOV Physical Functions.
59155     properties:
59156       sriov-pf:
59157         type: array
59158         items:
59159           $ref: "#/definitions/sriov-pf"
59160   sriov-vf:
59161     description: |
59162       SR-IOV Virtual Function (not to be confused with virtual network function)
59163       ###### Related Nodes
59164       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
59165       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
59166     required:
59167     - pci-id
59168     properties:
59169       pci-id:
59170         type: string
59171         description: PCI ID used to identify the sriov-vf
59172       vf-vlan-filter:
59173         type: string
59174         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
59175       vf-mac-filter:
59176         type: string
59177         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
59178       vf-vlan-strip:
59179         type: boolean
59180         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
59181       vf-vlan-anti-spoof-check:
59182         type: boolean
59183         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.
59184       vf-mac-anti-spoof-check:
59185         type: boolean
59186         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.
59187       vf-mirrors:
59188         type: string
59189         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
59190       vf-broadcast-allow:
59191         type: boolean
59192         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
59193       vf-unknown-multicast-allow:
59194         type: boolean
59195         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
59196       vf-unknown-unicast-allow:
59197         type: boolean
59198         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
59199       vf-insert-stag:
59200         type: boolean
59201         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
59202       vf-link-status:
59203         type: string
59204         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
59205       resource-version:
59206         type: string
59207         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59208       neutron-network-id:
59209         type: string
59210         description: Neutron network id of the interface
59211       relationship-list:
59212         type: array
59213         items:
59214           $ref: "#/definitions/relationship"
59215   sriov-vfs:
59216     description: |
59217       Collection of SR-IOV Virtual Functions.
59218     properties:
59219       sriov-vf:
59220         type: array
59221         items:
59222           $ref: "#/definitions/sriov-vf"
59223   start-node-filter:
59224     properties:
59225       property-name:
59226         type: string
59227       property-value:
59228         type: string
59229   subnet:
59230     description: |
59231       ###### Related Nodes
59232       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59233       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59234       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59235       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
59236       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
59237       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
59238       - 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
59239       - SUBNET is DELETED when these are DELETED HOST-ROUTE
59240     required:
59241     - subnet-id
59242     - dhcp-enabled
59243     properties:
59244       subnet-id:
59245         type: string
59246         description: Subnet ID, should be UUID.
59247       subnet-name:
59248         type: string
59249         description: Name associated with the subnet.
59250       neutron-subnet-id:
59251         type: string
59252         description: Neutron id of this subnet
59253       gateway-address:
59254         type: string
59255         description: gateway ip address
59256       network-start-address:
59257         type: string
59258         description: network start address
59259       cidr-mask:
59260         type: string
59261         description: cidr mask
59262       ip-version:
59263         type: string
59264         description: ip version
59265       orchestration-status:
59266         type: string
59267         description: Orchestration status of this VNF, mastered by MSO
59268       dhcp-enabled:
59269         type: boolean
59270       dhcp-start:
59271         type: string
59272         description: the start address reserved for use by dhcp
59273       dhcp-end:
59274         type: string
59275         description: the last address reserved for use by dhcp
59276       subnet-role:
59277         type: string
59278         description: role of the subnet, referenced when assigning IPs
59279       ip-assignment-direction:
59280         type: string
59281         description: ip address assignment direction of the subnet
59282       resource-version:
59283         type: string
59284         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59285       subnet-sequence:
59286         type: integer
59287         format: int32
59288         description: sequence of the subnet
59289       host-routes:
59290         type: array
59291         items:
59292           $ref: "#/definitions/host-route"
59293       relationship-list:
59294         type: array
59295         items:
59296           $ref: "#/definitions/relationship"
59297   subnets:
59298     properties:
59299       subnet:
59300         type: array
59301         items:
59302           $ref: "#/definitions/subnet"
59303   tagged-inventory-item-list:
59304     properties:
59305       inventory-item:
59306         type: array
59307         items:
59308           $ref: "#/definitions/inventory-item"
59309   tenant:
59310     description: |
59311       Openstack tenant
59312       ###### Related Nodes
59313       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59314       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
59315       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59316       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59317       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
59318       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
59319       - TENANT cannot be deleted if linked to VSERVER
59320     required:
59321     - tenant-id
59322     - tenant-name
59323     properties:
59324       tenant-id:
59325         type: string
59326         description: Unique id relative to the cloud-region.
59327       tenant-name:
59328         type: string
59329         description: Readable name of tenant
59330       tenant-context:
59331         type: string
59332         description: This field will store the tenant context.
59333       resource-version:
59334         type: string
59335         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59336       vservers:
59337         type: array
59338         items:
59339           $ref: "#/definitions/vserver"
59340       relationship-list:
59341         type: array
59342         items:
59343           $ref: "#/definitions/relationship"
59344   tenants:
59345     description: |
59346       Collection of openstack tenants.
59347     properties:
59348       tenant:
59349         type: array
59350         items:
59351           $ref: "#/definitions/tenant"
59352   tunnel-xconnect:
59353     description: |
59354       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
59355       ###### Related Nodes
59356       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
59357     required:
59358     - id
59359     properties:
59360       id:
59361         type: string
59362         description: Allotted Resource id UUID assigned to this instance.
59363       bandwidth-up-wan1:
59364         type: string
59365         description: The WAN uplink bandwidth for WAN1
59366       bandwidth-down-wan1:
59367         type: string
59368         description: The WAN downlink bandwidth for WAN1
59369       bandwidth-up-wan2:
59370         type: string
59371         description: The WAN uplink bandwidth for WAN2
59372       bandwidth-down-wan2:
59373         type: string
59374         description: The WAN downlink bandwidth for WAN2
59375       resource-version:
59376         type: string
59377         description: Concurrency value
59378       relationship-list:
59379         type: array
59380         items:
59381           $ref: "#/definitions/relationship"
59382   tunnel-xconnects:
59383     description: |
59384       This object is used to store the specific tunnel cross connect aspects of an allotted resource
59385     properties:
59386       tunnel-xconnect:
59387         type: array
59388         items:
59389           $ref: "#/definitions/tunnel-xconnect"
59390   update:
59391     description: |
59392       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
59393     required:
59394     - update-node-type
59395     properties:
59396       update-node-type:
59397         type: string
59398       update-node-key:
59399         type: array
59400         items:
59401           $ref: "#/definitions/update-node-key"
59402       update-node-uri:
59403         type: string
59404       action:
59405         type: array
59406         items:
59407           $ref: "#/definitions/action"
59408   update-node-key:
59409     properties:
59410       key-name:
59411         type: string
59412       key-value:
59413         type: string
59414   vce:
59415     description: |
59416       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
59417       ###### Related Nodes
59418       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
59419       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
59420       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
59421       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59422       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59423       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59424       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
59425       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
59426     required:
59427     - vnf-id
59428     - vnf-name
59429     - vnf-type
59430     properties:
59431       vnf-id:
59432         type: string
59433         description: Unique id of VNF.  This is unique across the graph.
59434       vnf-name:
59435         type: string
59436         description: Name of VNF.
59437       vnf-name2:
59438         type: string
59439         description: Alternate name of VNF.
59440       vnf-type:
59441         type: string
59442         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.
59443       service-id:
59444         type: string
59445         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
59446       regional-resource-zone:
59447         type: string
59448         description: Regional way of organizing pservers, source of truth should define values
59449       prov-status:
59450         type: string
59451         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59452       operational-status:
59453         type: string
59454         description: Indicator for whether the resource is considered operational
59455       license-key:
59456         type: string
59457         description: OBSOLETE -  do not use
59458       equipment-role:
59459         type: string
59460         description: Network role being played by this VNF
59461       orchestration-status:
59462         type: string
59463         description: Orchestration status of this VNF, mastered by MSO
59464       heat-stack-id:
59465         type: string
59466         description: Heat stack id corresponding to this instance, managed by MSO
59467       mso-catalog-key:
59468         type: string
59469         description: Corresponds to the SDN-C catalog id used to configure this VCE
59470       vpe-id:
59471         type: string
59472         description: Unique ID of VPE connected to this VCE.
59473       v6-vce-wan-address:
59474         type: string
59475         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
59476       ipv4-oam-address:
59477         type: string
59478         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
59479       resource-version:
59480         type: string
59481         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59482       ipv4-loopback0-address:
59483         type: string
59484         description: Loopback0 address
59485       entitlement-resource-uuid:
59486         type: string
59487         description: OBSOLETE -  see child relationships
59488       port-groups:
59489         type: array
59490         items:
59491           $ref: "#/definitions/port-group"
59492       licenses:
59493         type: array
59494         items:
59495           $ref: "#/definitions/license"
59496       entitlements:
59497         type: array
59498         items:
59499           $ref: "#/definitions/entitlement"
59500       relationship-list:
59501         type: array
59502         items:
59503           $ref: "#/definitions/relationship"
59504   vces:
59505     description: |
59506       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
59507     properties:
59508       vce:
59509         type: array
59510         items:
59511           $ref: "#/definitions/vce"
59512   vf-module:
59513     description: |
59514       a deployment unit of VNFCs
59515       ###### Related Nodes
59516       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59517       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
59518       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
59519       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
59520       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
59521       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
59522       - VF-MODULE cannot be deleted if linked to VNFC
59523     required:
59524     - vf-module-id
59525     - is-base-vf-module
59526     properties:
59527       vf-module-id:
59528         type: string
59529         description: Unique ID of vf-module.
59530       vf-module-name:
59531         type: string
59532         description: Name of vf-module
59533       heat-stack-id:
59534         type: string
59535         description: Heat stack id corresponding to this instance.
59536       orchestration-status:
59537         type: string
59538         description: orchestration status of this vf-module, mastered by MSO
59539       is-base-vf-module:
59540         type: boolean
59541       resource-version:
59542         type: string
59543         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59544       model-invariant-id:
59545         type: string
59546         description: the ASDC model id for this resource or service model.
59547       model-version-id:
59548         type: string
59549         description: the ASDC model version for this resource or service model.
59550       persona-model-version:
59551         type: string
59552         description: the ASDC model version for this resource or service model.
59553       model-customization-id:
59554         type: string
59555         description: captures the id of all the configuration used to customize the resource for the service.
59556       widget-model-id:
59557         type: string
59558         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59559       widget-model-version:
59560         type: string
59561         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59562       contrail-service-instance-fqdn:
59563         type: string
59564         description: the Contrail unique ID for a service-instance
59565       module-index:
59566         type: integer
59567         format: int32
59568         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
59569       selflink:
59570         type: string
59571         description: Path to the controller object.
59572       relationship-list:
59573         type: array
59574         items:
59575           $ref: "#/definitions/relationship"
59576   vf-modules:
59577     description: |
59578       Collection of vf-modules, a deployment unit of VNFCs
59579     properties:
59580       vf-module:
59581         type: array
59582         items:
59583           $ref: "#/definitions/vf-module"
59584   vig-server:
59585     description: |
59586       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
59587       ###### Related Nodes
59588       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
59589     required:
59590     - vig-address-type
59591     properties:
59592       vig-address-type:
59593         type: string
59594         description: indicates whether the VIG is for AVPN or INTERNET
59595       ipaddress-v4-vig:
59596         type: string
59597         description: v4 IP of the vig server
59598       ipaddress-v6-vig:
59599         type: string
59600         description: v6 IP of the vig server
59601       resource-version:
59602         type: string
59603         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59604       relationship-list:
59605         type: array
59606         items:
59607           $ref: "#/definitions/relationship"
59608   vig-servers:
59609     properties:
59610       vig-server:
59611         type: array
59612         items:
59613           $ref: "#/definitions/vig-server"
59614   vip-ipv4-address-list:
59615     description: |
59616       IPv4 Address Range
59617       ###### Related Nodes
59618       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59619       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59620       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
59621       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
59622     required:
59623     - vip-ipv4-address
59624     properties:
59625       vip-ipv4-address:
59626         type: string
59627         description: IP address
59628       vip-ipv4-prefix-length:
59629         type: integer
59630         format: int64
59631         description: Prefix length, 32 for single address
59632       vlan-id-inner:
59633         type: integer
59634         format: int64
59635         description: Inner VLAN tag
59636       vlan-id-outer:
59637         type: integer
59638         format: int64
59639         description: Outer VLAN tag
59640       is-floating:
59641         type: boolean
59642         description: Indicator of fixed or floating address
59643       resource-version:
59644         type: string
59645         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59646       neutron-network-id:
59647         type: string
59648         description: Neutron network id of the interface that address belongs to
59649       neutron-subnet-id:
59650         type: string
59651         description: Neutron id of subnet that address belongs to
59652       relationship-list:
59653         type: array
59654         items:
59655           $ref: "#/definitions/relationship"
59656   vip-ipv6-address-list:
59657     description: |
59658       IPv6 Address Range
59659       ###### Related Nodes
59660       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59661       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59662       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
59663       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
59664     required:
59665     - vip-ipv6-address
59666     properties:
59667       vip-ipv6-address:
59668         type: string
59669         description: IP address
59670       vip-ipv6-prefix-length:
59671         type: integer
59672         format: int64
59673         description: Prefix length, 128 for single address
59674       vlan-id-inner:
59675         type: integer
59676         format: int64
59677         description: Inner VLAN tag
59678       vlan-id-outer:
59679         type: integer
59680         format: int64
59681         description: Outer VLAN tag
59682       is-floating:
59683         type: boolean
59684         description: Indicator of fixed or floating address
59685       resource-version:
59686         type: string
59687         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59688       neutron-network-id:
59689         type: string
59690         description: Neutron network id of the interface that address belongs to
59691       neutron-subnet-id:
59692         type: string
59693         description: Neutron id of subnet that address belongs to
59694       relationship-list:
59695         type: array
59696         items:
59697           $ref: "#/definitions/relationship"
59698   virtual-data-center:
59699     description: |
59700       Virtual organization of cloud infrastructure elements in a data center context
59701       ###### Related Nodes
59702       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59703       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59704       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59705     required:
59706     - vdc-id
59707     - vdc-name
59708     properties:
59709       vdc-id:
59710         type: string
59711         description: Unique ID of the vdc
59712       vdc-name:
59713         type: string
59714         description: Name of the virtual data center
59715       resource-version:
59716         type: string
59717         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59718       relationship-list:
59719         type: array
59720         items:
59721           $ref: "#/definitions/relationship"
59722   virtual-data-centers:
59723     description: |
59724       Virtual organization of cloud infrastructure elements in a data center context
59725     properties:
59726       virtual-data-center:
59727         type: array
59728         items:
59729           $ref: "#/definitions/virtual-data-center"
59730   vlan:
59731     description: |
59732       Definition of vlan
59733       ###### Related Nodes
59734       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
59735       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59736       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
59737       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
59738       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
59739       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59740       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59741       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
59742       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
59743     required:
59744     - vlan-interface
59745     - in-maint
59746     - is-ip-unnumbered
59747     properties:
59748       vlan-interface:
59749         type: string
59750         description: String that identifies the interface
59751       vlan-id-inner:
59752         type: integer
59753         format: int64
59754         description: Inner VLAN tag
59755       vlan-id-outer:
59756         type: integer
59757         format: int64
59758         description: Outer VLAN tag
59759       resource-version:
59760         type: string
59761         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59762       speed-value:
59763         type: string
59764         description: Captures the numeric part of the speed
59765       speed-units:
59766         type: string
59767         description: Captures the units corresponding to the speed
59768       vlan-description:
59769         type: string
59770         description: Used to describe (the service associated with) the vlan
59771       backdoor-connection:
59772         type: string
59773         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
59774       vpn-key:
59775         type: string
59776         description: This indicates the customers VPN ID associated with this vlan
59777       orchestration-status:
59778         type: string
59779         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
59780       in-maint:
59781         type: boolean
59782       prov-status:
59783         type: string
59784         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
59785       is-ip-unnumbered:
59786         type: boolean
59787       relationship-list:
59788         type: array
59789         items:
59790           $ref: "#/definitions/relationship"
59791       l3-interface-ipv4-address-list:
59792         type: array
59793         items:
59794           $ref: "#/definitions/l3-interface-ipv4-address-list"
59795       l3-interface-ipv6-address-list:
59796         type: array
59797         items:
59798           $ref: "#/definitions/l3-interface-ipv6-address-list"
59799   vlans:
59800     properties:
59801       vlan:
59802         type: array
59803         items:
59804           $ref: "#/definitions/vlan"
59805   vnf:
59806     description: |
59807       Abstract vnf class
59808     required:
59809     - vnf-id
59810     properties:
59811       vnf-id:
59812         type: string
59813         description: Unique id of VNF.  This is unique across the graph.
59814   vnf-image:
59815     description: |
59816       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
59817       ###### Related Nodes
59818       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
59819       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
59820     required:
59821     - vnf-image-uuid
59822     - application
59823     - application-vendor
59824     properties:
59825       vnf-image-uuid:
59826         type: string
59827         description: Unique ID of this asset
59828       application:
59829         type: string
59830         description: The application that the image instantiates.
59831       application-vendor:
59832         type: string
59833         description: The vendor of the application.
59834       application-version:
59835         type: string
59836         description: The version of the application.
59837       selflink:
59838         type: string
59839         description: URL to endpoint where AAI can get more details
59840       resource-version:
59841         type: string
59842         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59843       relationship-list:
59844         type: array
59845         items:
59846           $ref: "#/definitions/relationship"
59847   vnf-images:
59848     description: |
59849       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
59850     properties:
59851       vnf-image:
59852         type: array
59853         items:
59854           $ref: "#/definitions/vnf-image"
59855   vnfc:
59856     description: |
59857       ###### Related Nodes
59858       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59859       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59860       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
59861       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
59862       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
59863       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
59864       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59865       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59866       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
59867     required:
59868     - vnfc-name
59869     - nfc-naming-code
59870     - nfc-function
59871     - in-maint
59872     - is-closed-loop-disabled
59873     properties:
59874       vnfc-name:
59875         type: string
59876         description: Unique ID of vnfc.
59877       nfc-naming-code:
59878         type: string
59879         description: Short code that is used in naming instances of the item being modeled
59880       nfc-function:
59881         type: string
59882         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
59883       prov-status:
59884         type: string
59885         description: prov status of this vnfc
59886       orchestration-status:
59887         type: string
59888         description: Orchestration status of this VNF, mastered by APP-C
59889       ipaddress-v4-oam-vip:
59890         type: string
59891         description: Oam V4 vip address of this vnfc
59892       in-maint:
59893         type: boolean
59894       is-closed-loop-disabled:
59895         type: boolean
59896       group-notation:
59897         type: string
59898         description: Group notation of VNFC
59899       model-invariant-id:
59900         type: string
59901         description: the ASDC model id for this resource or service model.
59902       model-version-id:
59903         type: string
59904         description: the ASDC model version for this resource or service model.
59905       resource-version:
59906         type: string
59907         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59908       relationship-list:
59909         type: array
59910         items:
59911           $ref: "#/definitions/relationship"
59912       l3-interface-ipv4-address-list:
59913         type: array
59914         items:
59915           $ref: "#/definitions/l3-interface-ipv4-address-list"
59916       l3-interface-ipv6-address-list:
59917         type: array
59918         items:
59919           $ref: "#/definitions/l3-interface-ipv6-address-list"
59920   vnfcs:
59921     description: |
59922       virtual network components associated with a vserver from application controller.
59923     properties:
59924       vnfc:
59925         type: array
59926         items:
59927           $ref: "#/definitions/vnfc"
59928   volume:
59929     description: |
59930       Ephemeral Block storage volume.
59931       ###### Related Nodes
59932       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
59933     required:
59934     - volume-id
59935     - volume-selflink
59936     properties:
59937       volume-id:
59938         type: string
59939         description: Unique ID of block storage volume relative to the vserver.
59940       volume-selflink:
59941         type: string
59942         description: URL to endpoint where AAI can get more details
59943       resource-version:
59944         type: string
59945         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59946       relationship-list:
59947         type: array
59948         items:
59949           $ref: "#/definitions/relationship"
59950   volume-group:
59951     description: |
59952       Persistent block-level storage.
59953       ###### Related Nodes
59954       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59955       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59956       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59957       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
59958       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59959     required:
59960     - volume-group-id
59961     - volume-group-name
59962     - vnf-type
59963     properties:
59964       volume-group-id:
59965         type: string
59966         description: Unique ID of volume-group.
59967       volume-group-name:
59968         type: string
59969         description: Name of the volume group.
59970       heat-stack-id:
59971         type: string
59972         description: Heat stack id corresponding to this volume-group
59973       vnf-type:
59974         type: string
59975         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.
59976       orchestration-status:
59977         type: string
59978         description: Orchestration status of this volume-group
59979       model-customization-id:
59980         type: string
59981         description: captures the id of all the configuration used to customize the resource for the service.
59982       vf-module-model-customization-id:
59983         type: string
59984         description: helps relate the volume group to the vf-module whose components will require the volume group
59985       resource-version:
59986         type: string
59987         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59988       relationship-list:
59989         type: array
59990         items:
59991           $ref: "#/definitions/relationship"
59992   volume-groups:
59993     description: |
59994       Collection of persistent block-level storage.
59995     properties:
59996       volume-group:
59997         type: array
59998         items:
59999           $ref: "#/definitions/volume-group"
60000   volumes:
60001     description: |
60002       Collection of ephemeral Block storage volumes.
60003     properties:
60004       volume:
60005         type: array
60006         items:
60007           $ref: "#/definitions/volume"
60008   vpls-pe:
60009     description: |
60010       VPLS Provider Edge routers.
60011       ###### Related Nodes
60012       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60013       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
60014       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60015       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60016       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60017     required:
60018     - equipment-name
60019     properties:
60020       equipment-name:
60021         type: string
60022       prov-status:
60023         type: string
60024         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60025       ipv4-oam-address:
60026         type: string
60027         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).
60028       equipment-role:
60029         type: string
60030         description: Client should send valid enumerated value, e.g., VPLS-PE.
60031       vlan-id-outer:
60032         type: integer
60033         format: int64
60034         description: Temporary location for stag to get to VCE
60035       resource-version:
60036         type: string
60037         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60038       relationship-list:
60039         type: array
60040         items:
60041           $ref: "#/definitions/relationship"
60042       p-interfaces:
60043         type: array
60044         items:
60045           $ref: "#/definitions/p-interface"
60046       lag-interfaces:
60047         type: array
60048         items:
60049           $ref: "#/definitions/lag-interface"
60050   vpls-pes:
60051     description: |
60052       Collection of VPLS Provider Edge routers
60053     properties:
60054       vpls-pe:
60055         type: array
60056         items:
60057           $ref: "#/definitions/vpls-pe"
60058   vpn-binding:
60059     description: |
60060       VPN binding
60061       ###### Related Nodes
60062       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
60063       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
60064       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
60065       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
60066       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
60067       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
60068     required:
60069     - vpn-id
60070     - vpn-name
60071     properties:
60072       vpn-id:
60073         type: string
60074         description: VPN ID, globally unique within A&AI
60075       vpn-name:
60076         type: string
60077         description: VPN Name
60078       vpn-platform:
60079         type: string
60080         description: the platform associated with the VPN example AVPN, Mobility
60081       vpn-type:
60082         type: string
60083         description: Type of the vpn, should be taken from enumerated/valid values
60084       vpn-region:
60085         type: string
60086         description: region of customer vpn
60087       customer-vpn-id:
60088         type: string
60089         description: id for this customer vpn
60090       route-distinguisher:
60091         type: string
60092         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
60093       resource-version:
60094         type: string
60095         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60096       route-targets:
60097         type: array
60098         items:
60099           $ref: "#/definitions/route-target"
60100       relationship-list:
60101         type: array
60102         items:
60103           $ref: "#/definitions/relationship"
60104         description: l3-networks relate to vpn-bindings
60105   vpn-bindings:
60106     properties:
60107       vpn-binding:
60108         type: array
60109         items:
60110           $ref: "#/definitions/vpn-binding"
60111   vserver:
60112     description: |
60113       Virtual Servers, aka virtual machine or VM.
60114       ###### Related Nodes
60115       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
60116       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
60117       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
60118       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
60119       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
60120       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
60121       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
60122       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
60123       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
60124       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
60125       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
60126       - VSERVER is DELETED when these are DELETED L-INTERFACE
60127       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
60128     required:
60129     - vserver-id
60130     - vserver-name
60131     - vserver-selflink
60132     - in-maint
60133     - is-closed-loop-disabled
60134     properties:
60135       vserver-id:
60136         type: string
60137         description: Unique identifier for this vserver relative to its tenant
60138       vserver-name:
60139         type: string
60140         description: Name of vserver
60141       vserver-name2:
60142         type: string
60143         description: Alternative name of vserver
60144       prov-status:
60145         type: string
60146         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60147       vserver-selflink:
60148         type: string
60149         description: URL to endpoint where AAI can get more details
60150       in-maint:
60151         type: boolean
60152       is-closed-loop-disabled:
60153         type: boolean
60154       resource-version:
60155         type: string
60156         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60157       volumes:
60158         type: array
60159         items:
60160           $ref: "#/definitions/volume"
60161       relationship-list:
60162         type: array
60163         items:
60164           $ref: "#/definitions/relationship"
60165       l-interfaces:
60166         type: array
60167         items:
60168           $ref: "#/definitions/l-interface"
60169   vservers:
60170     description: |
60171       Collection of virtual Servers, aka virtual machines or VMs.
60172     properties:
60173       vserver:
60174         type: array
60175         items:
60176           $ref: "#/definitions/vserver"
60177   zone:
60178     description: |
60179       A zone is a grouping of assets in a location homing to the same connections into the CBB
60180       ###### Related Nodes
60181       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60182       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60183       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60184       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60185       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60186     required:
60187     - zone-id
60188     - zone-name
60189     - design-type
60190     - zone-context
60191     properties:
60192       zone-id:
60193         type: string
60194         description: Code assigned by AIC to the zone
60195       zone-name:
60196         type: string
60197         description: English name associated with the zone
60198       design-type:
60199         type: string
60200         description: Design of zone [Medium/Large…]
60201       zone-context:
60202         type: string
60203         description: Context of zone [production/test]
60204       status:
60205         type: string
60206         description: Status of a zone.
60207       resource-version:
60208         type: string
60209         description: Concurrency value
60210       relationship-list:
60211         type: array
60212         items:
60213           $ref: "#/definitions/relationship"
60214   zones:
60215     description: |
60216       Collection of zones
60217     properties:
60218       zone:
60219         type: array
60220         items:
60221           $ref: "#/definitions/zone"
60222 patchDefinitions:
60223   aai-internal:
60224     properties:
60225       property-name:
60226         type: string
60227       property-value:
60228         type: string
60229   action:
60230     properties:
60231       action-type:
60232         type: string
60233       action-data:
60234         type: array
60235         items:
60236           $ref: "#/patchDefinitions/action-data"
60237   action-data:
60238     properties:
60239       property-name:
60240         type: string
60241       property-value:
60242         type: string
60243   actions:
60244     description: |
60245       APIs that are more action related than REST (e.g., notify, update).
60246     properties:
60247       update:
60248         type: object
60249         $ref: "#/patchDefinitions/update"
60250       notify:
60251         type: object
60252         $ref: "#/patchDefinitions/notify"
60253   allotted-resource:
60254     description: |
60255       Represents a slice or partial piece of a resource that gets separately allotted
60256       ###### Related Nodes
60257       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
60258       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
60259       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60260       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
60261       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
60262       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
60263       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
60264       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
60265       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60266       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
60267       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
60268       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
60269       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
60270       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
60271       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
60272     required:
60273     - id
60274     properties:
60275       id:
60276         type: string
60277         description: Allotted Resource id UUID assigned to this instance.
60278       description:
60279         type: string
60280         description: The descriptive information assigned to this allotted resource instance
60281       selflink:
60282         type: string
60283         description: Link back to more information in the controller
60284       model-invariant-id:
60285         type: string
60286         description: the ASDC model id for this resource or service model.
60287       model-version-id:
60288         type: string
60289         description: the ASDC model version for this resource or service model.
60290       persona-model-version:
60291         type: string
60292         description: the ASDC model version for this resource or service model.
60293   allotted-resources:
60294     description: |
60295       This object is used to store slices of services being offered
60296     properties:
60297       allotted-resource:
60298         type: array
60299         items:
60300           $ref: "#/patchDefinitions/allotted-resource"
60301   availability-zone:
60302     description: |
60303       Availability zone, a collection of compute hosts/pservers
60304       ###### Related Nodes
60305       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60306       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60307       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60308       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
60309       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
60310       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
60311       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
60312       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
60313       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
60314     required:
60315     - availability-zone-name
60316     - hypervisor-type
60317     properties:
60318       availability-zone-name:
60319         type: string
60320         description: Name of the availability zone.  Unique across a cloud region
60321       hypervisor-type:
60322         type: string
60323         description: Type of hypervisor.  Source of truth should define valid values.
60324       operational-status:
60325         type: string
60326         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
60327   availability-zones:
60328     description: |
60329       Collection of availability zones
60330     properties:
60331       availability-zone:
60332         type: array
60333         items:
60334           $ref: "#/patchDefinitions/availability-zone"
60335   az-and-dvs-switches:
60336     properties:
60337       dvs-switches:
60338         type: object
60339         $ref: "#/patchDefinitions/dvs-switches"
60340       availability-zone:
60341         type: object
60342         $ref: "#/patchDefinitions/availability-zone"
60343   business:
60344     description: |
60345       Namespace for business related constructs
60346     properties:
60347       connectors:
60348         type: array
60349         items:
60350           $ref: "#/patchDefinitions/connector"
60351       customers:
60352         type: array
60353         items:
60354           $ref: "#/patchDefinitions/customer"
60355       lines-of-business:
60356         type: array
60357         items:
60358           $ref: "#/patchDefinitions/line-of-business"
60359       owning-entities:
60360         type: array
60361         items:
60362           $ref: "#/patchDefinitions/owning-entity"
60363       platforms:
60364         type: array
60365         items:
60366           $ref: "#/patchDefinitions/platform"
60367       projects:
60368         type: array
60369         items:
60370           $ref: "#/patchDefinitions/project"
60371   class-of-service:
60372     description: |
60373       ###### Related Nodes
60374       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
60375     required:
60376     - cos
60377     properties:
60378       cos:
60379         type: string
60380         description: unique identifier of probe
60381       probe-id:
60382         type: string
60383         description: identifier of probe
60384       probe-type:
60385         type: string
60386         description: type of probe
60387   classes-of-service:
60388     description: |
60389       class-of-service of probe
60390     properties:
60391       class-of-service:
60392         type: array
60393         items:
60394           $ref: "#/patchDefinitions/class-of-service"
60395   cloud-infrastructure:
60396     description: |
60397       Namespace for cloud infrastructure.
60398     properties:
60399       complexes:
60400         type: array
60401         items:
60402           $ref: "#/patchDefinitions/complex"
60403       cloud-regions:
60404         type: array
60405         items:
60406           $ref: "#/patchDefinitions/cloud-region"
60407       network-profiles:
60408         type: array
60409         items:
60410           $ref: "#/patchDefinitions/network-profile"
60411       pservers:
60412         type: array
60413         items:
60414           $ref: "#/patchDefinitions/pserver"
60415       virtual-data-centers:
60416         type: array
60417         items:
60418           $ref: "#/patchDefinitions/virtual-data-center"
60419       operational-environments:
60420         type: array
60421         items:
60422           $ref: "#/patchDefinitions/operational-environment"
60423   cloud-region:
60424     description: |
60425       cloud-region designates an installation of a cloud cluster or region or instantiation.
60426       ###### Related Nodes
60427       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
60428       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60429       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60430       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60431       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60432       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60433       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60434       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60435       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60436       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60437       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60438       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60439       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60440       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60441       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60442       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60443       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
60444       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
60445       - 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
60446       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
60447       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60448     required:
60449     - cloud-owner
60450     - cloud-region-id
60451     - sriov-automation
60452     properties:
60453       cloud-owner:
60454         type: string
60455         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
60456       cloud-region-id:
60457         type: string
60458         description: Identifier used by the vendor for the region. Second part of composite key
60459       cloud-type:
60460         type: string
60461         description: Type of the cloud (e.g., openstack)
60462       owner-defined-type:
60463         type: string
60464         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
60465       cloud-region-version:
60466         type: string
60467         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
60468       identity-url:
60469         type: string
60470         description: URL of the keystone identity service
60471       cloud-zone:
60472         type: string
60473         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
60474       complex-name:
60475         type: string
60476         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
60477       sriov-automation:
60478         type: boolean
60479       cloud-extra-info:
60480         type: string
60481         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
60482       cloud-epa-caps:
60483         type: string
60484         description: MultiVIM will discover and expose EPA capabilities.
60485   cloud-regions:
60486     properties:
60487       cloud-region:
60488         type: array
60489         items:
60490           $ref: "#/patchDefinitions/cloud-region"
60491   complex:
60492     description: |
60493       Collection of physical locations that can house cloud-regions.
60494       ###### Related Nodes
60495       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60496       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60497       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60498       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
60499       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
60500       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
60501       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60502       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60503       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
60504       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60505       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60506       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60507       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
60508       - COMPLEX is DELETED when these are DELETED CTAG-POOL
60509     required:
60510     - physical-location-id
60511     - physical-location-type
60512     - street1
60513     - city
60514     - postal-code
60515     - country
60516     - region
60517     properties:
60518       physical-location-id:
60519         type: string
60520         description: Unique identifier for physical location, e.g., CLLI
60521       data-center-code:
60522         type: string
60523         description: Data center code which can be an alternate way to identify a complex
60524       complex-name:
60525         type: string
60526         description: Gamma complex name for LCP instance.
60527       identity-url:
60528         type: string
60529         description: URL of the keystone identity service
60530   complexes:
60531     description: |
60532       Collection of physical locations that can house cloud-regions.
60533     properties:
60534       complex:
60535         type: array
60536         items:
60537           $ref: "#/patchDefinitions/complex"
60538   configuration:
60539     description: |
60540       Port Mirror Configuration.
60541       ###### Related Nodes
60542       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
60543       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60544       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
60545       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
60546       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
60547       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
60548       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
60549       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
60550       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
60551       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
60552       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
60553       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
60554       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
60555     required:
60556     - configuration-id
60557     - configuration-type
60558     - configuration-sub-type
60559     - orchestration-status
60560     - operational-status
60561     - configuration-selflink
60562     - model-customization-id
60563     properties:
60564       configuration-id:
60565         type: string
60566         description: UUID assigned to configuration.
60567       management-option:
60568         type: string
60569         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
60570       configuration-name:
60571         type: string
60572         description: Name of the configuration.
60573       configuration-type:
60574         type: string
60575         description: port-mirroring-configuration.
60576       configuration-sub-type:
60577         type: string
60578         description: vprobe, pprobe.
60579       model-invariant-id:
60580         type: string
60581         description: the ASDC model id for this resource or service model.
60582       model-version-id:
60583         type: string
60584         description: the ASDC model version for this resource or service model.
60585       orchestration-status:
60586         type: string
60587         description: Orchestration status of the configuration.
60588       operational-status:
60589         type: string
60590         description: Indicator for whether the resource is considered operational.
60591       configuration-selflink:
60592         type: string
60593         description: URL to endpoint where AAI can get more details from SDN-GC.
60594       model-customization-id:
60595         type: string
60596         description: id of  the configuration used to customize the resource
60597       tunnel-bandwidth:
60598         type: string
60599         description: DHV Site Effective Bandwidth
60600       vendor-allowed-max-bandwidth:
60601         type: string
60602         description: Velocloud Nominal Throughput - VNT
60603   configurations:
60604     description: |
60605       Collection of configurations
60606     properties:
60607       configuration:
60608         type: array
60609         items:
60610           $ref: "#/patchDefinitions/configuration"
60611   connector:
60612     description: |
60613       Collection of resource instances used to connect a variety of disparate inventory widgets
60614       ###### Related Nodes
60615       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
60616       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
60617       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
60618       - CONNECTOR is DELETED when these are DELETED METADATUM
60619     required:
60620     - resource-instance-id
60621     properties:
60622       resource-instance-id:
60623         type: string
60624         description: Unique id of resource instance.
60625   connectors:
60626     description: |
60627       Collection of resource instances used to connect a variety of disparate inventory widgets
60628     properties:
60629       connector:
60630         type: array
60631         items:
60632           $ref: "#/patchDefinitions/connector"
60633   constrained-element-set:
60634     description: |
60635       This is how we would capture constraints defining allowed sets of elements.
60636       ###### Related Nodes
60637       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
60638       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60639       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
60640       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
60641     required:
60642     - constrained-element-set-uuid
60643     - constraint-type
60644     - check-type
60645     properties:
60646       constrained-element-set-uuid:
60647         type: string
60648       constraint-type:
60649         type: string
60650       check-type:
60651         type: string
60652   constrained-element-sets:
60653     properties:
60654       constrained-element-set:
60655         type: array
60656         items:
60657           $ref: "#/patchDefinitions/constrained-element-set"
60658   ctag-assignment:
60659     description: |
60660       ###### Related Nodes
60661       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60662       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
60663     required:
60664     - vlan-id-inner
60665     properties:
60666       vlan-id-inner:
60667         type: integer
60668         format: int64
60669         description: id.
60670   ctag-assignments:
60671     properties:
60672       ctag-assignment:
60673         type: array
60674         items:
60675           $ref: "#/patchDefinitions/ctag-assignment"
60676   ctag-pool:
60677     description: |
60678       A collection of C tags (vlan tags) grouped for a specific purpose.
60679       ###### Related Nodes
60680       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
60681       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
60682       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
60683       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
60684     required:
60685     - target-pe
60686     - availability-zone-name
60687     - ctag-pool-purpose
60688     properties:
60689       target-pe:
60690         type: string
60691         description: The Target provider edge router
60692       availability-zone-name:
60693         type: string
60694         description: Name of the availability zone
60695       ctag-pool-purpose:
60696         type: string
60697         description: Describes what the intended purpose of this pool is.
60698       ctag-values:
60699         type: string
60700         description: Comma separated list of ctags
60701   ctag-pools:
60702     properties:
60703       ctag-pool:
60704         type: array
60705         items:
60706           $ref: "#/patchDefinitions/ctag-pool"
60707   customer:
60708     description: |
60709       customer identifiers to provide linkage back to BSS information.
60710       ###### Related Nodes
60711       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
60712       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
60713     required:
60714     - global-customer-id
60715     - subscriber-name
60716     - subscriber-type
60717     properties:
60718       global-customer-id:
60719         type: string
60720         description: Global customer id used across ECOMP to uniquely identify customer.
60721       subscriber-name:
60722         type: string
60723         description: Subscriber name, an alternate way to retrieve a customer.
60724       subscriber-type:
60725         type: string
60726         description: Subscriber type, a way to provide VID with only the INFRA customers.
60727   customers:
60728     description: |
60729       Collection of customer identifiers to provide linkage back to BSS information.
60730     properties:
60731       customer:
60732         type: array
60733         items:
60734           $ref: "#/patchDefinitions/customer"
60735   cvlan-tag-entry:
60736     required:
60737     - cvlan-tag
60738     properties:
60739       cvlan-tag:
60740         type: integer
60741         format: int64
60742         description: See mis-na-virtualization-platform.yang
60743   cvlan-tags:
60744     properties:
60745       cvlan-tag-entry:
60746         type: array
60747         items:
60748           $ref: "#/patchDefinitions/cvlan-tag-entry"
60749   dvs-switch:
60750     description: |
60751       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.
60752       ###### Related Nodes
60753       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60754       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
60755     required:
60756     - switch-name
60757     - vcenter-url
60758     properties:
60759       switch-name:
60760         type: string
60761         description: DVS switch name
60762       vcenter-url:
60763         type: string
60764         description: URL used to reach the vcenter
60765   dvs-switches:
60766     description: |
60767       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
60768     properties:
60769       dvs-switch:
60770         type: array
60771         items:
60772           $ref: "#/patchDefinitions/dvs-switch"
60773   edge-prop-names:
60774     description: |
60775       Internal map to define the properties of an edge and interpret the map EdgeRules
60776     properties:
60777       edgeLabel:
60778         type: string
60779       direction:
60780         type: string
60781       multiplicityRule:
60782         type: string
60783       contains-other-v:
60784         type: string
60785       delete-other-v:
60786         type: string
60787       SVC-INFRA:
60788         type: string
60789       prevent-delete:
60790         type: string
60791       aai-uuid:
60792         type: string
60793   edge-tag-query-request:
60794     properties:
60795       edge-tag:
60796         type: string
60797       result-detail:
60798         type: string
60799       start-node-type:
60800         type: string
60801       start-node-filter:
60802         type: array
60803         items:
60804           $ref: "#/patchDefinitions/start-node-filter"
60805       include-node-filter:
60806         type: array
60807         items:
60808           $ref: "#/patchDefinitions/include-node-filter"
60809       secondary-filter:
60810         type: array
60811         items:
60812           $ref: "#/patchDefinitions/secondary-filter"
60813   edge-tag-query-result:
60814     properties:
60815       tagged-inventory-item-list:
60816         type: array
60817         items:
60818           $ref: "#/patchDefinitions/tagged-inventory-item-list"
60819   element-choice-set:
60820     description: |
60821       This is how we would capture constraints defining allowed sets of elements.
60822       ###### Related Nodes
60823       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
60824       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
60825       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
60826     required:
60827     - element-choice-set-uuid
60828     - element-choice-set-name
60829     properties:
60830       element-choice-set-uuid:
60831         type: string
60832       element-choice-set-name:
60833         type: string
60834       cardinality:
60835         type: string
60836   element-choice-sets:
60837     properties:
60838       element-choice-set:
60839         type: array
60840         items:
60841           $ref: "#/patchDefinitions/element-choice-set"
60842   entitlement:
60843     description: |
60844       Metadata for entitlement group.
60845       ###### Related Nodes
60846       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60847       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60848     required:
60849     - group-uuid
60850     - resource-uuid
60851     properties:
60852       group-uuid:
60853         type: string
60854         description: Unique ID for the entitlement group the resource comes from, should be uuid.
60855       resource-uuid:
60856         type: string
60857         description: Unique ID of an entitlement resource.
60858   entitlements:
60859     description: |
60860       Entitlements, keyed by group-uuid and resource-uuid, related to license management
60861     properties:
60862       entitlement:
60863         type: array
60864         items:
60865           $ref: "#/patchDefinitions/entitlement"
60866   esr-ems:
60867     description: |
60868       Persist EMS address information used by EMS driver.
60869       ###### Related Nodes
60870       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
60871       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60872     required:
60873     - ems-id
60874     properties:
60875       ems-id:
60876         type: string
60877         description: Unique ID of EMS.
60878   esr-ems-list:
60879     properties:
60880       esr-ems:
60881         type: array
60882         items:
60883           $ref: "#/patchDefinitions/esr-ems"
60884   esr-system-info:
60885     description: |
60886       Persist common address information of external systems.
60887       ###### Related Nodes
60888       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
60889       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
60890       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
60891       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
60892     required:
60893     - esr-system-info-id
60894     - user-name
60895     - password
60896     - system-type
60897     properties:
60898       esr-system-info-id:
60899         type: string
60900         description: Unique ID of esr system info.
60901       system-name:
60902         type: string
60903         description: name of external system.
60904       type:
60905         type: string
60906         description: type of external systems.
60907       vendor:
60908         type: string
60909         description: vendor of external systems.
60910       version:
60911         type: string
60912         description: version of external systems.
60913       service-url:
60914         type: string
60915         description: url used to access external systems.
60916       user-name:
60917         type: string
60918         description: username used to access external systems.
60919       password:
60920         type: string
60921         description: password used to access external systems.
60922       system-type:
60923         type: string
60924         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
60925       protocol:
60926         type: string
60927         description: protocol of third party SDNC, for example netconf/snmp.
60928       ssl-cacert:
60929         type: string
60930         description: ca file content if enabled ssl on auth-url.
60931       ssl-insecure:
60932         type: boolean
60933         description: Whether to verify VIM's certificate.
60934       ip-address:
60935         type: string
60936         description: service IP of ftp server.
60937       port:
60938         type: string
60939         description: service port of ftp server.
60940       cloud-domain:
60941         type: string
60942         description: domain info for authentication.
60943       default-tenant:
60944         type: string
60945         description: default tenant of VIM.
60946       passive:
60947         type: boolean
60948         description: ftp passive mode or not.
60949       remote-path:
60950         type: string
60951         description: resource or performance data file path.
60952       system-status:
60953         type: string
60954         description: the status of external system.
60955   esr-system-info-list:
60956     description: |
60957       Collection of persistent block-level external system auth info.
60958     properties:
60959       esr-system-info:
60960         type: array
60961         items:
60962           $ref: "#/patchDefinitions/esr-system-info"
60963   esr-thirdparty-sdnc:
60964     description: |
60965       Persist SDNC address information used by ONAP SDNC.
60966       ###### Related Nodes
60967       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
60968       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
60969       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60970     required:
60971     - thirdparty-sdnc-id
60972     properties:
60973       thirdparty-sdnc-id:
60974         type: string
60975         description: Unique ID of SDNC.
60976       location:
60977         type: string
60978         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
60979       product-name:
60980         type: string
60981         description: password used to access SDNC server.
60982   esr-thirdparty-sdnc-list:
60983     properties:
60984       esr-thirdparty-sdnc:
60985         type: array
60986         items:
60987           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
60988   esr-vnfm:
60989     description: |
60990       Persist VNFM address information used by VF-C.
60991       ###### Related Nodes
60992       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
60993       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60994     required:
60995     - vnfm-id
60996     properties:
60997       vnfm-id:
60998         type: string
60999         description: Unique ID of VNFM.
61000       vim-id:
61001         type: string
61002         description: indecate the VIM to deploy VNF.
61003       certificate-url:
61004         type: string
61005         description: certificate url of VNFM.
61006   esr-vnfm-list:
61007     properties:
61008       esr-vnfm:
61009         type: array
61010         items:
61011           $ref: "#/patchDefinitions/esr-vnfm"
61012   evc:
61013     description: |
61014       evc object is an optional child object of the Configuration object.
61015       ###### Related Nodes
61016       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
61017     required:
61018     - evc-id
61019     properties:
61020       evc-id:
61021         type: string
61022         description: Unique/key field for the evc object
61023       forwarding-path-topology:
61024         type: string
61025         description: Point-to-Point, Multi-Point
61026       cir-value:
61027         type: string
61028         description: Commited Information Rate
61029       cir-units:
61030         type: string
61031         description: CIR units
61032       connection-diversity-group-id:
61033         type: string
61034         description: Diversity Group ID
61035       service-hours:
61036         type: string
61037         description: formerly Performance Group
61038       esp-evc-circuit-id:
61039         type: string
61040         description: EVC Circuit ID of ESP EVC
61041       esp-evc-cir-value:
61042         type: string
61043         description: Committed Information Rate (For ESP)
61044       esp-evc-cir-units:
61045         type: string
61046         description: CIR units (For ESP)
61047       esp-itu-code:
61048         type: string
61049         description: Identifies ESP
61050       collector-pop-clli:
61051         type: string
61052         description: Collector POP CLLI (from the hostname of the access pnf)
61053       inter-connect-type-ingress:
61054         type: string
61055         description: Interconnect type on ingress side of EVC.
61056       tagmode-access-ingress:
61057         type: string
61058         description: tagode for collector side of EVC
61059       tagmode-access-egress:
61060         type: string
61061         description: tagMode for network side of EVC
61062   evcs:
61063     properties:
61064       evc:
61065         type: array
61066         items:
61067           $ref: "#/patchDefinitions/evc"
61068   external-system:
61069     description: |
61070       Namespace for external system.
61071     properties:
61072       esr-ems-list:
61073         type: object
61074         $ref: "#/patchDefinitions/esr-ems-list"
61075       esr-vnfm-list:
61076         type: object
61077         $ref: "#/patchDefinitions/esr-vnfm-list"
61078       esr-thirdparty-sdnc-list:
61079         type: object
61080         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
61081   extra-properties:
61082     description: |
61083       Extra properties for inventory item for response list
61084     properties:
61085       extra-property:
61086         type: array
61087         items:
61088           $ref: "#/patchDefinitions/extra-property"
61089   extra-property:
61090     properties:
61091       property-name:
61092         type: string
61093       property-value:
61094         type: string
61095   flavor:
61096     description: |
61097       Openstack flavor.
61098       ###### Related Nodes
61099       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61100       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
61101       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
61102       - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
61103     required:
61104     - flavor-id
61105     - flavor-name
61106     - flavor-selflink
61107     properties:
61108       flavor-id:
61109         type: string
61110         description: Flavor id, expected to be unique across cloud-region.
61111       flavor-name:
61112         type: string
61113         description: Cloud Region Flavor name
61114       flavor-vcpus:
61115         type: integer
61116         format: int32
61117         description: Number of CPUs
61118       flavor-ram:
61119         type: integer
61120         format: int32
61121         description: Amount of memory
61122       flavor-disk:
61123         type: integer
61124         format: int32
61125         description: Disk space
61126       flavor-ephemeral:
61127         type: integer
61128         format: int32
61129         description: Amount of ephemeral disk space
61130       flavor-swap:
61131         type: string
61132         description: amount of swap space allocation
61133       flavor-is-public:
61134         type: boolean
61135         description: whether flavor is available to all users or private to the tenant it was created in.
61136       flavor-selflink:
61137         type: string
61138         description: URL to endpoint where AAI can get more details
61139       flavor-disabled:
61140         type: boolean
61141         description: Boolean as to whether this flavor is no longer enabled
61142       hpa-capabilities:
61143         type: array
61144         items:
61145           $ref: "#/patchDefinitions/hpa-capability"
61146         description: List of flavor specific HPA Capabilities
61147   flavors:
61148     description: |
61149       Collection of openstack flavors.
61150     properties:
61151       flavor:
61152         type: array
61153         items:
61154           $ref: "#/patchDefinitions/flavor"
61155   forwarder:
61156     description: |
61157       Entity describing a sequenced segment of forwarding path
61158       ###### Related Nodes
61159       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
61160       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
61161       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
61162       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
61163       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
61164       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
61165     required:
61166     - sequence
61167     properties:
61168       sequence:
61169         type: integer
61170         format: int32
61171         description: Unique ID of this segmentation
61172       forwarder-role:
61173         type: string
61174         description: ingress, intermediate, egress
61175   forwarder-evc:
61176     description: |
61177       forwarder object is an optional child object of the Configuration object.
61178       ###### Related Nodes
61179       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
61180     required:
61181     - forwarder-evc-id
61182     properties:
61183       forwarder-evc-id:
61184         type: string
61185         description: Key for forwarder-evc object
61186       circuit-id:
61187         type: string
61188         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
61189       ivlan:
61190         type: string
61191         description: Internal VLAN.
61192       svlan:
61193         type: string
61194         description: SVLAN value for ingress of egress forwarder.
61195       cvlan:
61196         type: string
61197         description: CVLAN value for ingress of egress forwarder.
61198   forwarder-evcs:
61199     properties:
61200       forwarder-evc:
61201         type: array
61202         items:
61203           $ref: "#/patchDefinitions/forwarder-evc"
61204   forwarders:
61205     properties:
61206       forwarder:
61207         type: array
61208         items:
61209           $ref: "#/patchDefinitions/forwarder"
61210   forwarding-path:
61211     description: |
61212       Entity that describes the sequenced forwarding path between interfaces of services or resources
61213       ###### Related Nodes
61214       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
61215       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
61216       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
61217       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
61218       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
61219     required:
61220     - forwarding-path-id
61221     - forwarding-path-name
61222     properties:
61223       forwarding-path-id:
61224         type: string
61225         description: Unique ID of this FP
61226       forwarding-path-name:
61227         type: string
61228         description: Name of the FP
61229   forwarding-paths:
61230     properties:
61231       forwarding-path:
61232         type: array
61233         items:
61234           $ref: "#/patchDefinitions/forwarding-path"
61235   generic-vnf:
61236     description: |
61237       General purpose VNF
61238       ###### Related Nodes
61239       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
61240       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
61241       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
61242       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
61243       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61244       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
61245       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61246       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
61247       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
61248       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
61249       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
61250       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61251       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
61252       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61253       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
61254       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
61255       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61256       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61257       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61258       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61259       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61260       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61261       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
61262       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61263       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61264       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
61265       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
61266       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
61267       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
61268       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
61269     required:
61270     - vnf-id
61271     - vnf-instance-id
61272     - vnf-name
61273     - vnf-type
61274     - vnf-package-name
61275     - vnf-discriptor-name
61276     - job-id
61277     - in-maint
61278     - is-closed-loop-disabled
61279     properties:
61280       vnf-id:
61281         type: string
61282         description: Unique id of VNF.  This is unique across the graph.
61283       vnf-instance-id:
61284         type: string
61285         description: vnf instance id.
61286       vnf-name:
61287         type: string
61288         description: Name of VNF.
61289       vnf-name2:
61290         type: string
61291         description: Alternate name of VNF.
61292       vnf-type:
61293         type: string
61294         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.
61295       service-id:
61296         type: string
61297         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
61298       regional-resource-zone:
61299         type: string
61300         description: Regional way of organizing pservers, source of truth should define values
61301       prov-status:
61302         type: string
61303         description: Trigger for operational monitoring of this resource by Service Assurance systems.
61304       operational-status:
61305         type: string
61306         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
61307       license-key:
61308         type: string
61309         description: OBSOLETE -  do not use
61310       equipment-role:
61311         type: string
61312         description: Client should send valid enumerated value
61313       orchestration-status:
61314         type: string
61315         description: Orchestration status of this VNF, used by MSO.
61316       vnf-package-name:
61317         type: string
61318       vnf-discriptor-name:
61319         type: string
61320         description: vnf discriptor name
61321       job-id:
61322         type: string
61323         description: job id corresponding to vnf
61324       heat-stack-id:
61325         type: string
61326         description: Heat stack id corresponding to this instance, managed by MSO
61327       mso-catalog-key:
61328         type: string
61329         description: Corresponds to the SDN-C catalog id used to configure this VCE
61330       management-option:
61331         type: string
61332         description: identifier of managed by ATT or customer
61333       ipv4-oam-address:
61334         type: string
61335         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
61336       ipv4-loopback0-address:
61337         type: string
61338         description: v4 Loopback0 address
61339       nm-lan-v6-address:
61340         type: string
61341         description: v6 Loopback address
61342       management-v6-address:
61343         type: string
61344         description: v6 management address
61345       vcpu:
61346         type: integer
61347         format: int64
61348         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
61349       vcpu-units:
61350         type: string
61351         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
61352       vmemory:
61353         type: integer
61354         format: int64
61355         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
61356       vmemory-units:
61357         type: string
61358         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
61359       vdisk:
61360         type: integer
61361         format: int64
61362         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
61363       vdisk-units:
61364         type: string
61365         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
61366       nshd:
61367         type: integer
61368         format: int64
61369         description: number of associated SHD in vnf.
61370       nvm:
61371         type: integer
61372         format: int64
61373         description: number of vms in vnf.
61374       nnet:
61375         type: integer
61376         format: int64
61377         description: number of network in vnf.
61378       in-maint:
61379         type: boolean
61380       is-closed-loop-disabled:
61381         type: boolean
61382   generic-vnfs:
61383     description: |
61384       Collection of VNFs
61385     properties:
61386       generic-vnf:
61387         type: array
61388         items:
61389           $ref: "#/patchDefinitions/generic-vnf"
61390   group-assignment:
61391     description: |
61392       Openstack group-assignment used to store exclusivity groups (EG).
61393       ###### Related Nodes
61394       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61395       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
61396       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
61397     required:
61398     - group-id
61399     - group-type
61400     - group-name
61401     properties:
61402       group-id:
61403         type: string
61404         description: Group id, expected to be unique across cloud-region.
61405       group-type:
61406         type: string
61407         description: Group type - the type of group this instance refers to
61408       group-name:
61409         type: string
61410         description: Group name - name assigned to the group
61411       group-description:
61412         type: string
61413         description: Group description - description of the group
61414   group-assignments:
61415     description: |
61416       Collection of openstack group assignments
61417     properties:
61418       group-assignment:
61419         type: array
61420         items:
61421           $ref: "#/patchDefinitions/group-assignment"
61422   host-route:
61423     description: |
61424       ###### Related Nodes
61425       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
61426     required:
61427     - host-route-id
61428     - route-prefix
61429     - next-hop
61430     properties:
61431       host-route-id:
61432         type: string
61433         description: host-route id
61434       route-prefix:
61435         type: string
61436         description: subnet prefix
61437       next-hop:
61438         type: string
61439         description: Could be ip-address, hostname, or service-instance
61440       next-hop-type:
61441         type: string
61442         description: Should be ip-address, hostname, or service-instance to match next-hop
61443   host-routes:
61444     properties:
61445       host-route:
61446         type: array
61447         items:
61448           $ref: "#/patchDefinitions/host-route"
61449   hpa-capabilities:
61450     description: |
61451       Collection of HPA Capabilities
61452     properties:
61453       hpa-capability:
61454         type: array
61455         items:
61456           $ref: "#/patchDefinitions/hpa-capability"
61457   hpa-capability:
61458     description: |
61459       Represents a HPA capability
61460       ###### Related Nodes
61461       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
61462       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61463       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
61464       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
61465     required:
61466     - hpa-capability-id
61467     - hpa-feature
61468     properties:
61469       hpa-capability-id:
61470         type: string
61471         description: UUID to uniquely identify a HPA capability
61472       hpa-feature:
61473         type: string
61474         description: Name of the HPACapability
61475       hpa-version:
61476         type: string
61477         description: HPA schema version
61478       architecture:
61479         type: string
61480         description: Hardware architecture
61481   hpa-feature-attributes:
61482     description: |
61483       HPA Capability Feature attributes
61484       ###### Related Nodes
61485       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
61486     required:
61487     - hpa-attribute-key
61488     properties:
61489       hpa-attribute-key:
61490         type: string
61491         description: name of the specific HPA attribute
61492       hpa-attribute-value:
61493         type: string
61494         description: JSON string specifying the value, unit and type of the specific HPA attribute
61495   image:
61496     description: |
61497       Openstack image.
61498       ###### Related Nodes
61499       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61500       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
61501       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
61502       - IMAGE cannot be deleted if linked to VSERVER
61503       - IMAGE is DELETED when these are DELETED METADATUM
61504     required:
61505     - image-id
61506     - image-name
61507     - image-os-distro
61508     - image-os-version
61509     - image-selflink
61510     properties:
61511       image-id:
61512         type: string
61513         description: Image id, expected to be unique across cloud region
61514       image-name:
61515         type: string
61516         description: Image name
61517       image-architecture:
61518         type: string
61519         description: Operating system architecture.
61520       image-os-distro:
61521         type: string
61522         description: The common name of the operating system distribution in lowercase
61523       image-os-version:
61524         type: string
61525         description: The operating system version as specified by the distributor.
61526       application:
61527         type: string
61528         description: The application that the image instantiates.
61529       application-vendor:
61530         type: string
61531         description: The vendor of the application.
61532       application-version:
61533         type: string
61534         description: The version of the application.
61535       image-selflink:
61536         type: string
61537         description: URL to endpoint where AAI can get more details
61538   images:
61539     description: |
61540       Collectio of Openstack images.
61541     properties:
61542       image:
61543         type: array
61544         items:
61545           $ref: "#/patchDefinitions/image"
61546   include-node-filter:
61547     properties:
61548       include-node-type:
61549         type: string
61550   instance-filter:
61551     description: |
61552       InstanceFilter for performing a named-query or model query
61553   instance-filters:
61554     description: |
61555       InstanceFilters for performing a named-query or model query
61556     properties:
61557       instance-filter:
61558         type: array
61559         items:
61560           $ref: "#/patchDefinitions/instance-filter"
61561   instance-group:
61562     description: |
61563       General mechanism for grouping instances
61564       ###### Related Nodes
61565       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
61566       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61567       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61568       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61569       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61570       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61571       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61572       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61573       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61574       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61575       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61576       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61577     required:
61578     - instance-group-role
61579     - model-invariant-id
61580     - model-version-id
61581     - id
61582     - description
61583     - type
61584     properties:
61585       instance-group-role:
61586         type: string
61587         description: role of the instance group.
61588       model-invariant-id:
61589         type: string
61590         description: ASDC model id for this resource or service model.
61591       model-version-id:
61592         type: string
61593         description: ASDC model version uid for this resource model.
61594       id:
61595         type: string
61596         description: Instance Group ID, UUID assigned to this instance.
61597       description:
61598         type: string
61599         description: Descriptive text to help identify the usage of this instance-group
61600       type:
61601         type: string
61602         description: Only valid value today is lower case ha for high availability
61603       sub-type:
61604         type: string
61605         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
61606   instance-groups:
61607     description: |
61608       Collection of openstack route table references
61609     properties:
61610       instance-group:
61611         type: array
61612         items:
61613           $ref: "#/patchDefinitions/instance-group"
61614   inventory:
61615     properties:
61616       search:
61617         type: object
61618         $ref: "#/patchDefinitions/search"
61619       actions:
61620         type: object
61621         $ref: "#/patchDefinitions/actions"
61622       cloud-infrastructure:
61623         type: object
61624         $ref: "#/patchDefinitions/cloud-infrastructure"
61625       external-system:
61626         type: object
61627         $ref: "#/patchDefinitions/external-system"
61628       business:
61629         type: object
61630         $ref: "#/patchDefinitions/business"
61631       service-design-and-creation:
61632         type: object
61633         $ref: "#/patchDefinitions/service-design-and-creation"
61634       network:
61635         type: object
61636         $ref: "#/patchDefinitions/network"
61637       aai-internal:
61638         type: object
61639         $ref: "#/patchDefinitions/aai-internal"
61640       nodes:
61641         type: array
61642         items:
61643           $ref: "#/patchDefinitions/aai-internal"
61644   inventory-item:
61645     properties:
61646       inventory-item-type:
61647         type: string
61648       inventory-item-link:
61649         type: string
61650       inventory-item-data:
61651         type: array
61652         items:
61653           $ref: "#/patchDefinitions/inventory-item-data"
61654       tagged-inventory-item-list:
61655         type: array
61656         items:
61657           $ref: "#/patchDefinitions/tagged-inventory-item-list"
61658   inventory-item-data:
61659     properties:
61660       property-name:
61661         type: string
61662       property-value:
61663         type: string
61664   inventory-response-item:
61665     description: |
61666       Inventory item for response list
61667     properties:
61668       model-name:
61669         type: string
61670       extra-properties:
61671         type: object
61672         $ref: "#/patchDefinitions/extra-properties"
61673       inventory-response-items:
61674         type: object
61675         $ref: "#/patchDefinitions/inventory-response-items"
61676   inventory-response-items:
61677     description: |
61678       Container for inventory items in response list
61679     properties:
61680       inventory-response-item:
61681         type: array
61682         items:
61683           $ref: "#/patchDefinitions/inventory-response-item"
61684   ipsec-configuration:
61685     description: |
61686       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
61687       ###### Related Nodes
61688       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
61689       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
61690       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
61691     required:
61692     - ipsec-configuration-id
61693     properties:
61694       ipsec-configuration-id:
61695         type: string
61696         description: UUID of this configuration
61697       requested-vig-address-type:
61698         type: string
61699         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
61700       requested-encryption-strength:
61701         type: string
61702         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
61703       requested-dmz-type:
61704         type: string
61705         description: ATT can offer a shared DMZ or a DMZ specific to a customer
61706       shared-dmz-network-address:
61707         type: string
61708         description: Network address of shared DMZ
61709       requested-customer-name:
61710         type: string
61711         description: If the DMZ is a custom DMZ, this field will indicate the customer information
61712       ike-version:
61713         type: string
61714         description: can be 1 or 2
61715       ikev1-authentication:
61716         type: string
61717         description: Contains values like md5, sha1, sha256, sha384
61718       ikev1-encryption:
61719         type: string
61720         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
61721       ikev1-dh-group:
61722         type: string
61723         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
61724       ikev1-am-group-id:
61725         type: string
61726         description: Group name defined in VIG for clients using aggressive mode
61727       ikev1-am-password:
61728         type: string
61729         description: pre-shared key for the above group name
61730       ikev1-sa-lifetime:
61731         type: string
61732         description: Lifetime for IKEv1 SA
61733       ipsec-authentication:
61734         type: string
61735         description: md5, sha1, sha256, sha384
61736       ipsec-encryption:
61737         type: string
61738         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
61739       ipsec-sa-lifetime:
61740         type: string
61741         description: Life time for IPSec SA
61742       ipsec-pfs:
61743         type: string
61744         description: enable PFS or not
61745       xauth-userid:
61746         type: string
61747         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
61748       xauth-user-password:
61749         type: string
61750         description: Encrypted using the Juniper $9$ algorithm
61751       dpd-interval:
61752         type: string
61753         description: The time between DPD probe
61754       dpd-frequency:
61755         type: string
61756         description: Maximum number of DPD before claiming the tunnel is down
61757   ipsec-configurations:
61758     properties:
61759       ipsec-configuration:
61760         type: array
61761         items:
61762           $ref: "#/patchDefinitions/ipsec-configuration"
61763   key-data:
61764     properties:
61765       key-name:
61766         type: string
61767       key-value:
61768         type: string
61769   l-interface:
61770     description: |
61771       Logical interfaces, e.g., a vnic.
61772       ###### Related Nodes
61773       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61774       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
61775       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61776       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61777       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
61778       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
61779       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
61780       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
61781       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
61782       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61783       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61784       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
61785       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
61786       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
61787       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
61788       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
61789       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
61790       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61791       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
61792       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61793     required:
61794     - interface-name
61795     - is-port-mirrored
61796     - in-maint
61797     - is-ip-unnumbered
61798     properties:
61799       interface-name:
61800         type: string
61801         description: Name given to the interface
61802       interface-role:
61803         type: string
61804         description: E.g., CUSTOMER, UPLINK, etc.
61805       v6-wan-link-ip:
61806         type: string
61807         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
61808       selflink:
61809         type: string
61810         description: URL to endpoint where AAI can get more details
61811       interface-id:
61812         type: string
61813         description: ID of interface
61814       macaddr:
61815         type: string
61816         description: MAC address for the interface
61817       network-name:
61818         type: string
61819         description: Name of the network
61820       management-option:
61821         type: string
61822         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
61823       interface-description:
61824         type: string
61825         description: Human friendly text regarding this interface.
61826       is-port-mirrored:
61827         type: boolean
61828   l-interfaces:
61829     description: |
61830       Collection of logical interfaces.
61831     properties:
61832       l-interface:
61833         type: array
61834         items:
61835           $ref: "#/patchDefinitions/l-interface"
61836   l3-interface-ipv4-address-list:
61837     description: |
61838       IPv4 Address Range
61839       ###### Related Nodes
61840       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61841       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61842       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61843       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61844       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61845       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61846     required:
61847     - l3-interface-ipv4-address
61848     properties:
61849       l3-interface-ipv4-address:
61850         type: string
61851         description: IP address
61852       l3-interface-ipv4-prefix-length:
61853         type: integer
61854         format: int64
61855         description: Prefix length, 32 for single address
61856       vlan-id-inner:
61857         type: integer
61858         format: int64
61859         description: Inner VLAN tag
61860       vlan-id-outer:
61861         type: integer
61862         format: int64
61863         description: Outer VLAN tag
61864       is-floating:
61865         type: boolean
61866         description: Indicator of fixed or floating address
61867   l3-interface-ipv6-address-list:
61868     description: |
61869       IPv6 Address Range
61870       ###### Related Nodes
61871       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61872       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61873       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61874       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61875       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61876       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61877     required:
61878     - l3-interface-ipv6-address
61879     properties:
61880       l3-interface-ipv6-address:
61881         type: string
61882         description: IP address
61883       l3-interface-ipv6-prefix-length:
61884         type: integer
61885         format: int64
61886         description: Prefix length, 128 for single address
61887       vlan-id-inner:
61888         type: integer
61889         format: int64
61890         description: Inner VLAN tag
61891       vlan-id-outer:
61892         type: integer
61893         format: int64
61894         description: Outer VLAN tag
61895       is-floating:
61896         type: boolean
61897         description: Indicator of fixed or floating address
61898   l3-network:
61899     description: |
61900       Generic network definition
61901       ###### Related Nodes
61902       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61903       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
61904       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
61905       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61906       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
61907       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
61908       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61909       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61910       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61911       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61912       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61913       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61914       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61915       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
61916       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61917       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61918       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
61919       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
61920     required:
61921     - network-id
61922     - network-name
61923     - is-bound-to-vpn
61924     - is-provider-network
61925     - is-shared-network
61926     - is-external-network
61927     properties:
61928       network-id:
61929         type: string
61930         description: Network ID, should be uuid. Unique across A&AI.
61931       network-name:
61932         type: string
61933         description: Name of the network, governed by some naming convention..
61934       network-type:
61935         type: string
61936         description: Type of the network - who defines these values?
61937       network-role:
61938         type: string
61939         description: Role the network plans - who defines these values?
61940       network-technology:
61941         type: string
61942         description: Network technology - who defines these values?
61943       neutron-network-id:
61944         type: string
61945         description: Neutron network id of this Interface
61946       is-bound-to-vpn:
61947         type: boolean
61948       service-id:
61949         type: string
61950         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
61951       network-role-instance:
61952         type: integer
61953         format: int64
61954         description: network role instance
61955   l3-networks:
61956     properties:
61957       l3-network:
61958         type: array
61959         items:
61960           $ref: "#/patchDefinitions/l3-network"
61961   lag-interface:
61962     description: |
61963       Link aggregate interface
61964       ###### Related Nodes
61965       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61966       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
61967       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61968       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
61969       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61970       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61971       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61972       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
61973       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
61974       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
61975       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
61976     required:
61977     - interface-name
61978     - in-maint
61979     properties:
61980       interface-name:
61981         type: string
61982         description: Name that identifies the link aggregate interface
61983       interface-description:
61984         type: string
61985         description: Human friendly text regarding this interface.
61986   lag-interfaces:
61987     description: |
61988       Collection of link aggregate interfaces.
61989     properties:
61990       lag-interface:
61991         type: array
61992         items:
61993           $ref: "#/patchDefinitions/lag-interface"
61994   lag-link:
61995     description: |
61996       LAG links can connect lag-interfaces
61997       ###### Related Nodes
61998       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
61999       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
62000     required:
62001     - link-name
62002     properties:
62003       link-name:
62004         type: string
62005         description: Alphabetical concatenation of lag-interface names
62006   lag-links:
62007     description: |
62008       Collection of link aggregation connections
62009     properties:
62010       lag-link:
62011         type: array
62012         items:
62013           $ref: "#/patchDefinitions/lag-link"
62014   license:
62015     description: |
62016       Metadata for license group.
62017       ###### Related Nodes
62018       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62019       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62020     required:
62021     - group-uuid
62022     - resource-uuid
62023     properties:
62024       group-uuid:
62025         type: string
62026         description: Unique ID for the license group the resource belongs to, should be uuid.
62027       resource-uuid:
62028         type: string
62029         description: Unique ID of a license resource.
62030   licenses:
62031     description: |
62032       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
62033     properties:
62034       license:
62035         type: array
62036         items:
62037           $ref: "#/patchDefinitions/license"
62038   line-of-business:
62039     description: |
62040       describes a line-of-business
62041       ###### Related Nodes
62042       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
62043     required:
62044     - line-of-business-name
62045     properties:
62046       line-of-business-name:
62047         type: string
62048         description: Name of the line-of-business (product)
62049   lines-of-business:
62050     description: |
62051       Collection of lines-of-business
62052     properties:
62053       line-of-business:
62054         type: array
62055         items:
62056           $ref: "#/patchDefinitions/line-of-business"
62057   logical-link:
62058     description: |
62059       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
62060       ###### Related Nodes
62061       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
62062       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
62063       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
62064       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
62065       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
62066       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62067       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
62068       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
62069       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62070       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62071       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
62072       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
62073       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62074       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
62075       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
62076       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
62077       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62078       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62079     required:
62080     - link-name
62081     - in-maint
62082     - link-type
62083     properties:
62084       link-name:
62085         type: string
62086         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
62087       in-maint:
62088         type: boolean
62089       link-type:
62090         type: string
62091         description: Type of logical link, e.g., evc
62092       speed-value:
62093         type: string
62094         description: Captures the numeric part of the speed
62095       speed-units:
62096         type: string
62097         description: Captures the units corresponding to the speed
62098       ip-version:
62099         type: string
62100         description: v4, v6, or ds for dual stack
62101       routing-protocol:
62102         type: string
62103         description: For example, static or BGP
62104   logical-links:
62105     description: |
62106       Collection of logical connections
62107     properties:
62108       logical-link:
62109         type: array
62110         items:
62111           $ref: "#/patchDefinitions/logical-link"
62112   metadata:
62113     description: |
62114       Collection of metadatum (key/value pairs)
62115     properties:
62116       metadatum:
62117         type: array
62118         items:
62119           $ref: "#/patchDefinitions/metadatum"
62120   metadatum:
62121     description: |
62122       Key/value pairs
62123       ###### Related Nodes
62124       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
62125       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
62126       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
62127       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
62128       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
62129     required:
62130     - metaname
62131     - metaval
62132     properties:
62133       metaname:
62134         type: string
62135       metaval:
62136         type: string
62137   model:
62138     description: |
62139       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
62140       ###### Related Nodes
62141       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
62142       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
62143       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
62144       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
62145       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
62146       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
62147       - MODEL is DELETED when these are DELETED MODEL-VER
62148     required:
62149     - model-invariant-id
62150     - model-type
62151     properties:
62152       model-invariant-id:
62153         type: string
62154         description: Unique identifier corresponding to the main definition of a model in ASDC
62155       model-type:
62156         type: string
62157         description: Type of the model, e.g., service, resource, widget, etc.
62158   model-and-named-query-search:
62159     description: |
62160       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
62161     properties:
62162       query-parameters:
62163         type: object
62164         $ref: "#/patchDefinitions/query-parameters"
62165       instance-filters:
62166         type: object
62167         $ref: "#/patchDefinitions/instance-filters"
62168       secondary-filts:
62169         type: object
62170         $ref: "#/patchDefinitions/secondary-filts"
62171       top-node-type:
62172         type: string
62173       secondary-filter-cut-point:
62174         type: string
62175   model-constraint:
62176     description: |
62177       This is how we would capture constraints defining allowed sets of elements.
62178       ###### Related Nodes
62179       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62180       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
62181       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
62182     required:
62183     - model-constraint-uuid
62184     - constrained-element-set-uuid-to-replace
62185     properties:
62186       model-constraint-uuid:
62187         type: string
62188       constrained-element-set-uuid-to-replace:
62189         type: string
62190       constrained-element-sets:
62191         type: array
62192         items:
62193           $ref: "#/patchDefinitions/constrained-element-set"
62194   model-constraints:
62195     properties:
62196       model-constraint:
62197         type: array
62198         items:
62199           $ref: "#/patchDefinitions/model-constraint"
62200   model-element:
62201     description: |
62202       Defines how other models combine to make up a higher-level model.
62203       ###### Related Nodes
62204       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
62205       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62206       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
62207       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
62208       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62209       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62210       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62211       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
62212     required:
62213     - model-element-uuid
62214     - new-data-del-flag
62215     - cardinality
62216     properties:
62217       model-element-uuid:
62218         type: string
62219       new-data-del-flag:
62220         type: string
62221         description: Indicates whether this element was created as part of instantiation from this model
62222       cardinality:
62223         type: string
62224         description: How many of this type of element are required/allowed
62225       linkage-points:
62226         type: string
62227   model-elements:
62228     properties:
62229       model-element:
62230         type: array
62231         items:
62232           $ref: "#/patchDefinitions/model-element"
62233   model-ver:
62234     description: |
62235       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
62236       ###### Related Nodes
62237       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
62238       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
62239       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
62240       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
62241       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
62242       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
62243       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
62244       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
62245       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
62246       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
62247       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
62248       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
62249     required:
62250     - model-version-id
62251     - model-name
62252     - model-version
62253     properties:
62254       model-version-id:
62255         type: string
62256         description: Unique identifier corresponding to one version of a model in ASDC
62257       model-name:
62258         type: string
62259         description: Name of the model, which can change from version to version.
62260       model-version:
62261         type: string
62262         description: Version
62263       distribution-status:
62264         type: string
62265         description: Distribution Status
62266       model-description:
62267         type: string
62268         description: Description
62269   model-vers:
62270     properties:
62271       model-ver:
62272         type: array
62273         items:
62274           $ref: "#/patchDefinitions/model-ver"
62275   models:
62276     description: |
62277       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
62278     properties:
62279       model:
62280         type: array
62281         items:
62282           $ref: "#/patchDefinitions/model"
62283   multicast-configuration:
62284     description: |
62285       ###### Related Nodes
62286       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
62287     required:
62288     - multicast-configuration-id
62289     - multicast-protocol
62290     - rp-type
62291     properties:
62292       multicast-configuration-id:
62293         type: string
62294         description: Unique id of multicast configuration.
62295       multicast-protocol:
62296         type: string
62297         description: protocol of multicast configuration
62298       rp-type:
62299         type: string
62300         description: rp type of multicast configuration
62301   multicast-configurations:
62302     description: |
62303       multicast configuration of generic-vnf ip-address
62304     properties:
62305       multicast-configuration:
62306         type: array
62307         items:
62308           $ref: "#/patchDefinitions/multicast-configuration"
62309   named-queries:
62310     properties:
62311       named-query:
62312         type: array
62313         items:
62314           $ref: "#/patchDefinitions/named-query"
62315   named-query:
62316     description: |
62317       TBD
62318       ###### Related Nodes
62319       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
62320       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
62321       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
62322       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
62323     required:
62324     - named-query-uuid
62325     - named-query-name
62326     - named-query-version
62327     properties:
62328       named-query-uuid:
62329         type: string
62330       named-query-name:
62331         type: string
62332       named-query-version:
62333         type: string
62334       required-input-param:
62335         type: string
62336       description:
62337         type: string
62338   named-query-element:
62339     description: |
62340       TBD
62341       ###### Related Nodes
62342       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
62343       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
62344       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62345       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62346       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62347       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62348       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
62349     required:
62350     - named-query-element-uuid
62351     properties:
62352       named-query-element-uuid:
62353         type: string
62354       property-collect-list:
62355         type: string
62356   named-query-elements:
62357     properties:
62358       named-query-element:
62359         type: array
62360         items:
62361           $ref: "#/patchDefinitions/named-query-element"
62362   network:
62363     description: |
62364       Namespace for network inventory resources.
62365     properties:
62366       logical-links:
62367         type: array
62368         items:
62369           $ref: "#/patchDefinitions/logical-link"
62370       site-pair-sets:
62371         type: array
62372         items:
62373           $ref: "#/patchDefinitions/site-pair-set"
62374       vpn-bindings:
62375         type: array
62376         items:
62377           $ref: "#/patchDefinitions/vpn-binding"
62378       vpls-pes:
62379         type: array
62380         items:
62381           $ref: "#/patchDefinitions/vpls-pe"
62382       multicast-configurations:
62383         type: array
62384         items:
62385           $ref: "#/patchDefinitions/multicast-configuration"
62386       vces:
62387         type: array
62388         items:
62389           $ref: "#/patchDefinitions/vce"
62390       vnfcs:
62391         type: array
62392         items:
62393           $ref: "#/patchDefinitions/vnfc"
62394       l3-networks:
62395         type: array
62396         items:
62397           $ref: "#/patchDefinitions/l3-network"
62398       network-policies:
62399         type: array
62400         items:
62401           $ref: "#/patchDefinitions/network-policy"
62402       generic-vnfs:
62403         type: array
62404         items:
62405           $ref: "#/patchDefinitions/generic-vnf"
62406       lag-links:
62407         type: array
62408         items:
62409           $ref: "#/patchDefinitions/lag-link"
62410       newvces:
62411         type: array
62412         items:
62413           $ref: "#/patchDefinitions/newvce"
62414       pnfs:
62415         type: array
62416         items:
62417           $ref: "#/patchDefinitions/pnf"
62418       physical-links:
62419         type: array
62420         items:
62421           $ref: "#/patchDefinitions/physical-link"
62422       ipsec-configurations:
62423         type: array
62424         items:
62425           $ref: "#/patchDefinitions/ipsec-configuration"
62426       route-table-references:
62427         type: array
62428         items:
62429           $ref: "#/patchDefinitions/route-table-reference"
62430       instance-groups:
62431         type: array
62432         items:
62433           $ref: "#/patchDefinitions/instance-group"
62434       zones:
62435         type: array
62436         items:
62437           $ref: "#/patchDefinitions/zone"
62438       configurations:
62439         type: array
62440         items:
62441           $ref: "#/patchDefinitions/configuration"
62442       forwarding-paths:
62443         type: array
62444         items:
62445           $ref: "#/patchDefinitions/forwarding-path"
62446   network-policies:
62447     properties:
62448       network-policy:
62449         type: array
62450         items:
62451           $ref: "#/patchDefinitions/network-policy"
62452   network-policy:
62453     description: |
62454       ###### Related Nodes
62455       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
62456       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
62457     required:
62458     - network-policy-id
62459     properties:
62460       network-policy-id:
62461         type: string
62462         description: UUID representing unique key to this instance
62463       network-policy-fqdn:
62464         type: string
62465         description: Contrail FQDN for the policy
62466       heat-stack-id:
62467         type: string
62468         description: ID for the openStack Heat instance
62469   network-profile:
62470     description: |
62471       Network profile populated by SDN-GP for SNMP
62472       ###### Related Nodes
62473       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
62474     required:
62475     - nm-profile-name
62476     properties:
62477       nm-profile-name:
62478         type: string
62479         description: Unique name of network profile.
62480       community-string:
62481         type: string
62482         description: Encrypted SNMP community string
62483   network-profiles:
62484     description: |
62485       Collection of network profiles
62486     properties:
62487       network-profile:
62488         type: array
62489         items:
62490           $ref: "#/patchDefinitions/network-profile"
62491   newvce:
62492     description: |
62493       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
62494       ###### Related Nodes
62495       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
62496       - NEWVCE is DELETED when these are DELETED L-INTERFACE
62497     required:
62498     - vnf-id2
62499     - vnf-name
62500     - vnf-type
62501     properties:
62502       vnf-id2:
62503         type: string
62504         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
62505       vnf-name:
62506         type: string
62507         description: Name of VNF.
62508       vnf-name2:
62509         type: string
62510         description: Alternate name of VNF.
62511       vnf-type:
62512         type: string
62513         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.
62514       prov-status:
62515         type: string
62516         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62517       operational-status:
62518         type: string
62519         description: Indicator for whether the resource is considered operational
62520       license-key:
62521         type: string
62522         description: OBSOLETE -  do not use
62523       ipv4-oam-address:
62524         type: string
62525         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).
62526       equipment-role:
62527         type: string
62528         description: Client should send valid enumerated value.
62529   newvces:
62530     description: |
62531       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
62532     properties:
62533       newvce:
62534         type: array
62535         items:
62536           $ref: "#/patchDefinitions/newvce"
62537   notification-event:
62538     properties:
62539       cambria.partition:
62540         type: string
62541       notification-event-header:
62542         type: object
62543         $ref: "#/patchDefinitions/notification-event-header"
62544   notification-event-header:
62545     properties:
62546       id:
62547         type: string
62548       timestamp:
62549         type: string
62550       source-name:
62551         type: string
62552       domain:
62553         type: string
62554       sequence-number:
62555         type: string
62556       severity:
62557         type: string
62558       event-type:
62559         type: string
62560       version:
62561         type: string
62562       action:
62563         type: string
62564       entity-type:
62565         type: string
62566       top-entity-type:
62567         type: string
62568       entity-link:
62569         type: string
62570       status:
62571         type: string
62572   notify:
62573     required:
62574     - event-id
62575     properties:
62576       event-id:
62577         type: string
62578       node-type:
62579         type: string
62580       event-trigger:
62581         type: string
62582       key-data:
62583         type: array
62584         items:
62585           $ref: "#/patchDefinitions/key-data"
62586       selflink:
62587         type: string
62588   oam-network:
62589     description: |
62590       OAM network, to be deprecated shortly.  Do not use for new purposes.
62591       ###### Related Nodes
62592       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62593       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
62594       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
62595     required:
62596     - network-uuid
62597     - network-name
62598     - cvlan-tag
62599     properties:
62600       network-uuid:
62601         type: string
62602         description: UUID of the network. Unique across a cloud-region
62603       network-name:
62604         type: string
62605         description: Name of the network.
62606       cvlan-tag:
62607         type: integer
62608         format: int64
62609         description: cvlan-id
62610       ipv4-oam-gateway-address:
62611         type: string
62612         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
62613       ipv4-oam-gateway-address-prefix-length:
62614         type: integer
62615         format: int32
62616         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
62617   oam-networks:
62618     description: |
62619       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
62620     properties:
62621       oam-network:
62622         type: array
62623         items:
62624           $ref: "#/patchDefinitions/oam-network"
62625   operational-environment:
62626     description: |
62627       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
62628       ###### Related Nodes
62629       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
62630       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
62631     required:
62632     - operational-environment-id
62633     - operational-environment-name
62634     - operational-environment-type
62635     - operational-environment-status
62636     - tenant-context
62637     - workload-context
62638     properties:
62639       operational-environment-id:
62640         type: string
62641         description: UUID of an operational environment
62642       operational-environment-name:
62643         type: string
62644         description: Operational Environment name
62645       operational-environment-type:
62646         type: string
62647         description: Operational Environment Type.
62648       operational-environment-status:
62649         type: string
62650         description: Status
62651       tenant-context:
62652         type: string
62653         description: Tenant Context.
62654       workload-context:
62655         type: string
62656         description: Workload Context.
62657   operational-environments:
62658     description: |
62659       a logical partition of the cloud which allows to have multiple environments in the production AIC.
62660     properties:
62661       operational-environment:
62662         type: array
62663         items:
62664           $ref: "#/patchDefinitions/operational-environment"
62665   overloaded-model:
62666     description: |
62667       Allows for legacy POST of old-style and new-style models
62668     required:
62669     - model-invariant-id
62670     - model-name-version-id
62671     - model-type
62672     - model-name
62673     - model-id
62674     - model-version
62675     properties:
62676       model-invariant-id:
62677         type: string
62678         description: Unique identifier corresponding to the main definition of a model in ASDC
62679       model-name-version-id:
62680         type: string
62681         description: Unique identifier corresponding to one version of a model in ASDC
62682       model-type:
62683         type: string
62684         description: Type of the model, e.g., service, resource, widget, etc.
62685       model-name:
62686         type: string
62687         description: Name of the model, which can change from version to version.
62688       model-id:
62689         type: string
62690         description: Invariant unique ID which does not change from version to version
62691       model-version:
62692         type: string
62693         description: Version
62694       model-description:
62695         type: string
62696         description: Description
62697   owning-entities:
62698     description: |
62699       Collection of owning-entities
62700     properties:
62701       owning-entity:
62702         type: array
62703         items:
62704           $ref: "#/patchDefinitions/owning-entity"
62705   owning-entity:
62706     description: |
62707       describes an owning-entity
62708       ###### Related Nodes
62709       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
62710     required:
62711     - owning-entity-id
62712     - owning-entity-name
62713     properties:
62714       owning-entity-id:
62715         type: string
62716         description: UUID of an owning entity
62717       owning-entity-name:
62718         type: string
62719         description: Owning entity name
62720   p-interface:
62721     description: |
62722       Physical interface (e.g., nic)
62723       ###### Related Nodes
62724       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
62725       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
62726       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
62727       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
62728       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62729       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
62730       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
62731       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
62732       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
62733       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
62734       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
62735     required:
62736     - interface-name
62737     - in-maint
62738     properties:
62739       interface-name:
62740         type: string
62741         description: Name that identifies the physical interface
62742       selflink:
62743         type: string
62744         description: URL to endpoint where AAI can get more details.
62745       speed-value:
62746         type: string
62747         description: Captures the numeric part of the speed
62748       speed-units:
62749         type: string
62750         description: Captures the units corresponding to the speed
62751       port-description:
62752         type: string
62753         description: Nature of the services and connectivity on this port.
62754       equipment-identifier:
62755         type: string
62756         description: CLEI or other specification for p-interface hardware.
62757       interface-role:
62758         type: string
62759         description: Role specification for p-interface hardware.
62760       interface-type:
62761         type: string
62762         description: Indicates the physical properties of the interface.
62763       prov-status:
62764         type: string
62765         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62766       mac-addresss:
62767         type: string
62768         description: MAC Address of the p-interface.
62769   p-interfaces:
62770     description: |
62771       Collection of physical interfaces.
62772     properties:
62773       p-interface:
62774         type: array
62775         items:
62776           $ref: "#/patchDefinitions/p-interface"
62777   physical-link:
62778     description: |
62779       Collection of physical connections, typically between p-interfaces
62780       ###### Related Nodes
62781       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
62782     required:
62783     - link-name
62784     properties:
62785       link-name:
62786         type: string
62787         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
62788       speed-value:
62789         type: string
62790         description: Captures the numeric part of the speed
62791       speed-units:
62792         type: string
62793         description: Captures the units corresponding to the speed
62794       circuit-id:
62795         type: string
62796         description: Circuit it
62797       dual-mode:
62798         type: string
62799         description: Dual access mode (e.g., primary, secondary
62800       management-option:
62801         type: string
62802         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
62803       service-provider-name:
62804         type: string
62805         description: Name of the service Provider on this link.
62806       service-provider-bandwidth-up-value:
62807         type: integer
62808         format: int32
62809         description: Upstream Bandwidth value agreed with the service provider
62810       service-provider-bandwidth-up-units:
62811         type: string
62812         description: Units for the upstream BW value
62813       service-provider-bandwidth-down-value:
62814         type: integer
62815         format: int32
62816         description: Downstream Bandwidth value agreed with the service provider
62817       service-provider-bandwidth-down-units:
62818         type: string
62819         description: Units for downstream BW value
62820   physical-links:
62821     description: |
62822       Collection of physical connections, typically between p-interfaces
62823     properties:
62824       physical-link:
62825         type: array
62826         items:
62827           $ref: "#/patchDefinitions/physical-link"
62828   platform:
62829     description: |
62830       describes a platform
62831       ###### Related Nodes
62832       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
62833     required:
62834     - platform-name
62835     properties:
62836       platform-name:
62837         type: string
62838         description: Name of the platform
62839   platforms:
62840     description: |
62841       Collection of platforms
62842     properties:
62843       platform:
62844         type: array
62845         items:
62846           $ref: "#/patchDefinitions/platform"
62847   pnf:
62848     description: |
62849       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.
62850       ###### Related Nodes
62851       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62852       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62853       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62854       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
62855       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
62856       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
62857       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
62858       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
62859       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
62860       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
62861       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62862     required:
62863     - pnf-name
62864     - in-maint
62865     properties:
62866       pnf-name:
62867         type: string
62868         description: unique name of Physical Network Function.
62869       pnf-name2:
62870         type: string
62871         description: name of Physical Network Function.
62872       selflink:
62873         type: string
62874         description: URL to endpoint where AAI can get more details.
62875       pnf-name2-source:
62876         type: string
62877         description: source of name2
62878       pnf-id:
62879         type: string
62880         description: id of pnf
62881       equip-type:
62882         type: string
62883         description: Equipment type.  Source of truth should define valid values.
62884       equip-vendor:
62885         type: string
62886         description: Equipment vendor.  Source of truth should define valid values.
62887       equip-model:
62888         type: string
62889         description: Equipment model.  Source of truth should define valid values.
62890       management-option:
62891         type: string
62892         description: identifier of managed by ATT or customer
62893       ipaddress-v4-oam:
62894         type: string
62895         description: ipv4-oam-address with new naming convention for IP addresses
62896       sw-version:
62897         type: string
62898         description: sw-version is the version of SW for the hosted application on the PNF.
62899       in-maint:
62900         type: boolean
62901       frame-id:
62902         type: string
62903         description: ID of the physical frame (relay rack) where pnf is installed.
62904       serial-number:
62905         type: string
62906         description: Serial number of the device
62907       ipaddress-v4-loopback-0:
62908         type: string
62909         description: IPV4 Loopback 0 address
62910       ipaddress-v6-loopback-0:
62911         type: string
62912         description: IPV6 Loopback 0 address
62913       ipaddress-v4-aim:
62914         type: string
62915         description: IPV4 AIM address
62916       ipaddress-v6-aim:
62917         type: string
62918         description: IPV6 AIM address
62919       ipaddress-v6-oam:
62920         type: string
62921         description: IPV6 OAM address
62922       inv-status:
62923         type: string
62924         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
62925   pnfs:
62926     description: |
62927       Collection of Physical Network Functions.
62928     properties:
62929       pnf:
62930         type: array
62931         items:
62932           $ref: "#/patchDefinitions/pnf"
62933   port-group:
62934     description: |
62935       Used to capture the network interfaces of this VCE
62936       ###### Related Nodes
62937       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62938       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
62939       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
62940     required:
62941     - interface-id
62942     - orchestration-status
62943     properties:
62944       interface-id:
62945         type: string
62946         description: Unique ID of the interface
62947       neutron-network-id:
62948         type: string
62949         description: Neutron network id of this Interface
62950       neutron-network-name:
62951         type: string
62952         description: Neutron network name of this Interface
62953       interface-role:
62954         type: string
62955         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
62956   port-groups:
62957     properties:
62958       port-group:
62959         type: array
62960         items:
62961           $ref: "#/patchDefinitions/port-group"
62962   project:
62963     description: |
62964       describes the project
62965       ###### Related Nodes
62966       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
62967     required:
62968     - project-name
62969     properties:
62970       project-name:
62971         type: string
62972         description: Name of the project deploying a service
62973   projects:
62974     description: |
62975       Collection of projects
62976     properties:
62977       project:
62978         type: array
62979         items:
62980           $ref: "#/patchDefinitions/project"
62981   properties:
62982     description: |
62983       Property holder for query properties or instance properties
62984     properties:
62985       property-name:
62986         type: string
62987       property-value:
62988         type: string
62989   property-constraint:
62990     description: |
62991       TBD
62992       ###### Related Nodes
62993       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62994     required:
62995     - property-constraint-uuid
62996     - constraint-type
62997     - property-name
62998     - property-value
62999     properties:
63000       property-constraint-uuid:
63001         type: string
63002       constraint-type:
63003         type: string
63004       property-name:
63005         type: string
63006       property-value:
63007         type: string
63008   property-constraints:
63009     properties:
63010       property-constraint:
63011         type: array
63012         items:
63013           $ref: "#/patchDefinitions/property-constraint"
63014   pserver:
63015     description: |
63016       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
63017       ###### Related Nodes
63018       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
63019       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
63020       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
63021       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63022       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63023       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
63024       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
63025       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
63026       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
63027       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
63028       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
63029       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
63030       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
63031     required:
63032     - hostname
63033     - in-maint
63034     properties:
63035       hostname:
63036         type: string
63037         description: Value from executing hostname on the compute node.
63038       ptnii-equip-name:
63039         type: string
63040         description: PTNII name
63041       number-of-cpus:
63042         type: integer
63043         format: int32
63044         description: Number of cpus
63045       disk-in-gigabytes:
63046         type: integer
63047         format: int32
63048         description: Disk size, in GBs
63049       ram-in-megabytes:
63050         type: integer
63051         format: int32
63052         description: RAM size, in MBs
63053       equip-type:
63054         type: string
63055         description: Equipment type.  Source of truth should define valid values.
63056       equip-vendor:
63057         type: string
63058         description: Equipment vendor.  Source of truth should define valid values.
63059       equip-model:
63060         type: string
63061         description: Equipment model.  Source of truth should define valid values.
63062       fqdn:
63063         type: string
63064         description: Fully-qualified domain name
63065       pserver-selflink:
63066         type: string
63067         description: URL to endpoint where AAI can get more details
63068       ipv4-oam-address:
63069         type: string
63070         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
63071       serial-number:
63072         type: string
63073         description: Serial number, may be queried
63074       ipaddress-v4-loopback-0:
63075         type: string
63076         description: IPV4 Loopback 0 address
63077       ipaddress-v6-loopback-0:
63078         type: string
63079         description: IPV6 Loopback 0 address
63080       ipaddress-v4-aim:
63081         type: string
63082         description: IPV4 AIM address
63083       ipaddress-v6-aim:
63084         type: string
63085         description: IPV6 AIM address
63086       ipaddress-v6-oam:
63087         type: string
63088         description: IPV6 OAM address
63089       inv-status:
63090         type: string
63091         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
63092       pserver-id:
63093         type: string
63094         description: ID of Pserver
63095       internet-topology:
63096         type: string
63097         description: internet topology of Pserver
63098       in-maint:
63099         type: boolean
63100   pservers:
63101     description: |
63102       Collection of compute hosts.
63103     properties:
63104       pserver:
63105         type: array
63106         items:
63107           $ref: "#/patchDefinitions/pserver"
63108   query-parameters:
63109     description: |
63110       QueryParameters for performing a named-query or model query
63111     properties:
63112       named-query:
63113         type: object
63114         $ref: "#/patchDefinitions/named-query"
63115       overloaded-model:
63116         type: object
63117         $ref: "#/patchDefinitions/overloaded-model"
63118   related-lookup:
63119     description: |
63120       TBD
63121       ###### Related Nodes
63122       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
63123     required:
63124     - related-lookup-uuid
63125     - source-node-type
63126     - source-node-property
63127     - target-node-type
63128     - target-node-property
63129     properties:
63130       related-lookup-uuid:
63131         type: string
63132       source-node-type:
63133         type: string
63134       source-node-property:
63135         type: string
63136       target-node-type:
63137         type: string
63138       target-node-property:
63139         type: string
63140       property-collect-list:
63141         type: string
63142   related-lookups:
63143     properties:
63144       related-lookup:
63145         type: array
63146         items:
63147           $ref: "#/patchDefinitions/related-lookup"
63148   related-to-property:
63149     properties:
63150       property-key:
63151         type: string
63152         description: Key part of a key/value pair
63153       property-value:
63154         type: string
63155         description: Value part of a key/value pair
63156   relationship:
63157     properties:
63158       related-to:
63159         type: string
63160         description: A keyword provided by A&AI to indicate type of node.
63161       relationship-label:
63162         type: string
63163         description: The edge label for this relationship.
63164       related-link:
63165         type: string
63166         description: URL to the object in A&AI.
63167       relationship-data:
63168         type: array
63169         items:
63170           $ref: "#/patchDefinitions/relationship-data"
63171       related-to-property:
63172         type: array
63173         items:
63174           $ref: "#/patchDefinitions/related-to-property"
63175   relationship-data:
63176     required:
63177     - relationship-key
63178     - relationship-value
63179     properties:
63180       relationship-key:
63181         type: string
63182         description: A keyword provided by A&AI to indicate an attribute.
63183       relationship-value:
63184         type: string
63185         description: Value of the attribute.
63186   reserved-prop-names:
63187     description: |
63188       Internal map to define some reserved properties of a vertex
63189     properties:
63190       last-mod-source-of-truth:
63191         type: string
63192       aai-node-type:
63193         type: string
63194       aai-created-ts:
63195         type: integer
63196         format: int64
63197       aai-unique-key:
63198         type: string
63199       aai-last-mod-ts:
63200         type: integer
63201         format: int64
63202       source-of-truth:
63203         type: string
63204       aai-uri:
63205         type: string
63206   response-list:
63207     description: |
63208       Response container for the results of a named-query or model query
63209     properties:
63210       inventory-response-items:
63211         type: object
63212         $ref: "#/patchDefinitions/inventory-response-items"
63213   result-data:
63214     properties:
63215       resource-type:
63216         type: string
63217         description: The specific type of node in the A&AI graph
63218       resource-link:
63219         type: string
63220         description: The URL to the specific resource
63221   route-table-reference:
63222     description: |
63223       Openstack route table reference.
63224       ###### Related Nodes
63225       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
63226     required:
63227     - route-table-reference-id
63228     - route-table-reference-fqdn
63229     properties:
63230       route-table-reference-id:
63231         type: string
63232         description: Route Table Reference id, UUID assigned to this instance.
63233       route-table-reference-fqdn:
63234         type: string
63235         description: FQDN entry in the route table.
63236   route-table-references:
63237     description: |
63238       Collection of openstack route table references
63239     properties:
63240       route-table-reference:
63241         type: array
63242         items:
63243           $ref: "#/patchDefinitions/route-table-reference"
63244   route-target:
63245     description: |
63246       Route target information
63247       ###### Related Nodes
63248       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
63249     required:
63250     - global-route-target
63251     - route-target-role
63252     properties:
63253       global-route-target:
63254         type: string
63255         description: Number used to identify an RT, globally unique in the network
63256       route-target-role:
63257         type: string
63258         description: Role assigned to this route target
63259   route-targets:
63260     description: |
63261       Collection of route target information
63262     properties:
63263       route-target:
63264         type: array
63265         items:
63266           $ref: "#/patchDefinitions/route-target"
63267   routing-instance:
63268     description: |
63269       ###### Related Nodes
63270       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
63271       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
63272       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
63273     required:
63274     - routing-instance-id
63275     properties:
63276       routing-instance-id:
63277         type: string
63278         description: Unique id of routing instance
63279       rpm-owner:
63280         type: string
63281         description: rpm owner
63282   routing-instances:
63283     description: |
63284       set of probes related to generic-vnf routing instance
63285     properties:
63286       routing-instance:
63287         type: array
63288         items:
63289           $ref: "#/patchDefinitions/routing-instance"
63290   sdn-zone-response:
63291     properties:
63292       oam-networks:
63293         type: object
63294         $ref: "#/patchDefinitions/oam-networks"
63295       az-and-dvs-switches:
63296         type: array
63297         items:
63298           $ref: "#/patchDefinitions/az-and-dvs-switches"
63299   search:
63300     properties:
63301       edge-tag-query-result:
63302         type: object
63303         $ref: "#/patchDefinitions/edge-tag-query-result"
63304       edge-tag-query-request:
63305         type: object
63306         $ref: "#/patchDefinitions/edge-tag-query-request"
63307       search-results:
63308         type: object
63309         $ref: "#/patchDefinitions/search-results"
63310       sdn-zone-response:
63311         type: object
63312         $ref: "#/patchDefinitions/sdn-zone-response"
63313   search-results:
63314     properties:
63315       result-data:
63316         type: array
63317         items:
63318           $ref: "#/patchDefinitions/result-data"
63319   secondary-filt:
63320     description: |
63321       SecondaryFilt for performing a named-query or model query
63322   secondary-filter:
63323     properties:
63324       property-name:
63325         type: string
63326       filter-type:
63327         type: string
63328       property-value:
63329         type: string
63330   secondary-filts:
63331     description: |
63332       SecondaryFilts for performing a named-query or model query
63333     properties:
63334       secondary-filt:
63335         type: array
63336         items:
63337           $ref: "#/patchDefinitions/secondary-filt"
63338   segmentation-assignment:
63339     description: |
63340       Openstack segmentation assignment.
63341       ###### Related Nodes
63342       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
63343     required:
63344     - segmentation-id
63345     properties:
63346       segmentation-id:
63347         type: string
63348         description: Route Table Reference id, UUID assigned to this instance.
63349   segmentation-assignments:
63350     description: |
63351       Collection of openstack segmentation assignments
63352     properties:
63353       segmentation-assignment:
63354         type: array
63355         items:
63356           $ref: "#/patchDefinitions/segmentation-assignment"
63357   service:
63358     description: |
63359       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
63360     required:
63361     - service-id
63362     - service-description
63363     properties:
63364       service-id:
63365         type: string
63366         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
63367       service-description:
63368         type: string
63369         description: Description of the service
63370       service-selflink:
63371         type: string
63372         description: URL to endpoint where AAI can get more details
63373   service-capabilities:
63374     description: |
63375       Collection of service capabilities.
63376     properties:
63377       service-capability:
63378         type: array
63379         items:
63380           $ref: "#/patchDefinitions/service-capability"
63381   service-capability:
63382     description: |
63383       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
63384       ###### Related Nodes
63385       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
63386       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
63387       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
63388     required:
63389     - service-type
63390     - vnf-type
63391     properties:
63392       service-type:
63393         type: string
63394         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
63395       vnf-type:
63396         type: string
63397         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.
63398   service-design-and-creation:
63399     description: |
63400       Namespace for objects managed by ASDC
63401     properties:
63402       vnf-images:
63403         type: array
63404         items:
63405           $ref: "#/patchDefinitions/vnf-image"
63406       services:
63407         type: array
63408         items:
63409           $ref: "#/patchDefinitions/service"
63410       service-capabilities:
63411         type: array
63412         items:
63413           $ref: "#/patchDefinitions/service-capability"
63414       models:
63415         type: array
63416         items:
63417           $ref: "#/patchDefinitions/model"
63418       named-queries:
63419         type: array
63420         items:
63421           $ref: "#/patchDefinitions/named-query"
63422   service-instance:
63423     description: |
63424       Instance of a service
63425       ###### Related Nodes
63426       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
63427       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
63428       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
63429       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
63430       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
63431       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
63432       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
63433       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
63434       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63435       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
63436       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
63437       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
63438       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
63439       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63440       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
63441       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
63442       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
63443       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
63444       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
63445       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
63446       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
63447       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
63448       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
63449       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
63450     required:
63451     - service-instance-id
63452     - service-type
63453     - service-role
63454     - created-at
63455     - updated-at
63456     - description
63457     properties:
63458       service-instance-id:
63459         type: string
63460         description: Uniquely identifies this instance of a service
63461       service-instance-name:
63462         type: string
63463         description: This field will store a name assigned to the service-instance.
63464       service-type:
63465         type: string
63466         description: String capturing type of service.
63467       service-role:
63468         type: string
63469         description: String capturing the service role.
63470       environment-context:
63471         type: string
63472         description: This field will store the environment context assigned to the service-instance.
63473       workload-context:
63474         type: string
63475         description: This field will store the workload context assigned to the service-instance.
63476       created-at:
63477         type: string
63478         description: create time of Network Service.
63479       updated-at:
63480         type: string
63481         description: last update of Network Service.
63482       description:
63483         type: string
63484         description: short description for service-instance.
63485       model-invariant-id:
63486         type: string
63487         description: the ASDC model id for this resource or service model.
63488       model-version-id:
63489         type: string
63490         description: the ASDC model version for this resource or service model.
63491       persona-model-version:
63492         type: string
63493         description: the ASDC model version for this resource or service model.
63494       widget-model-id:
63495         type: string
63496         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
63497       widget-model-version:
63498         type: string
63499         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
63500       bandwidth-total:
63501         type: string
63502         description: Indicates the total bandwidth to be used for this service.
63503       bandwidth-up-wan1:
63504         type: string
63505         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
63506       bandwidth-down-wan1:
63507         type: string
63508         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
63509       bandwidth-up-wan2:
63510         type: string
63511         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
63512       bandwidth-down-wan2:
63513         type: string
63514         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
63515       vhn-portal-url:
63516         type: string
63517         description: URL customers will use to access the vHN Portal.
63518       service-instance-location-id:
63519         type: string
63520         description: An identifier that customers assign to the location where this service is being used.
63521   service-instances:
63522     description: |
63523       Collection of service instances
63524     properties:
63525       service-instance:
63526         type: array
63527         items:
63528           $ref: "#/patchDefinitions/service-instance"
63529   service-subscription:
63530     description: |
63531       Object that group service instances.
63532       ###### Related Nodes
63533       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
63534       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
63535       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
63536       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
63537     required:
63538     - service-type
63539     properties:
63540       service-type:
63541         type: string
63542         description: Value defined by orchestration to identify this service across ECOMP.
63543       temp-ub-sub-account-id:
63544         type: string
63545         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
63546   service-subscriptions:
63547     description: |
63548       Collection of objects that group service instances.
63549     properties:
63550       service-subscription:
63551         type: array
63552         items:
63553           $ref: "#/patchDefinitions/service-subscription"
63554   services:
63555     description: |
63556       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
63557     properties:
63558       service:
63559         type: array
63560         items:
63561           $ref: "#/patchDefinitions/service"
63562   site-pair:
63563     description: |
63564       ###### Related Nodes
63565       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
63566       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
63567       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
63568     required:
63569     - site-pair-id
63570     properties:
63571       site-pair-id:
63572         type: string
63573         description: unique identifier of probe
63574       source-ip:
63575         type: string
63576         description: Prefix address
63577       destination-ip:
63578         type: string
63579         description: Prefix address
63580       ip-version:
63581         type: string
63582         description: ip version, v4, v6
63583       destination-hostname:
63584         type: string
63585         description: Hostname of the destination equipment to which SLAs are measured against.
63586       destination-equip-type:
63587         type: string
63588         description: The type of destinatination equipment. Could be Router, UCPE, etc.
63589   site-pair-set:
63590     description: |
63591       Set of instances for probes used to measure service level agreements
63592       ###### Related Nodes
63593       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
63594       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
63595       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
63596     required:
63597     - site-pair-set-id
63598     properties:
63599       site-pair-set-id:
63600         type: string
63601         description: Unique id of site pair set.
63602   site-pair-sets:
63603     description: |
63604       Collection of sets of instances for probes related to generic-vnf
63605     properties:
63606       site-pair-set:
63607         type: array
63608         items:
63609           $ref: "#/patchDefinitions/site-pair-set"
63610   site-pairs:
63611     description: |
63612       probe within a set
63613     properties:
63614       site-pair:
63615         type: array
63616         items:
63617           $ref: "#/patchDefinitions/site-pair"
63618   snapshot:
63619     description: |
63620       Openstack snapshot
63621       ###### Related Nodes
63622       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63623       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
63624     required:
63625     - snapshot-id
63626     properties:
63627       snapshot-id:
63628         type: string
63629         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
63630       snapshot-name:
63631         type: string
63632         description: Snapshot name
63633       snapshot-architecture:
63634         type: string
63635         description: Operating system architecture
63636       snapshot-os-distro:
63637         type: string
63638         description: The common name of the operating system distribution in lowercase
63639       snapshot-os-version:
63640         type: string
63641         description: The operating system version as specified by the distributor.
63642       application:
63643         type: string
63644         description: The application that the image instantiates.
63645       application-vendor:
63646         type: string
63647         description: The vendor of the application.
63648       application-version:
63649         type: string
63650         description: The version of the application.
63651       snapshot-selflink:
63652         type: string
63653         description: URL to endpoint where AAI can get more details
63654       prev-snapshot-id:
63655         type: string
63656         description: This field contains the UUID of the previous snapshot (if any).
63657   snapshots:
63658     description: |
63659       Collection of openstack snapshots
63660     properties:
63661       snapshot:
63662         type: array
63663         items:
63664           $ref: "#/patchDefinitions/snapshot"
63665   sriov-pf:
63666     description: |
63667       SR-IOV Physical Function
63668       ###### Related Nodes
63669       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
63670       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
63671     required:
63672     - pf-pci-id
63673     properties:
63674       pf-pci-id:
63675         type: string
63676         description: Identifier for the sriov-pf
63677   sriov-pfs:
63678     description: |
63679       Collection of SR-IOV Physical Functions.
63680     properties:
63681       sriov-pf:
63682         type: array
63683         items:
63684           $ref: "#/patchDefinitions/sriov-pf"
63685   sriov-vf:
63686     description: |
63687       SR-IOV Virtual Function (not to be confused with virtual network function)
63688       ###### Related Nodes
63689       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
63690       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
63691     required:
63692     - pci-id
63693     properties:
63694       pci-id:
63695         type: string
63696         description: PCI ID used to identify the sriov-vf
63697       vf-vlan-filter:
63698         type: string
63699         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
63700       vf-mac-filter:
63701         type: string
63702         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
63703       vf-vlan-strip:
63704         type: boolean
63705         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
63706       vf-vlan-anti-spoof-check:
63707         type: boolean
63708         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.
63709       vf-mac-anti-spoof-check:
63710         type: boolean
63711         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.
63712       vf-mirrors:
63713         type: string
63714         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
63715       vf-broadcast-allow:
63716         type: boolean
63717         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
63718       vf-unknown-multicast-allow:
63719         type: boolean
63720         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
63721       vf-unknown-unicast-allow:
63722         type: boolean
63723         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
63724       vf-insert-stag:
63725         type: boolean
63726         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
63727       vf-link-status:
63728         type: string
63729         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
63730   sriov-vfs:
63731     description: |
63732       Collection of SR-IOV Virtual Functions.
63733     properties:
63734       sriov-vf:
63735         type: array
63736         items:
63737           $ref: "#/patchDefinitions/sriov-vf"
63738   start-node-filter:
63739     properties:
63740       property-name:
63741         type: string
63742       property-value:
63743         type: string
63744   subnet:
63745     description: |
63746       ###### Related Nodes
63747       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
63748       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
63749       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
63750       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
63751       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
63752       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
63753       - 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
63754       - SUBNET is DELETED when these are DELETED HOST-ROUTE
63755     required:
63756     - subnet-id
63757     - dhcp-enabled
63758     properties:
63759       subnet-id:
63760         type: string
63761         description: Subnet ID, should be UUID.
63762       subnet-name:
63763         type: string
63764         description: Name associated with the subnet.
63765       neutron-subnet-id:
63766         type: string
63767         description: Neutron id of this subnet
63768       gateway-address:
63769         type: string
63770         description: gateway ip address
63771       network-start-address:
63772         type: string
63773         description: network start address
63774       cidr-mask:
63775         type: string
63776         description: cidr mask
63777       ip-version:
63778         type: string
63779         description: ip version
63780       orchestration-status:
63781         type: string
63782         description: Orchestration status of this VNF, mastered by MSO
63783       dhcp-enabled:
63784         type: boolean
63785       dhcp-start:
63786         type: string
63787         description: the start address reserved for use by dhcp
63788       dhcp-end:
63789         type: string
63790         description: the last address reserved for use by dhcp
63791       subnet-role:
63792         type: string
63793         description: role of the subnet, referenced when assigning IPs
63794       ip-assignment-direction:
63795         type: string
63796         description: ip address assignment direction of the subnet
63797   subnets:
63798     properties:
63799       subnet:
63800         type: array
63801         items:
63802           $ref: "#/patchDefinitions/subnet"
63803   tagged-inventory-item-list:
63804     properties:
63805       inventory-item:
63806         type: array
63807         items:
63808           $ref: "#/patchDefinitions/inventory-item"
63809   tenant:
63810     description: |
63811       Openstack tenant
63812       ###### Related Nodes
63813       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63814       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
63815       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
63816       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
63817       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
63818       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
63819       - TENANT cannot be deleted if linked to VSERVER
63820     required:
63821     - tenant-id
63822     - tenant-name
63823     properties:
63824       tenant-id:
63825         type: string
63826         description: Unique id relative to the cloud-region.
63827       tenant-name:
63828         type: string
63829         description: Readable name of tenant
63830       tenant-context:
63831         type: string
63832         description: This field will store the tenant context.
63833   tenants:
63834     description: |
63835       Collection of openstack tenants.
63836     properties:
63837       tenant:
63838         type: array
63839         items:
63840           $ref: "#/patchDefinitions/tenant"
63841   tunnel-xconnect:
63842     description: |
63843       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
63844       ###### Related Nodes
63845       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
63846     required:
63847     - id
63848     properties:
63849       id:
63850         type: string
63851         description: Allotted Resource id UUID assigned to this instance.
63852       bandwidth-up-wan1:
63853         type: string
63854         description: The WAN uplink bandwidth for WAN1
63855       bandwidth-down-wan1:
63856         type: string
63857         description: The WAN downlink bandwidth for WAN1
63858       bandwidth-up-wan2:
63859         type: string
63860         description: The WAN uplink bandwidth for WAN2
63861       bandwidth-down-wan2:
63862         type: string
63863         description: The WAN downlink bandwidth for WAN2
63864   tunnel-xconnects:
63865     description: |
63866       This object is used to store the specific tunnel cross connect aspects of an allotted resource
63867     properties:
63868       tunnel-xconnect:
63869         type: array
63870         items:
63871           $ref: "#/patchDefinitions/tunnel-xconnect"
63872   update:
63873     description: |
63874       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
63875     required:
63876     - update-node-type
63877     properties:
63878       update-node-type:
63879         type: string
63880       update-node-key:
63881         type: array
63882         items:
63883           $ref: "#/patchDefinitions/update-node-key"
63884       update-node-uri:
63885         type: string
63886       action:
63887         type: array
63888         items:
63889           $ref: "#/patchDefinitions/action"
63890   update-node-key:
63891     properties:
63892       key-name:
63893         type: string
63894       key-value:
63895         type: string
63896   vce:
63897     description: |
63898       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
63899       ###### Related Nodes
63900       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
63901       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
63902       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
63903       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63904       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63905       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63906       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
63907       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
63908     required:
63909     - vnf-id
63910     - vnf-name
63911     - vnf-type
63912     properties:
63913       vnf-id:
63914         type: string
63915         description: Unique id of VNF.  This is unique across the graph.
63916       vnf-name:
63917         type: string
63918         description: Name of VNF.
63919       vnf-name2:
63920         type: string
63921         description: Alternate name of VNF.
63922       vnf-type:
63923         type: string
63924         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.
63925       service-id:
63926         type: string
63927         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
63928       regional-resource-zone:
63929         type: string
63930         description: Regional way of organizing pservers, source of truth should define values
63931       prov-status:
63932         type: string
63933         description: Trigger for operational monitoring of this resource by Service Assurance systems.
63934       operational-status:
63935         type: string
63936         description: Indicator for whether the resource is considered operational
63937       license-key:
63938         type: string
63939         description: OBSOLETE -  do not use
63940       equipment-role:
63941         type: string
63942         description: Network role being played by this VNF
63943       orchestration-status:
63944         type: string
63945         description: Orchestration status of this VNF, mastered by MSO
63946       heat-stack-id:
63947         type: string
63948         description: Heat stack id corresponding to this instance, managed by MSO
63949       mso-catalog-key:
63950         type: string
63951         description: Corresponds to the SDN-C catalog id used to configure this VCE
63952       vpe-id:
63953         type: string
63954         description: Unique ID of VPE connected to this VCE.
63955       v6-vce-wan-address:
63956         type: string
63957         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
63958       ipv4-oam-address:
63959         type: string
63960         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
63961   vces:
63962     description: |
63963       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
63964     properties:
63965       vce:
63966         type: array
63967         items:
63968           $ref: "#/patchDefinitions/vce"
63969   vf-module:
63970     description: |
63971       a deployment unit of VNFCs
63972       ###### Related Nodes
63973       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63974       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
63975       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
63976       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
63977       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
63978       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
63979       - VF-MODULE cannot be deleted if linked to VNFC
63980     required:
63981     - vf-module-id
63982     - is-base-vf-module
63983     properties:
63984       vf-module-id:
63985         type: string
63986         description: Unique ID of vf-module.
63987       vf-module-name:
63988         type: string
63989         description: Name of vf-module
63990       heat-stack-id:
63991         type: string
63992         description: Heat stack id corresponding to this instance.
63993       orchestration-status:
63994         type: string
63995         description: orchestration status of this vf-module, mastered by MSO
63996       is-base-vf-module:
63997         type: boolean
63998   vf-modules:
63999     description: |
64000       Collection of vf-modules, a deployment unit of VNFCs
64001     properties:
64002       vf-module:
64003         type: array
64004         items:
64005           $ref: "#/patchDefinitions/vf-module"
64006   vig-server:
64007     description: |
64008       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
64009       ###### Related Nodes
64010       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
64011     required:
64012     - vig-address-type
64013     properties:
64014       vig-address-type:
64015         type: string
64016         description: indicates whether the VIG is for AVPN or INTERNET
64017       ipaddress-v4-vig:
64018         type: string
64019         description: v4 IP of the vig server
64020       ipaddress-v6-vig:
64021         type: string
64022         description: v6 IP of the vig server
64023   vig-servers:
64024     properties:
64025       vig-server:
64026         type: array
64027         items:
64028           $ref: "#/patchDefinitions/vig-server"
64029   vip-ipv4-address-list:
64030     description: |
64031       IPv4 Address Range
64032       ###### Related Nodes
64033       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64034       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64035       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
64036       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
64037     required:
64038     - vip-ipv4-address
64039     properties:
64040       vip-ipv4-address:
64041         type: string
64042         description: IP address
64043       vip-ipv4-prefix-length:
64044         type: integer
64045         format: int64
64046         description: Prefix length, 32 for single address
64047       vlan-id-inner:
64048         type: integer
64049         format: int64
64050         description: Inner VLAN tag
64051       vlan-id-outer:
64052         type: integer
64053         format: int64
64054         description: Outer VLAN tag
64055       is-floating:
64056         type: boolean
64057         description: Indicator of fixed or floating address
64058   vip-ipv6-address-list:
64059     description: |
64060       IPv6 Address Range
64061       ###### Related Nodes
64062       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64063       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64064       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
64065       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
64066     required:
64067     - vip-ipv6-address
64068     properties:
64069       vip-ipv6-address:
64070         type: string
64071         description: IP address
64072       vip-ipv6-prefix-length:
64073         type: integer
64074         format: int64
64075         description: Prefix length, 128 for single address
64076       vlan-id-inner:
64077         type: integer
64078         format: int64
64079         description: Inner VLAN tag
64080       vlan-id-outer:
64081         type: integer
64082         format: int64
64083         description: Outer VLAN tag
64084       is-floating:
64085         type: boolean
64086         description: Indicator of fixed or floating address
64087   virtual-data-center:
64088     description: |
64089       Virtual organization of cloud infrastructure elements in a data center context
64090       ###### Related Nodes
64091       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64092       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64093       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64094     required:
64095     - vdc-id
64096     - vdc-name
64097     properties:
64098       vdc-id:
64099         type: string
64100         description: Unique ID of the vdc
64101       vdc-name:
64102         type: string
64103         description: Name of the virtual data center
64104   virtual-data-centers:
64105     description: |
64106       Virtual organization of cloud infrastructure elements in a data center context
64107     properties:
64108       virtual-data-center:
64109         type: array
64110         items:
64111           $ref: "#/patchDefinitions/virtual-data-center"
64112   vlan:
64113     description: |
64114       Definition of vlan
64115       ###### Related Nodes
64116       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
64117       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64118       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
64119       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
64120       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
64121       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
64122       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
64123       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
64124       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
64125     required:
64126     - vlan-interface
64127     - in-maint
64128     - is-ip-unnumbered
64129     properties:
64130       vlan-interface:
64131         type: string
64132         description: String that identifies the interface
64133       vlan-id-inner:
64134         type: integer
64135         format: int64
64136         description: Inner VLAN tag
64137       vlan-id-outer:
64138         type: integer
64139         format: int64
64140         description: Outer VLAN tag
64141   vlans:
64142     properties:
64143       vlan:
64144         type: array
64145         items:
64146           $ref: "#/patchDefinitions/vlan"
64147   vnf:
64148     description: |
64149       Abstract vnf class
64150     required:
64151     - vnf-id
64152     properties:
64153       vnf-id:
64154         type: string
64155         description: Unique id of VNF.  This is unique across the graph.
64156   vnf-image:
64157     description: |
64158       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
64159       ###### Related Nodes
64160       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
64161       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
64162     required:
64163     - vnf-image-uuid
64164     - application
64165     - application-vendor
64166     properties:
64167       vnf-image-uuid:
64168         type: string
64169         description: Unique ID of this asset
64170       application:
64171         type: string
64172         description: The application that the image instantiates.
64173       application-vendor:
64174         type: string
64175         description: The vendor of the application.
64176       application-version:
64177         type: string
64178         description: The version of the application.
64179       selflink:
64180         type: string
64181         description: URL to endpoint where AAI can get more details
64182   vnf-images:
64183     description: |
64184       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
64185     properties:
64186       vnf-image:
64187         type: array
64188         items:
64189           $ref: "#/patchDefinitions/vnf-image"
64190   vnfc:
64191     description: |
64192       ###### Related Nodes
64193       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64194       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64195       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
64196       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
64197       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
64198       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
64199       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
64200       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
64201       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
64202     required:
64203     - vnfc-name
64204     - nfc-naming-code
64205     - nfc-function
64206     - in-maint
64207     - is-closed-loop-disabled
64208     properties:
64209       vnfc-name:
64210         type: string
64211         description: Unique ID of vnfc.
64212       nfc-naming-code:
64213         type: string
64214         description: Short code that is used in naming instances of the item being modeled
64215       nfc-function:
64216         type: string
64217         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
64218       prov-status:
64219         type: string
64220         description: prov status of this vnfc
64221       orchestration-status:
64222         type: string
64223         description: Orchestration status of this VNF, mastered by APP-C
64224       ipaddress-v4-oam-vip:
64225         type: string
64226         description: Oam V4 vip address of this vnfc
64227       in-maint:
64228         type: boolean
64229       is-closed-loop-disabled:
64230         type: boolean
64231       group-notation:
64232         type: string
64233         description: Group notation of VNFC
64234       model-invariant-id:
64235         type: string
64236         description: the ASDC model id for this resource or service model.
64237       model-version-id:
64238         type: string
64239         description: the ASDC model version for this resource or service model.
64240   vnfcs:
64241     description: |
64242       virtual network components associated with a vserver from application controller.
64243     properties:
64244       vnfc:
64245         type: array
64246         items:
64247           $ref: "#/patchDefinitions/vnfc"
64248   volume:
64249     description: |
64250       Ephemeral Block storage volume.
64251       ###### Related Nodes
64252       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
64253     required:
64254     - volume-id
64255     - volume-selflink
64256     properties:
64257       volume-id:
64258         type: string
64259         description: Unique ID of block storage volume relative to the vserver.
64260       volume-selflink:
64261         type: string
64262         description: URL to endpoint where AAI can get more details
64263   volume-group:
64264     description: |
64265       Persistent block-level storage.
64266       ###### Related Nodes
64267       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64268       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64269       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
64270       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
64271       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
64272     required:
64273     - volume-group-id
64274     - volume-group-name
64275     - vnf-type
64276     properties:
64277       volume-group-id:
64278         type: string
64279         description: Unique ID of volume-group.
64280       volume-group-name:
64281         type: string
64282         description: Name of the volume group.
64283       heat-stack-id:
64284         type: string
64285         description: Heat stack id corresponding to this volume-group
64286       vnf-type:
64287         type: string
64288         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.
64289       orchestration-status:
64290         type: string
64291         description: Orchestration status of this volume-group
64292       model-customization-id:
64293         type: string
64294         description: captures the id of all the configuration used to customize the resource for the service.
64295       vf-module-model-customization-id:
64296         type: string
64297         description: helps relate the volume group to the vf-module whose components will require the volume group
64298   volume-groups:
64299     description: |
64300       Collection of persistent block-level storage.
64301     properties:
64302       volume-group:
64303         type: array
64304         items:
64305           $ref: "#/patchDefinitions/volume-group"
64306   volumes:
64307     description: |
64308       Collection of ephemeral Block storage volumes.
64309     properties:
64310       volume:
64311         type: array
64312         items:
64313           $ref: "#/patchDefinitions/volume"
64314   vpls-pe:
64315     description: |
64316       VPLS Provider Edge routers.
64317       ###### Related Nodes
64318       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64319       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
64320       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
64321       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
64322       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
64323     required:
64324     - equipment-name
64325     properties:
64326       equipment-name:
64327         type: string
64328       prov-status:
64329         type: string
64330         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
64331       ipv4-oam-address:
64332         type: string
64333         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).
64334       equipment-role:
64335         type: string
64336         description: Client should send valid enumerated value, e.g., VPLS-PE.
64337       vlan-id-outer:
64338         type: integer
64339         format: int64
64340         description: Temporary location for stag to get to VCE
64341   vpls-pes:
64342     description: |
64343       Collection of VPLS Provider Edge routers
64344     properties:
64345       vpls-pe:
64346         type: array
64347         items:
64348           $ref: "#/patchDefinitions/vpls-pe"
64349   vpn-binding:
64350     description: |
64351       VPN binding
64352       ###### Related Nodes
64353       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
64354       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
64355       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
64356       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
64357       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
64358       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
64359     required:
64360     - vpn-id
64361     - vpn-name
64362     properties:
64363       vpn-id:
64364         type: string
64365         description: VPN ID, globally unique within A&AI
64366       vpn-name:
64367         type: string
64368         description: VPN Name
64369       vpn-platform:
64370         type: string
64371         description: the platform associated with the VPN example AVPN, Mobility
64372       vpn-type:
64373         type: string
64374         description: Type of the vpn, should be taken from enumerated/valid values
64375       vpn-region:
64376         type: string
64377         description: region of customer vpn
64378       customer-vpn-id:
64379         type: string
64380         description: id for this customer vpn
64381       route-distinguisher:
64382         type: string
64383         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
64384   vpn-bindings:
64385     properties:
64386       vpn-binding:
64387         type: array
64388         items:
64389           $ref: "#/patchDefinitions/vpn-binding"
64390   vserver:
64391     description: |
64392       Virtual Servers, aka virtual machine or VM.
64393       ###### Related Nodes
64394       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
64395       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
64396       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
64397       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
64398       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
64399       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
64400       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
64401       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
64402       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
64403       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
64404       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
64405       - VSERVER is DELETED when these are DELETED L-INTERFACE
64406       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
64407     required:
64408     - vserver-id
64409     - vserver-name
64410     - vserver-selflink
64411     - in-maint
64412     - is-closed-loop-disabled
64413     properties:
64414       vserver-id:
64415         type: string
64416         description: Unique identifier for this vserver relative to its tenant
64417       vserver-name:
64418         type: string
64419         description: Name of vserver
64420       vserver-name2:
64421         type: string
64422         description: Alternative name of vserver
64423       prov-status:
64424         type: string
64425         description: Trigger for operational monitoring of this resource by Service Assurance systems.
64426       vserver-selflink:
64427         type: string
64428         description: URL to endpoint where AAI can get more details
64429       in-maint:
64430         type: boolean
64431       is-closed-loop-disabled:
64432         type: boolean
64433   vservers:
64434     description: |
64435       Collection of virtual Servers, aka virtual machines or VMs.
64436     properties:
64437       vserver:
64438         type: array
64439         items:
64440           $ref: "#/patchDefinitions/vserver"
64441   zone:
64442     description: |
64443       A zone is a grouping of assets in a location homing to the same connections into the CBB
64444       ###### Related Nodes
64445       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64446       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64447       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64448       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64449       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64450     required:
64451     - zone-id
64452     - zone-name
64453     - design-type
64454     - zone-context
64455     properties:
64456       zone-id:
64457         type: string
64458         description: Code assigned by AIC to the zone
64459       zone-name:
64460         type: string
64461         description: English name associated with the zone
64462       design-type:
64463         type: string
64464         description: Design of zone [Medium/Large…]
64465       zone-context:
64466         type: string
64467         description: Context of zone [production/test]
64468       status:
64469         type: string
64470         description: Status of a zone.
64471   zones:
64472     description: |
64473       Collection of zones
64474     properties:
64475       zone:
64476         type: array
64477         items:
64478           $ref: "#/patchDefinitions/zone"
64479 getDefinitions:
64480   aai-internal:
64481     properties:
64482       property-name:
64483         type: string
64484       property-value:
64485         type: string
64486   action:
64487     properties:
64488       action-type:
64489         type: string
64490       action-data:
64491         type: array
64492         items:
64493           $ref: "#/getDefinitions/action-data"
64494   action-data:
64495     properties:
64496       property-name:
64497         type: string
64498       property-value:
64499         type: string
64500   actions:
64501     description: |
64502       APIs that are more action related than REST (e.g., notify, update).
64503     properties:
64504       update:
64505         type: object
64506         $ref: "#/getDefinitions/update"
64507       notify:
64508         type: object
64509         $ref: "#/getDefinitions/notify"
64510   allotted-resource:
64511     description: |
64512       Represents a slice or partial piece of a resource that gets separately allotted
64513       ###### Related Nodes
64514       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
64515       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
64516       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64517       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
64518       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
64519       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
64520       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
64521       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
64522       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
64523       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
64524       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
64525       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
64526       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
64527       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
64528       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
64529     required:
64530     - id
64531     properties:
64532       id:
64533         type: string
64534         description: Allotted Resource id UUID assigned to this instance.
64535       description:
64536         type: string
64537         description: The descriptive information assigned to this allotted resource instance
64538       selflink:
64539         type: string
64540         description: Link back to more information in the controller
64541       model-invariant-id:
64542         type: string
64543         description: the ASDC model id for this resource or service model.
64544       model-version-id:
64545         type: string
64546         description: the ASDC model version for this resource or service model.
64547       persona-model-version:
64548         type: string
64549         description: the ASDC model version for this resource or service model.
64550       resource-version:
64551         type: string
64552         description: Concurrency value
64553       orchestration-status:
64554         type: string
64555         description: Orchestration status
64556       operational-status:
64557         type: string
64558         description: Indicator for whether the resource is considered operational
64559       type:
64560         type: string
64561         description: Generic description of the type of allotted resource.
64562       role:
64563         type: string
64564         description: role in the network that this resource will be providing.
64565       tunnel-xconnects:
64566         type: array
64567         items:
64568           $ref: "#/getDefinitions/tunnel-xconnect"
64569       relationship-list:
64570         type: array
64571         items:
64572           $ref: "#/getDefinitions/relationship"
64573   allotted-resources:
64574     description: |
64575       This object is used to store slices of services being offered
64576     properties:
64577       allotted-resource:
64578         type: array
64579         items:
64580           $ref: "#/getDefinitions/allotted-resource"
64581   availability-zone:
64582     description: |
64583       Availability zone, a collection of compute hosts/pservers
64584       ###### Related Nodes
64585       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64586       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
64587       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64588       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
64589       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
64590       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
64591       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
64592       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
64593       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
64594     required:
64595     - availability-zone-name
64596     - hypervisor-type
64597     properties:
64598       availability-zone-name:
64599         type: string
64600         description: Name of the availability zone.  Unique across a cloud region
64601       hypervisor-type:
64602         type: string
64603         description: Type of hypervisor.  Source of truth should define valid values.
64604       operational-status:
64605         type: string
64606         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
64607       resource-version:
64608         type: string
64609         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64610       relationship-list:
64611         type: array
64612         items:
64613           $ref: "#/getDefinitions/relationship"
64614   availability-zones:
64615     description: |
64616       Collection of availability zones
64617     properties:
64618       availability-zone:
64619         type: array
64620         items:
64621           $ref: "#/getDefinitions/availability-zone"
64622   az-and-dvs-switches:
64623     properties:
64624       dvs-switches:
64625         type: object
64626         $ref: "#/getDefinitions/dvs-switches"
64627       availability-zone:
64628         type: object
64629         $ref: "#/getDefinitions/availability-zone"
64630   business:
64631     description: |
64632       Namespace for business related constructs
64633     properties:
64634       connectors:
64635         type: array
64636         items:
64637           $ref: "#/getDefinitions/connector"
64638       customers:
64639         type: array
64640         items:
64641           $ref: "#/getDefinitions/customer"
64642       lines-of-business:
64643         type: array
64644         items:
64645           $ref: "#/getDefinitions/line-of-business"
64646       owning-entities:
64647         type: array
64648         items:
64649           $ref: "#/getDefinitions/owning-entity"
64650       platforms:
64651         type: array
64652         items:
64653           $ref: "#/getDefinitions/platform"
64654       projects:
64655         type: array
64656         items:
64657           $ref: "#/getDefinitions/project"
64658   class-of-service:
64659     description: |
64660       ###### Related Nodes
64661       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
64662     required:
64663     - cos
64664     properties:
64665       cos:
64666         type: string
64667         description: unique identifier of probe
64668       probe-id:
64669         type: string
64670         description: identifier of probe
64671       probe-type:
64672         type: string
64673         description: type of probe
64674       resource-version:
64675         type: string
64676         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64677       relationship-list:
64678         type: array
64679         items:
64680           $ref: "#/getDefinitions/relationship"
64681   classes-of-service:
64682     description: |
64683       class-of-service of probe
64684     properties:
64685       class-of-service:
64686         type: array
64687         items:
64688           $ref: "#/getDefinitions/class-of-service"
64689   cloud-infrastructure:
64690     description: |
64691       Namespace for cloud infrastructure.
64692     properties:
64693       complexes:
64694         type: array
64695         items:
64696           $ref: "#/getDefinitions/complex"
64697       cloud-regions:
64698         type: array
64699         items:
64700           $ref: "#/getDefinitions/cloud-region"
64701       network-profiles:
64702         type: array
64703         items:
64704           $ref: "#/getDefinitions/network-profile"
64705       pservers:
64706         type: array
64707         items:
64708           $ref: "#/getDefinitions/pserver"
64709       virtual-data-centers:
64710         type: array
64711         items:
64712           $ref: "#/getDefinitions/virtual-data-center"
64713       operational-environments:
64714         type: array
64715         items:
64716           $ref: "#/getDefinitions/operational-environment"
64717   cloud-region:
64718     description: |
64719       cloud-region designates an installation of a cloud cluster or region or instantiation.
64720       ###### Related Nodes
64721       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
64722       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64723       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64724       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64725       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64726       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64727       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64728       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64729       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64730       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64731       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64732       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64733       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64734       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64735       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64736       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64737       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
64738       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
64739       - 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
64740       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
64741       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
64742     required:
64743     - cloud-owner
64744     - cloud-region-id
64745     - sriov-automation
64746     properties:
64747       cloud-owner:
64748         type: string
64749         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
64750       cloud-region-id:
64751         type: string
64752         description: Identifier used by the vendor for the region. Second part of composite key
64753       cloud-type:
64754         type: string
64755         description: Type of the cloud (e.g., openstack)
64756       owner-defined-type:
64757         type: string
64758         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
64759       cloud-region-version:
64760         type: string
64761         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
64762       identity-url:
64763         type: string
64764         description: URL of the keystone identity service
64765       cloud-zone:
64766         type: string
64767         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
64768       complex-name:
64769         type: string
64770         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
64771       sriov-automation:
64772         type: boolean
64773       cloud-extra-info:
64774         type: string
64775         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
64776       cloud-epa-caps:
64777         type: string
64778         description: MultiVIM will discover and expose EPA capabilities.
64779       resource-version:
64780         type: string
64781         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64782       volume-groups:
64783         type: array
64784         items:
64785           $ref: "#/getDefinitions/volume-group"
64786       tenants:
64787         type: array
64788         items:
64789           $ref: "#/getDefinitions/tenant"
64790       flavors:
64791         type: array
64792         items:
64793           $ref: "#/getDefinitions/flavor"
64794       group-assignments:
64795         type: array
64796         items:
64797           $ref: "#/getDefinitions/group-assignment"
64798       snapshots:
64799         type: array
64800         items:
64801           $ref: "#/getDefinitions/snapshot"
64802       images:
64803         type: array
64804         items:
64805           $ref: "#/getDefinitions/image"
64806       dvs-switches:
64807         type: array
64808         items:
64809           $ref: "#/getDefinitions/dvs-switch"
64810       oam-networks:
64811         type: array
64812         items:
64813           $ref: "#/getDefinitions/oam-network"
64814       availability-zones:
64815         type: array
64816         items:
64817           $ref: "#/getDefinitions/availability-zone"
64818       relationship-list:
64819         type: array
64820         items:
64821           $ref: "#/getDefinitions/relationship"
64822       vip-ipv4-address-list:
64823         type: array
64824         items:
64825           $ref: "#/getDefinitions/vip-ipv4-address-list"
64826       vip-ipv6-address-list:
64827         type: array
64828         items:
64829           $ref: "#/getDefinitions/vip-ipv6-address-list"
64830       hpa-capabilities:
64831         type: array
64832         items:
64833           $ref: "#/getDefinitions/hpa-capability"
64834         description: List of cloud-region specific HPA Capabilities
64835   cloud-regions:
64836     properties:
64837       cloud-region:
64838         type: array
64839         items:
64840           $ref: "#/getDefinitions/cloud-region"
64841   complex:
64842     description: |
64843       Collection of physical locations that can house cloud-regions.
64844       ###### Related Nodes
64845       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64846       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64847       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64848       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
64849       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
64850       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
64851       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64852       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64853       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
64854       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64855       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64856       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64857       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
64858       - COMPLEX is DELETED when these are DELETED CTAG-POOL
64859     required:
64860     - physical-location-id
64861     - physical-location-type
64862     - street1
64863     - city
64864     - postal-code
64865     - country
64866     - region
64867     properties:
64868       physical-location-id:
64869         type: string
64870         description: Unique identifier for physical location, e.g., CLLI
64871       data-center-code:
64872         type: string
64873         description: Data center code which can be an alternate way to identify a complex
64874       complex-name:
64875         type: string
64876         description: Gamma complex name for LCP instance.
64877       identity-url:
64878         type: string
64879         description: URL of the keystone identity service
64880       resource-version:
64881         type: string
64882         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64883       physical-location-type:
64884         type: string
64885         description: Type, e.g., central office, data center.
64886       street1:
64887         type: string
64888       street2:
64889         type: string
64890       city:
64891         type: string
64892       state:
64893         type: string
64894       postal-code:
64895         type: string
64896       country:
64897         type: string
64898       region:
64899         type: string
64900       latitude:
64901         type: string
64902       longitude:
64903         type: string
64904       elevation:
64905         type: string
64906       lata:
64907         type: string
64908       ctag-pools:
64909         type: array
64910         items:
64911           $ref: "#/getDefinitions/ctag-pool"
64912       relationship-list:
64913         type: array
64914         items:
64915           $ref: "#/getDefinitions/relationship"
64916   complexes:
64917     description: |
64918       Collection of physical locations that can house cloud-regions.
64919     properties:
64920       complex:
64921         type: array
64922         items:
64923           $ref: "#/getDefinitions/complex"
64924   configuration:
64925     description: |
64926       Port Mirror Configuration.
64927       ###### Related Nodes
64928       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
64929       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
64930       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
64931       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
64932       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
64933       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
64934       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
64935       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
64936       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
64937       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
64938       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
64939       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
64940       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
64941     required:
64942     - configuration-id
64943     - configuration-type
64944     - configuration-sub-type
64945     - orchestration-status
64946     - operational-status
64947     - configuration-selflink
64948     - model-customization-id
64949     properties:
64950       configuration-id:
64951         type: string
64952         description: UUID assigned to configuration.
64953       management-option:
64954         type: string
64955         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
64956       configuration-name:
64957         type: string
64958         description: Name of the configuration.
64959       configuration-type:
64960         type: string
64961         description: port-mirroring-configuration.
64962       configuration-sub-type:
64963         type: string
64964         description: vprobe, pprobe.
64965       model-invariant-id:
64966         type: string
64967         description: the ASDC model id for this resource or service model.
64968       model-version-id:
64969         type: string
64970         description: the ASDC model version for this resource or service model.
64971       orchestration-status:
64972         type: string
64973         description: Orchestration status of the configuration.
64974       operational-status:
64975         type: string
64976         description: Indicator for whether the resource is considered operational.
64977       configuration-selflink:
64978         type: string
64979         description: URL to endpoint where AAI can get more details from SDN-GC.
64980       model-customization-id:
64981         type: string
64982         description: id of  the configuration used to customize the resource
64983       tunnel-bandwidth:
64984         type: string
64985         description: DHV Site Effective Bandwidth
64986       vendor-allowed-max-bandwidth:
64987         type: string
64988         description: Velocloud Nominal Throughput - VNT
64989       resource-version:
64990         type: string
64991         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64992       relationship-list:
64993         type: array
64994         items:
64995           $ref: "#/getDefinitions/relationship"
64996       metadata:
64997         type: array
64998         items:
64999           $ref: "#/getDefinitions/metadatum"
65000       forwarder-evcs:
65001         type: array
65002         items:
65003           $ref: "#/getDefinitions/forwarder-evc"
65004       evcs:
65005         type: array
65006         items:
65007           $ref: "#/getDefinitions/evc"
65008   configurations:
65009     description: |
65010       Collection of configurations
65011     properties:
65012       configuration:
65013         type: array
65014         items:
65015           $ref: "#/getDefinitions/configuration"
65016   connector:
65017     description: |
65018       Collection of resource instances used to connect a variety of disparate inventory widgets
65019       ###### Related Nodes
65020       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
65021       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
65022       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
65023       - CONNECTOR is DELETED when these are DELETED METADATUM
65024     required:
65025     - resource-instance-id
65026     properties:
65027       resource-instance-id:
65028         type: string
65029         description: Unique id of resource instance.
65030       resource-version:
65031         type: string
65032         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65033       model-invariant-id:
65034         type: string
65035         description: the ASDC model id for this resource or service model.
65036       model-version-id:
65037         type: string
65038         description: the ASDC model version for this resource or service model.
65039       persona-model-version:
65040         type: string
65041         description: the ASDC model version for this resource or service model.
65042       widget-model-id:
65043         type: string
65044         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
65045       widget-model-version:
65046         type: string
65047         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
65048       relationship-list:
65049         type: array
65050         items:
65051           $ref: "#/getDefinitions/relationship"
65052       metadata:
65053         type: array
65054         items:
65055           $ref: "#/getDefinitions/metadatum"
65056   connectors:
65057     description: |
65058       Collection of resource instances used to connect a variety of disparate inventory widgets
65059     properties:
65060       connector:
65061         type: array
65062         items:
65063           $ref: "#/getDefinitions/connector"
65064   constrained-element-set:
65065     description: |
65066       This is how we would capture constraints defining allowed sets of elements.
65067       ###### Related Nodes
65068       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
65069       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
65070       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
65071       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
65072     required:
65073     - constrained-element-set-uuid
65074     - constraint-type
65075     - check-type
65076     properties:
65077       constrained-element-set-uuid:
65078         type: string
65079       constraint-type:
65080         type: string
65081       check-type:
65082         type: string
65083       resource-version:
65084         type: string
65085       element-choice-sets:
65086         type: array
65087         items:
65088           $ref: "#/getDefinitions/element-choice-set"
65089       relationship-list:
65090         type: array
65091         items:
65092           $ref: "#/getDefinitions/relationship"
65093   constrained-element-sets:
65094     properties:
65095       constrained-element-set:
65096         type: array
65097         items:
65098           $ref: "#/getDefinitions/constrained-element-set"
65099   ctag-assignment:
65100     description: |
65101       ###### Related Nodes
65102       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
65103       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
65104     required:
65105     - vlan-id-inner
65106     properties:
65107       vlan-id-inner:
65108         type: integer
65109         format: int64
65110         description: id.
65111       resource-version:
65112         type: string
65113         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65114       relationship-list:
65115         type: array
65116         items:
65117           $ref: "#/getDefinitions/relationship"
65118   ctag-assignments:
65119     properties:
65120       ctag-assignment:
65121         type: array
65122         items:
65123           $ref: "#/getDefinitions/ctag-assignment"
65124   ctag-pool:
65125     description: |
65126       A collection of C tags (vlan tags) grouped for a specific purpose.
65127       ###### Related Nodes
65128       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
65129       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
65130       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
65131       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
65132     required:
65133     - target-pe
65134     - availability-zone-name
65135     - ctag-pool-purpose
65136     properties:
65137       target-pe:
65138         type: string
65139         description: The Target provider edge router
65140       availability-zone-name:
65141         type: string
65142         description: Name of the availability zone
65143       ctag-pool-purpose:
65144         type: string
65145         description: Describes what the intended purpose of this pool is.
65146       ctag-values:
65147         type: string
65148         description: Comma separated list of ctags
65149       resource-version:
65150         type: string
65151         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65152       relationship-list:
65153         type: array
65154         items:
65155           $ref: "#/getDefinitions/relationship"
65156   ctag-pools:
65157     properties:
65158       ctag-pool:
65159         type: array
65160         items:
65161           $ref: "#/getDefinitions/ctag-pool"
65162   customer:
65163     description: |
65164       customer identifiers to provide linkage back to BSS information.
65165       ###### Related Nodes
65166       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
65167       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
65168     required:
65169     - global-customer-id
65170     - subscriber-name
65171     - subscriber-type
65172     properties:
65173       global-customer-id:
65174         type: string
65175         description: Global customer id used across ECOMP to uniquely identify customer.
65176       subscriber-name:
65177         type: string
65178         description: Subscriber name, an alternate way to retrieve a customer.
65179       subscriber-type:
65180         type: string
65181         description: Subscriber type, a way to provide VID with only the INFRA customers.
65182       resource-version:
65183         type: string
65184         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65185       service-subscriptions:
65186         type: array
65187         items:
65188           $ref: "#/getDefinitions/service-subscription"
65189       relationship-list:
65190         type: array
65191         items:
65192           $ref: "#/getDefinitions/relationship"
65193   customers:
65194     description: |
65195       Collection of customer identifiers to provide linkage back to BSS information.
65196     properties:
65197       customer:
65198         type: array
65199         items:
65200           $ref: "#/getDefinitions/customer"
65201   cvlan-tag-entry:
65202     required:
65203     - cvlan-tag
65204     properties:
65205       cvlan-tag:
65206         type: integer
65207         format: int64
65208         description: See mis-na-virtualization-platform.yang
65209       resource-version:
65210         type: string
65211         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65212       relationship-list:
65213         type: array
65214         items:
65215           $ref: "#/getDefinitions/relationship"
65216   cvlan-tags:
65217     properties:
65218       cvlan-tag-entry:
65219         type: array
65220         items:
65221           $ref: "#/getDefinitions/cvlan-tag-entry"
65222   dvs-switch:
65223     description: |
65224       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.
65225       ###### Related Nodes
65226       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65227       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
65228     required:
65229     - switch-name
65230     - vcenter-url
65231     properties:
65232       switch-name:
65233         type: string
65234         description: DVS switch name
65235       vcenter-url:
65236         type: string
65237         description: URL used to reach the vcenter
65238       resource-version:
65239         type: string
65240         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65241       relationship-list:
65242         type: array
65243         items:
65244           $ref: "#/getDefinitions/relationship"
65245   dvs-switches:
65246     description: |
65247       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
65248     properties:
65249       dvs-switch:
65250         type: array
65251         items:
65252           $ref: "#/getDefinitions/dvs-switch"
65253   edge-prop-names:
65254     description: |
65255       Internal map to define the properties of an edge and interpret the map EdgeRules
65256     properties:
65257       edgeLabel:
65258         type: string
65259       direction:
65260         type: string
65261       multiplicityRule:
65262         type: string
65263       contains-other-v:
65264         type: string
65265       delete-other-v:
65266         type: string
65267       SVC-INFRA:
65268         type: string
65269       prevent-delete:
65270         type: string
65271       aai-uuid:
65272         type: string
65273   edge-tag-query-request:
65274     properties:
65275       edge-tag:
65276         type: string
65277       result-detail:
65278         type: string
65279       start-node-type:
65280         type: string
65281       start-node-filter:
65282         type: array
65283         items:
65284           $ref: "#/getDefinitions/start-node-filter"
65285       include-node-filter:
65286         type: array
65287         items:
65288           $ref: "#/getDefinitions/include-node-filter"
65289       secondary-filter:
65290         type: array
65291         items:
65292           $ref: "#/getDefinitions/secondary-filter"
65293   edge-tag-query-result:
65294     properties:
65295       tagged-inventory-item-list:
65296         type: array
65297         items:
65298           $ref: "#/getDefinitions/tagged-inventory-item-list"
65299   element-choice-set:
65300     description: |
65301       This is how we would capture constraints defining allowed sets of elements.
65302       ###### Related Nodes
65303       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
65304       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
65305       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
65306     required:
65307     - element-choice-set-uuid
65308     - element-choice-set-name
65309     properties:
65310       element-choice-set-uuid:
65311         type: string
65312       element-choice-set-name:
65313         type: string
65314       cardinality:
65315         type: string
65316       resource-version:
65317         type: string
65318       model-elements:
65319         type: array
65320         items:
65321           $ref: "#/getDefinitions/model-element"
65322       relationship-list:
65323         type: array
65324         items:
65325           $ref: "#/getDefinitions/relationship"
65326   element-choice-sets:
65327     properties:
65328       element-choice-set:
65329         type: array
65330         items:
65331           $ref: "#/getDefinitions/element-choice-set"
65332   entitlement:
65333     description: |
65334       Metadata for entitlement group.
65335       ###### Related Nodes
65336       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65337       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
65338     required:
65339     - group-uuid
65340     - resource-uuid
65341     properties:
65342       group-uuid:
65343         type: string
65344         description: Unique ID for the entitlement group the resource comes from, should be uuid.
65345       resource-uuid:
65346         type: string
65347         description: Unique ID of an entitlement resource.
65348       resource-version:
65349         type: string
65350         description: Concurrency value
65351       relationship-list:
65352         type: array
65353         items:
65354           $ref: "#/getDefinitions/relationship"
65355   entitlements:
65356     description: |
65357       Entitlements, keyed by group-uuid and resource-uuid, related to license management
65358     properties:
65359       entitlement:
65360         type: array
65361         items:
65362           $ref: "#/getDefinitions/entitlement"
65363   esr-ems:
65364     description: |
65365       Persist EMS address information used by EMS driver.
65366       ###### Related Nodes
65367       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
65368       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
65369     required:
65370     - ems-id
65371     properties:
65372       ems-id:
65373         type: string
65374         description: Unique ID of EMS.
65375       resource-version:
65376         type: string
65377         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65378       esr-system-info-list:
65379         type: object
65380         $ref: "#/getDefinitions/esr-system-info-list"
65381       relationship-list:
65382         type: object
65383         $ref: "#/getDefinitions/relationship-list"
65384   esr-ems-list:
65385     properties:
65386       esr-ems:
65387         type: array
65388         items:
65389           $ref: "#/getDefinitions/esr-ems"
65390   esr-system-info:
65391     description: |
65392       Persist common address information of external systems.
65393       ###### Related Nodes
65394       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
65395       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
65396       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
65397       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
65398     required:
65399     - esr-system-info-id
65400     - user-name
65401     - password
65402     - system-type
65403     properties:
65404       esr-system-info-id:
65405         type: string
65406         description: Unique ID of esr system info.
65407       system-name:
65408         type: string
65409         description: name of external system.
65410       type:
65411         type: string
65412         description: type of external systems.
65413       vendor:
65414         type: string
65415         description: vendor of external systems.
65416       version:
65417         type: string
65418         description: version of external systems.
65419       service-url:
65420         type: string
65421         description: url used to access external systems.
65422       user-name:
65423         type: string
65424         description: username used to access external systems.
65425       password:
65426         type: string
65427         description: password used to access external systems.
65428       system-type:
65429         type: string
65430         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
65431       protocol:
65432         type: string
65433         description: protocol of third party SDNC, for example netconf/snmp.
65434       ssl-cacert:
65435         type: string
65436         description: ca file content if enabled ssl on auth-url.
65437       ssl-insecure:
65438         type: boolean
65439         description: Whether to verify VIM's certificate.
65440       ip-address:
65441         type: string
65442         description: service IP of ftp server.
65443       port:
65444         type: string
65445         description: service port of ftp server.
65446       cloud-domain:
65447         type: string
65448         description: domain info for authentication.
65449       default-tenant:
65450         type: string
65451         description: default tenant of VIM.
65452       passive:
65453         type: boolean
65454         description: ftp passive mode or not.
65455       remote-path:
65456         type: string
65457         description: resource or performance data file path.
65458       system-status:
65459         type: string
65460         description: the status of external system.
65461       resource-version:
65462         type: string
65463         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65464       relationship-list:
65465         type: object
65466         $ref: "#/getDefinitions/relationship-list"
65467   esr-system-info-list:
65468     description: |
65469       Collection of persistent block-level external system auth info.
65470     properties:
65471       esr-system-info:
65472         type: array
65473         items:
65474           $ref: "#/getDefinitions/esr-system-info"
65475   esr-thirdparty-sdnc:
65476     description: |
65477       Persist SDNC address information used by ONAP SDNC.
65478       ###### Related Nodes
65479       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
65480       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
65481       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
65482     required:
65483     - thirdparty-sdnc-id
65484     properties:
65485       thirdparty-sdnc-id:
65486         type: string
65487         description: Unique ID of SDNC.
65488       location:
65489         type: string
65490         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
65491       product-name:
65492         type: string
65493         description: password used to access SDNC server.
65494       resource-version:
65495         type: string
65496         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65497       esr-system-info-list:
65498         type: object
65499         $ref: "#/getDefinitions/esr-system-info-list"
65500       relationship-list:
65501         type: object
65502         $ref: "#/getDefinitions/relationship-list"
65503   esr-thirdparty-sdnc-list:
65504     properties:
65505       esr-thirdparty-sdnc:
65506         type: array
65507         items:
65508           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
65509   esr-vnfm:
65510     description: |
65511       Persist VNFM address information used by VF-C.
65512       ###### Related Nodes
65513       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
65514       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
65515     required:
65516     - vnfm-id
65517     properties:
65518       vnfm-id:
65519         type: string
65520         description: Unique ID of VNFM.
65521       vim-id:
65522         type: string
65523         description: indecate the VIM to deploy VNF.
65524       certificate-url:
65525         type: string
65526         description: certificate url of VNFM.
65527       resource-version:
65528         type: string
65529         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65530       esr-system-info-list:
65531         type: object
65532         $ref: "#/getDefinitions/esr-system-info-list"
65533       relationship-list:
65534         type: object
65535         $ref: "#/getDefinitions/relationship-list"
65536   esr-vnfm-list:
65537     properties:
65538       esr-vnfm:
65539         type: array
65540         items:
65541           $ref: "#/getDefinitions/esr-vnfm"
65542   evc:
65543     description: |
65544       evc object is an optional child object of the Configuration object.
65545       ###### Related Nodes
65546       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
65547     required:
65548     - evc-id
65549     properties:
65550       evc-id:
65551         type: string
65552         description: Unique/key field for the evc object
65553       forwarding-path-topology:
65554         type: string
65555         description: Point-to-Point, Multi-Point
65556       cir-value:
65557         type: string
65558         description: Commited Information Rate
65559       cir-units:
65560         type: string
65561         description: CIR units
65562       connection-diversity-group-id:
65563         type: string
65564         description: Diversity Group ID
65565       service-hours:
65566         type: string
65567         description: formerly Performance Group
65568       esp-evc-circuit-id:
65569         type: string
65570         description: EVC Circuit ID of ESP EVC
65571       esp-evc-cir-value:
65572         type: string
65573         description: Committed Information Rate (For ESP)
65574       esp-evc-cir-units:
65575         type: string
65576         description: CIR units (For ESP)
65577       esp-itu-code:
65578         type: string
65579         description: Identifies ESP
65580       collector-pop-clli:
65581         type: string
65582         description: Collector POP CLLI (from the hostname of the access pnf)
65583       inter-connect-type-ingress:
65584         type: string
65585         description: Interconnect type on ingress side of EVC.
65586       tagmode-access-ingress:
65587         type: string
65588         description: tagode for collector side of EVC
65589       tagmode-access-egress:
65590         type: string
65591         description: tagMode for network side of EVC
65592       relationship-list:
65593         type: array
65594         items:
65595           $ref: "#/getDefinitions/relationship"
65596       resource-version:
65597         type: string
65598         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65599   evcs:
65600     properties:
65601       evc:
65602         type: array
65603         items:
65604           $ref: "#/getDefinitions/evc"
65605   external-system:
65606     description: |
65607       Namespace for external system.
65608     properties:
65609       esr-ems-list:
65610         type: object
65611         $ref: "#/getDefinitions/esr-ems-list"
65612       esr-vnfm-list:
65613         type: object
65614         $ref: "#/getDefinitions/esr-vnfm-list"
65615       esr-thirdparty-sdnc-list:
65616         type: object
65617         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
65618   extra-properties:
65619     description: |
65620       Extra properties for inventory item for response list
65621     properties:
65622       extra-property:
65623         type: array
65624         items:
65625           $ref: "#/getDefinitions/extra-property"
65626   extra-property:
65627     properties:
65628       property-name:
65629         type: string
65630       property-value:
65631         type: string
65632   flavor:
65633     description: |
65634       Openstack flavor.
65635       ###### Related Nodes
65636       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65637       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
65638       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
65639       - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
65640     required:
65641     - flavor-id
65642     - flavor-name
65643     - flavor-selflink
65644     properties:
65645       flavor-id:
65646         type: string
65647         description: Flavor id, expected to be unique across cloud-region.
65648       flavor-name:
65649         type: string
65650         description: Cloud Region Flavor name
65651       flavor-vcpus:
65652         type: integer
65653         format: int32
65654         description: Number of CPUs
65655       flavor-ram:
65656         type: integer
65657         format: int32
65658         description: Amount of memory
65659       flavor-disk:
65660         type: integer
65661         format: int32
65662         description: Disk space
65663       flavor-ephemeral:
65664         type: integer
65665         format: int32
65666         description: Amount of ephemeral disk space
65667       flavor-swap:
65668         type: string
65669         description: amount of swap space allocation
65670       flavor-is-public:
65671         type: boolean
65672         description: whether flavor is available to all users or private to the tenant it was created in.
65673       flavor-selflink:
65674         type: string
65675         description: URL to endpoint where AAI can get more details
65676       flavor-disabled:
65677         type: boolean
65678         description: Boolean as to whether this flavor is no longer enabled
65679       hpa-capabilities:
65680         type: array
65681         items:
65682           $ref: "#/getDefinitions/hpa-capability"
65683         description: List of flavor specific HPA Capabilities
65684       resource-version:
65685         type: string
65686         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65687       relationship-list:
65688         type: array
65689         items:
65690           $ref: "#/getDefinitions/relationship"
65691   flavors:
65692     description: |
65693       Collection of openstack flavors.
65694     properties:
65695       flavor:
65696         type: array
65697         items:
65698           $ref: "#/getDefinitions/flavor"
65699   forwarder:
65700     description: |
65701       Entity describing a sequenced segment of forwarding path
65702       ###### Related Nodes
65703       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
65704       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
65705       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
65706       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
65707       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
65708       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
65709     required:
65710     - sequence
65711     properties:
65712       sequence:
65713         type: integer
65714         format: int32
65715         description: Unique ID of this segmentation
65716       forwarder-role:
65717         type: string
65718         description: ingress, intermediate, egress
65719       relationship-list:
65720         type: array
65721         items:
65722           $ref: "#/getDefinitions/relationship"
65723       resource-version:
65724         type: string
65725         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65726   forwarder-evc:
65727     description: |
65728       forwarder object is an optional child object of the Configuration object.
65729       ###### Related Nodes
65730       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
65731     required:
65732     - forwarder-evc-id
65733     properties:
65734       forwarder-evc-id:
65735         type: string
65736         description: Key for forwarder-evc object
65737       circuit-id:
65738         type: string
65739         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
65740       ivlan:
65741         type: string
65742         description: Internal VLAN.
65743       svlan:
65744         type: string
65745         description: SVLAN value for ingress of egress forwarder.
65746       cvlan:
65747         type: string
65748         description: CVLAN value for ingress of egress forwarder.
65749       relationship-list:
65750         type: array
65751         items:
65752           $ref: "#/getDefinitions/relationship"
65753       resource-version:
65754         type: string
65755         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65756   forwarder-evcs:
65757     properties:
65758       forwarder-evc:
65759         type: array
65760         items:
65761           $ref: "#/getDefinitions/forwarder-evc"
65762   forwarders:
65763     properties:
65764       forwarder:
65765         type: array
65766         items:
65767           $ref: "#/getDefinitions/forwarder"
65768   forwarding-path:
65769     description: |
65770       Entity that describes the sequenced forwarding path between interfaces of services or resources
65771       ###### Related Nodes
65772       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
65773       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
65774       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
65775       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
65776       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
65777     required:
65778     - forwarding-path-id
65779     - forwarding-path-name
65780     properties:
65781       forwarding-path-id:
65782         type: string
65783         description: Unique ID of this FP
65784       forwarding-path-name:
65785         type: string
65786         description: Name of the FP
65787       relationship-list:
65788         type: array
65789         items:
65790           $ref: "#/getDefinitions/relationship"
65791       resource-version:
65792         type: string
65793         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65794       selflink:
65795         type: string
65796         description: the self link for this FP
65797       forwarders:
65798         type: array
65799         items:
65800           $ref: "#/getDefinitions/forwarder"
65801   forwarding-paths:
65802     properties:
65803       forwarding-path:
65804         type: array
65805         items:
65806           $ref: "#/getDefinitions/forwarding-path"
65807   generic-vnf:
65808     description: |
65809       General purpose VNF
65810       ###### Related Nodes
65811       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
65812       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
65813       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
65814       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
65815       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65816       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
65817       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
65818       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
65819       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
65820       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
65821       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
65822       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
65823       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
65824       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
65825       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
65826       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
65827       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65828       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65829       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65830       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65831       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65832       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
65833       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
65834       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
65835       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65836       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65837       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
65838       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65839       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
65840       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
65841     required:
65842     - vnf-id
65843     - vnf-instance-id
65844     - vnf-name
65845     - vnf-type
65846     - vnf-package-name
65847     - vnf-discriptor-name
65848     - job-id
65849     - in-maint
65850     - is-closed-loop-disabled
65851     properties:
65852       vnf-id:
65853         type: string
65854         description: Unique id of VNF.  This is unique across the graph.
65855       vnf-instance-id:
65856         type: string
65857         description: vnf instance id.
65858       vnf-name:
65859         type: string
65860         description: Name of VNF.
65861       vnf-name2:
65862         type: string
65863         description: Alternate name of VNF.
65864       vnf-type:
65865         type: string
65866         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.
65867       service-id:
65868         type: string
65869         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
65870       regional-resource-zone:
65871         type: string
65872         description: Regional way of organizing pservers, source of truth should define values
65873       prov-status:
65874         type: string
65875         description: Trigger for operational monitoring of this resource by Service Assurance systems.
65876       operational-status:
65877         type: string
65878         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
65879       license-key:
65880         type: string
65881         description: OBSOLETE -  do not use
65882       equipment-role:
65883         type: string
65884         description: Client should send valid enumerated value
65885       orchestration-status:
65886         type: string
65887         description: Orchestration status of this VNF, used by MSO.
65888       vnf-package-name:
65889         type: string
65890       vnf-discriptor-name:
65891         type: string
65892         description: vnf discriptor name
65893       job-id:
65894         type: string
65895         description: job id corresponding to vnf
65896       heat-stack-id:
65897         type: string
65898         description: Heat stack id corresponding to this instance, managed by MSO
65899       mso-catalog-key:
65900         type: string
65901         description: Corresponds to the SDN-C catalog id used to configure this VCE
65902       management-option:
65903         type: string
65904         description: identifier of managed by ATT or customer
65905       ipv4-oam-address:
65906         type: string
65907         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
65908       ipv4-loopback0-address:
65909         type: string
65910         description: v4 Loopback0 address
65911       nm-lan-v6-address:
65912         type: string
65913         description: v6 Loopback address
65914       management-v6-address:
65915         type: string
65916         description: v6 management address
65917       vcpu:
65918         type: integer
65919         format: int64
65920         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
65921       vcpu-units:
65922         type: string
65923         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
65924       vmemory:
65925         type: integer
65926         format: int64
65927         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
65928       vmemory-units:
65929         type: string
65930         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
65931       vdisk:
65932         type: integer
65933         format: int64
65934         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
65935       vdisk-units:
65936         type: string
65937         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
65938       nshd:
65939         type: integer
65940         format: int64
65941         description: number of associated SHD in vnf.
65942       nvm:
65943         type: integer
65944         format: int64
65945         description: number of vms in vnf.
65946       nnet:
65947         type: integer
65948         format: int64
65949         description: number of network in vnf.
65950       in-maint:
65951         type: boolean
65952       is-closed-loop-disabled:
65953         type: boolean
65954       resource-version:
65955         type: string
65956         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65957       summary-status:
65958         type: string
65959         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
65960       encrypted-access-flag:
65961         type: boolean
65962         description: indicates whether generic-vnf access uses SSH
65963       entitlement-assignment-group-uuid:
65964         type: string
65965         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
65966       entitlement-resource-uuid:
65967         type: string
65968         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
65969       license-assignment-group-uuid:
65970         type: string
65971         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
65972       license-key-uuid:
65973         type: string
65974         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
65975       model-invariant-id:
65976         type: string
65977         description: the ASDC model id for this resource or service model.
65978       model-version-id:
65979         type: string
65980         description: the ASDC model version for this resource or service model.
65981       persona-model-version:
65982         type: string
65983         description: the ASDC model version for this resource or service model.
65984       model-customization-id:
65985         type: string
65986         description: captures the id of all the configuration used to customize the resource for the service.
65987       widget-model-id:
65988         type: string
65989         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
65990       widget-model-version:
65991         type: string
65992         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
65993       as-number:
65994         type: string
65995         description: as-number of the VNF
65996       regional-resource-subzone:
65997         type: string
65998         description: represents sub zone of the rr plane
65999       nf-type:
66000         type: string
66001         description: Generic description of the type of NF
66002       nf-function:
66003         type: string
66004         description: English description of Network function that the specific VNF deployment is providing
66005       nf-role:
66006         type: string
66007         description: role in the network that this model will be providing
66008       nf-naming-code:
66009         type: string
66010         description: string assigned to this model used for naming purposes
66011       selflink:
66012         type: string
66013         description: Path to the controller object.
66014       ipv4-oam-gateway-address:
66015         type: string
66016         description: Gateway address
66017       ipv4-oam-gateway-address-prefix-length:
66018         type: integer
66019         format: int32
66020         description: Prefix length for oam-address
66021       vlan-id-outer:
66022         type: integer
66023         format: int64
66024         description: Temporary location for S-TAG to get to VCE
66025       nm-profile-name:
66026         type: string
66027         description: Network Management profile of this VNF
66028       relationship-list:
66029         type: array
66030         items:
66031           $ref: "#/getDefinitions/relationship"
66032       l-interfaces:
66033         type: array
66034         items:
66035           $ref: "#/getDefinitions/l-interface"
66036       lag-interfaces:
66037         type: array
66038         items:
66039           $ref: "#/getDefinitions/lag-interface"
66040       vf-modules:
66041         type: array
66042         items:
66043           $ref: "#/getDefinitions/vf-module"
66044       licenses:
66045         type: array
66046         items:
66047           $ref: "#/getDefinitions/license"
66048       entitlements:
66049         type: array
66050         items:
66051           $ref: "#/getDefinitions/entitlement"
66052   generic-vnfs:
66053     description: |
66054       Collection of VNFs
66055     properties:
66056       generic-vnf:
66057         type: array
66058         items:
66059           $ref: "#/getDefinitions/generic-vnf"
66060   group-assignment:
66061     description: |
66062       Openstack group-assignment used to store exclusivity groups (EG).
66063       ###### Related Nodes
66064       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66065       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
66066       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
66067     required:
66068     - group-id
66069     - group-type
66070     - group-name
66071     properties:
66072       group-id:
66073         type: string
66074         description: Group id, expected to be unique across cloud-region.
66075       group-type:
66076         type: string
66077         description: Group type - the type of group this instance refers to
66078       group-name:
66079         type: string
66080         description: Group name - name assigned to the group
66081       group-description:
66082         type: string
66083         description: Group description - description of the group
66084       resource-version:
66085         type: string
66086         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66087       relationship-list:
66088         type: array
66089         items:
66090           $ref: "#/getDefinitions/relationship"
66091   group-assignments:
66092     description: |
66093       Collection of openstack group assignments
66094     properties:
66095       group-assignment:
66096         type: array
66097         items:
66098           $ref: "#/getDefinitions/group-assignment"
66099   host-route:
66100     description: |
66101       ###### Related Nodes
66102       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
66103     required:
66104     - host-route-id
66105     - route-prefix
66106     - next-hop
66107     properties:
66108       host-route-id:
66109         type: string
66110         description: host-route id
66111       route-prefix:
66112         type: string
66113         description: subnet prefix
66114       next-hop:
66115         type: string
66116         description: Could be ip-address, hostname, or service-instance
66117       next-hop-type:
66118         type: string
66119         description: Should be ip-address, hostname, or service-instance to match next-hop
66120       resource-version:
66121         type: string
66122         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66123       relationship-list:
66124         type: array
66125         items:
66126           $ref: "#/getDefinitions/relationship"
66127   host-routes:
66128     properties:
66129       host-route:
66130         type: array
66131         items:
66132           $ref: "#/getDefinitions/host-route"
66133   hpa-capabilities:
66134     description: |
66135       Collection of HPA Capabilities
66136     properties:
66137       hpa-capability:
66138         type: array
66139         items:
66140           $ref: "#/getDefinitions/hpa-capability"
66141   hpa-capability:
66142     description: |
66143       Represents a HPA capability
66144       ###### Related Nodes
66145       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
66146       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66147       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
66148       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
66149     required:
66150     - hpa-capability-id
66151     - hpa-feature
66152     properties:
66153       hpa-capability-id:
66154         type: string
66155         description: UUID to uniquely identify a HPA capability
66156       hpa-feature:
66157         type: string
66158         description: Name of the HPACapability
66159       hpa-version:
66160         type: string
66161         description: HPA schema version
66162       architecture:
66163         type: string
66164         description: Hardware architecture
66165       resource-version:
66166         type: string
66167         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66168       relationship-list:
66169         type: array
66170         items:
66171           $ref: "#/getDefinitions/relationship"
66172       hpa-feature-attributes:
66173         type: array
66174         items:
66175           $ref: "#/getDefinitions/hpa-feature-attributes"
66176   hpa-feature-attributes:
66177     description: |
66178       HPA Capability Feature attributes
66179       ###### Related Nodes
66180       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
66181     required:
66182     - hpa-attribute-key
66183     properties:
66184       hpa-attribute-key:
66185         type: string
66186         description: name of the specific HPA attribute
66187       hpa-attribute-value:
66188         type: string
66189         description: JSON string specifying the value, unit and type of the specific HPA attribute
66190       resource-version:
66191         type: string
66192         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66193       relationship-list:
66194         type: array
66195         items:
66196           $ref: "#/getDefinitions/relationship"
66197   image:
66198     description: |
66199       Openstack image.
66200       ###### Related Nodes
66201       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66202       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
66203       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
66204       - IMAGE cannot be deleted if linked to VSERVER
66205       - IMAGE is DELETED when these are DELETED METADATUM
66206     required:
66207     - image-id
66208     - image-name
66209     - image-os-distro
66210     - image-os-version
66211     - image-selflink
66212     properties:
66213       image-id:
66214         type: string
66215         description: Image id, expected to be unique across cloud region
66216       image-name:
66217         type: string
66218         description: Image name
66219       image-architecture:
66220         type: string
66221         description: Operating system architecture.
66222       image-os-distro:
66223         type: string
66224         description: The common name of the operating system distribution in lowercase
66225       image-os-version:
66226         type: string
66227         description: The operating system version as specified by the distributor.
66228       application:
66229         type: string
66230         description: The application that the image instantiates.
66231       application-vendor:
66232         type: string
66233         description: The vendor of the application.
66234       application-version:
66235         type: string
66236         description: The version of the application.
66237       image-selflink:
66238         type: string
66239         description: URL to endpoint where AAI can get more details
66240       resource-version:
66241         type: string
66242         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66243       relationship-list:
66244         type: array
66245         items:
66246           $ref: "#/getDefinitions/relationship"
66247       metadata:
66248         type: array
66249         items:
66250           $ref: "#/getDefinitions/metadatum"
66251   images:
66252     description: |
66253       Collectio of Openstack images.
66254     properties:
66255       image:
66256         type: array
66257         items:
66258           $ref: "#/getDefinitions/image"
66259   include-node-filter:
66260     properties:
66261       include-node-type:
66262         type: string
66263   instance-filter:
66264     description: |
66265       InstanceFilter for performing a named-query or model query
66266   instance-filters:
66267     description: |
66268       InstanceFilters for performing a named-query or model query
66269     properties:
66270       instance-filter:
66271         type: array
66272         items:
66273           $ref: "#/getDefinitions/instance-filter"
66274   instance-group:
66275     description: |
66276       General mechanism for grouping instances
66277       ###### Related Nodes
66278       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
66279       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66280       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66281       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
66282       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
66283       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66284       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66285       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66286       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66287       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66288       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66289       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66290     required:
66291     - instance-group-role
66292     - model-invariant-id
66293     - model-version-id
66294     - id
66295     - description
66296     - type
66297     properties:
66298       instance-group-role:
66299         type: string
66300         description: role of the instance group.
66301       model-invariant-id:
66302         type: string
66303         description: ASDC model id for this resource or service model.
66304       model-version-id:
66305         type: string
66306         description: ASDC model version uid for this resource model.
66307       id:
66308         type: string
66309         description: Instance Group ID, UUID assigned to this instance.
66310       description:
66311         type: string
66312         description: Descriptive text to help identify the usage of this instance-group
66313       type:
66314         type: string
66315         description: Only valid value today is lower case ha for high availability
66316       sub-type:
66317         type: string
66318         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
66319       resource-version:
66320         type: string
66321         description: Concurrency value
66322       relationship-list:
66323         type: array
66324         items:
66325           $ref: "#/getDefinitions/relationship"
66326   instance-groups:
66327     description: |
66328       Collection of openstack route table references
66329     properties:
66330       instance-group:
66331         type: array
66332         items:
66333           $ref: "#/getDefinitions/instance-group"
66334   inventory:
66335     properties:
66336       search:
66337         type: object
66338         $ref: "#/getDefinitions/search"
66339       actions:
66340         type: object
66341         $ref: "#/getDefinitions/actions"
66342       cloud-infrastructure:
66343         type: object
66344         $ref: "#/getDefinitions/cloud-infrastructure"
66345       external-system:
66346         type: object
66347         $ref: "#/getDefinitions/external-system"
66348       business:
66349         type: object
66350         $ref: "#/getDefinitions/business"
66351       service-design-and-creation:
66352         type: object
66353         $ref: "#/getDefinitions/service-design-and-creation"
66354       network:
66355         type: object
66356         $ref: "#/getDefinitions/network"
66357       aai-internal:
66358         type: object
66359         $ref: "#/getDefinitions/aai-internal"
66360       nodes:
66361         type: array
66362         items:
66363           $ref: "#/getDefinitions/aai-internal"
66364   inventory-item:
66365     properties:
66366       inventory-item-type:
66367         type: string
66368       inventory-item-link:
66369         type: string
66370       inventory-item-data:
66371         type: array
66372         items:
66373           $ref: "#/getDefinitions/inventory-item-data"
66374       tagged-inventory-item-list:
66375         type: array
66376         items:
66377           $ref: "#/getDefinitions/tagged-inventory-item-list"
66378   inventory-item-data:
66379     properties:
66380       property-name:
66381         type: string
66382       property-value:
66383         type: string
66384   inventory-response-item:
66385     description: |
66386       Inventory item for response list
66387     properties:
66388       model-name:
66389         type: string
66390       extra-properties:
66391         type: object
66392         $ref: "#/getDefinitions/extra-properties"
66393       inventory-response-items:
66394         type: object
66395         $ref: "#/getDefinitions/inventory-response-items"
66396   inventory-response-items:
66397     description: |
66398       Container for inventory items in response list
66399     properties:
66400       inventory-response-item:
66401         type: array
66402         items:
66403           $ref: "#/getDefinitions/inventory-response-item"
66404   ipsec-configuration:
66405     description: |
66406       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
66407       ###### Related Nodes
66408       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
66409       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
66410       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
66411     required:
66412     - ipsec-configuration-id
66413     properties:
66414       ipsec-configuration-id:
66415         type: string
66416         description: UUID of this configuration
66417       requested-vig-address-type:
66418         type: string
66419         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
66420       requested-encryption-strength:
66421         type: string
66422         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
66423       requested-dmz-type:
66424         type: string
66425         description: ATT can offer a shared DMZ or a DMZ specific to a customer
66426       shared-dmz-network-address:
66427         type: string
66428         description: Network address of shared DMZ
66429       requested-customer-name:
66430         type: string
66431         description: If the DMZ is a custom DMZ, this field will indicate the customer information
66432       ike-version:
66433         type: string
66434         description: can be 1 or 2
66435       ikev1-authentication:
66436         type: string
66437         description: Contains values like md5, sha1, sha256, sha384
66438       ikev1-encryption:
66439         type: string
66440         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
66441       ikev1-dh-group:
66442         type: string
66443         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
66444       ikev1-am-group-id:
66445         type: string
66446         description: Group name defined in VIG for clients using aggressive mode
66447       ikev1-am-password:
66448         type: string
66449         description: pre-shared key for the above group name
66450       ikev1-sa-lifetime:
66451         type: string
66452         description: Lifetime for IKEv1 SA
66453       ipsec-authentication:
66454         type: string
66455         description: md5, sha1, sha256, sha384
66456       ipsec-encryption:
66457         type: string
66458         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
66459       ipsec-sa-lifetime:
66460         type: string
66461         description: Life time for IPSec SA
66462       ipsec-pfs:
66463         type: string
66464         description: enable PFS or not
66465       xauth-userid:
66466         type: string
66467         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
66468       xauth-user-password:
66469         type: string
66470         description: Encrypted using the Juniper $9$ algorithm
66471       dpd-interval:
66472         type: string
66473         description: The time between DPD probe
66474       dpd-frequency:
66475         type: string
66476         description: Maximum number of DPD before claiming the tunnel is down
66477       resource-version:
66478         type: string
66479         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66480       relationship-list:
66481         type: array
66482         items:
66483           $ref: "#/getDefinitions/relationship"
66484       vig-servers:
66485         type: array
66486         items:
66487           $ref: "#/getDefinitions/vig-server"
66488   ipsec-configurations:
66489     properties:
66490       ipsec-configuration:
66491         type: array
66492         items:
66493           $ref: "#/getDefinitions/ipsec-configuration"
66494   key-data:
66495     properties:
66496       key-name:
66497         type: string
66498       key-value:
66499         type: string
66500   l-interface:
66501     description: |
66502       Logical interfaces, e.g., a vnic.
66503       ###### Related Nodes
66504       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66505       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
66506       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66507       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66508       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
66509       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
66510       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
66511       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
66512       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
66513       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66514       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66515       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
66516       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
66517       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
66518       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
66519       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
66520       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
66521       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66522       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
66523       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
66524     required:
66525     - interface-name
66526     - is-port-mirrored
66527     - in-maint
66528     - is-ip-unnumbered
66529     properties:
66530       interface-name:
66531         type: string
66532         description: Name given to the interface
66533       interface-role:
66534         type: string
66535         description: E.g., CUSTOMER, UPLINK, etc.
66536       v6-wan-link-ip:
66537         type: string
66538         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
66539       selflink:
66540         type: string
66541         description: URL to endpoint where AAI can get more details
66542       interface-id:
66543         type: string
66544         description: ID of interface
66545       macaddr:
66546         type: string
66547         description: MAC address for the interface
66548       network-name:
66549         type: string
66550         description: Name of the network
66551       management-option:
66552         type: string
66553         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
66554       interface-description:
66555         type: string
66556         description: Human friendly text regarding this interface.
66557       is-port-mirrored:
66558         type: boolean
66559       resource-version:
66560         type: string
66561         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66562       in-maint:
66563         type: boolean
66564       prov-status:
66565         type: string
66566         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
66567       is-ip-unnumbered:
66568         type: boolean
66569       allowed-address-pairs:
66570         type: string
66571         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
66572       vlans:
66573         type: array
66574         items:
66575           $ref: "#/getDefinitions/vlan"
66576       sriov-vfs:
66577         type: array
66578         items:
66579           $ref: "#/getDefinitions/sriov-vf"
66580       l-interfaces:
66581         type: array
66582         items:
66583           $ref: "#/getDefinitions/l-interface"
66584       relationship-list:
66585         type: array
66586         items:
66587           $ref: "#/getDefinitions/relationship"
66588       l3-interface-ipv4-address-list:
66589         type: array
66590         items:
66591           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
66592       l3-interface-ipv6-address-list:
66593         type: array
66594         items:
66595           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
66596   l-interfaces:
66597     description: |
66598       Collection of logical interfaces.
66599     properties:
66600       l-interface:
66601         type: array
66602         items:
66603           $ref: "#/getDefinitions/l-interface"
66604   l3-interface-ipv4-address-list:
66605     description: |
66606       IPv4 Address Range
66607       ###### Related Nodes
66608       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
66609       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66610       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66611       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66612       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
66613       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
66614     required:
66615     - l3-interface-ipv4-address
66616     properties:
66617       l3-interface-ipv4-address:
66618         type: string
66619         description: IP address
66620       l3-interface-ipv4-prefix-length:
66621         type: integer
66622         format: int64
66623         description: Prefix length, 32 for single address
66624       vlan-id-inner:
66625         type: integer
66626         format: int64
66627         description: Inner VLAN tag
66628       vlan-id-outer:
66629         type: integer
66630         format: int64
66631         description: Outer VLAN tag
66632       is-floating:
66633         type: boolean
66634         description: Indicator of fixed or floating address
66635       resource-version:
66636         type: string
66637         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66638       neutron-network-id:
66639         type: string
66640         description: Neutron network id of the interface that address belongs to
66641       neutron-subnet-id:
66642         type: string
66643         description: Neutron id of subnet that address belongs to
66644       relationship-list:
66645         type: array
66646         items:
66647           $ref: "#/getDefinitions/relationship"
66648   l3-interface-ipv6-address-list:
66649     description: |
66650       IPv6 Address Range
66651       ###### Related Nodes
66652       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
66653       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66654       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66655       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66656       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
66657       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
66658     required:
66659     - l3-interface-ipv6-address
66660     properties:
66661       l3-interface-ipv6-address:
66662         type: string
66663         description: IP address
66664       l3-interface-ipv6-prefix-length:
66665         type: integer
66666         format: int64
66667         description: Prefix length, 128 for single address
66668       vlan-id-inner:
66669         type: integer
66670         format: int64
66671         description: Inner VLAN tag
66672       vlan-id-outer:
66673         type: integer
66674         format: int64
66675         description: Outer VLAN tag
66676       is-floating:
66677         type: boolean
66678         description: Indicator of fixed or floating address
66679       resource-version:
66680         type: string
66681         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66682       neutron-network-id:
66683         type: string
66684         description: Neutron network id of the interface that address belongs to
66685       neutron-subnet-id:
66686         type: string
66687         description: Neutron id of subnet that address belongs to
66688       relationship-list:
66689         type: array
66690         items:
66691           $ref: "#/getDefinitions/relationship"
66692   l3-network:
66693     description: |
66694       Generic network definition
66695       ###### Related Nodes
66696       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66697       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
66698       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
66699       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
66700       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
66701       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
66702       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66703       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66704       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66705       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66706       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66707       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66708       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66709       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
66710       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66711       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66712       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
66713       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
66714     required:
66715     - network-id
66716     - network-name
66717     - is-bound-to-vpn
66718     - is-provider-network
66719     - is-shared-network
66720     - is-external-network
66721     properties:
66722       network-id:
66723         type: string
66724         description: Network ID, should be uuid. Unique across A&AI.
66725       network-name:
66726         type: string
66727         description: Name of the network, governed by some naming convention..
66728       network-type:
66729         type: string
66730         description: Type of the network - who defines these values?
66731       network-role:
66732         type: string
66733         description: Role the network plans - who defines these values?
66734       network-technology:
66735         type: string
66736         description: Network technology - who defines these values?
66737       neutron-network-id:
66738         type: string
66739         description: Neutron network id of this Interface
66740       is-bound-to-vpn:
66741         type: boolean
66742       service-id:
66743         type: string
66744         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
66745       network-role-instance:
66746         type: integer
66747         format: int64
66748         description: network role instance
66749       resource-version:
66750         type: string
66751         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66752       orchestration-status:
66753         type: string
66754         description: Orchestration status of this VNF, mastered by MSO
66755       heat-stack-id:
66756         type: string
66757         description: Heat stack id corresponding to this instance, managed by MSO
66758       mso-catalog-key:
66759         type: string
66760         description: Corresponds to the SDN-C catalog id used to configure this VCE
66761       contrail-network-fqdn:
66762         type: string
66763         description: Contrail FQDN for the network
66764       model-invariant-id:
66765         type: string
66766         description: the ASDC model id for this resource or service model.
66767       model-version-id:
66768         type: string
66769         description: the ASDC model version for this resource or service model.
66770       persona-model-version:
66771         type: string
66772         description: the ASDC model version for this resource or service model.
66773       model-customization-id:
66774         type: string
66775         description: captures the id of all the configuration used to customize the resource for the service.
66776       widget-model-id:
66777         type: string
66778         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
66779       widget-model-version:
66780         type: string
66781         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
66782       physical-network-name:
66783         type: string
66784         description: Name associated with the physical network.
66785       is-provider-network:
66786         type: boolean
66787       is-shared-network:
66788         type: boolean
66789       is-external-network:
66790         type: boolean
66791       selflink:
66792         type: string
66793         description: Path to the controller object.
66794       operational-status:
66795         type: string
66796         description: Indicator for whether the resource is considered operational.
66797       subnets:
66798         type: array
66799         items:
66800           $ref: "#/getDefinitions/subnet"
66801       ctag-assignments:
66802         type: array
66803         items:
66804           $ref: "#/getDefinitions/ctag-assignment"
66805       segmentation-assignments:
66806         type: array
66807         items:
66808           $ref: "#/getDefinitions/segmentation-assignment"
66809       relationship-list:
66810         type: array
66811         items:
66812           $ref: "#/getDefinitions/relationship"
66813         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
66814   l3-networks:
66815     properties:
66816       l3-network:
66817         type: array
66818         items:
66819           $ref: "#/getDefinitions/l3-network"
66820   lag-interface:
66821     description: |
66822       Link aggregate interface
66823       ###### Related Nodes
66824       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66825       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
66826       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66827       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
66828       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
66829       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
66830       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
66831       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
66832       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
66833       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
66834       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
66835     required:
66836     - interface-name
66837     - in-maint
66838     properties:
66839       interface-name:
66840         type: string
66841         description: Name that identifies the link aggregate interface
66842       interface-description:
66843         type: string
66844         description: Human friendly text regarding this interface.
66845       resource-version:
66846         type: string
66847         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66848       speed-value:
66849         type: string
66850         description: Captures the numeric part of the speed
66851       speed-units:
66852         type: string
66853         description: Captures the units corresponding to the speed
66854       interface-id:
66855         type: string
66856         description: ID of interface
66857       interface-role:
66858         type: string
66859         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
66860       prov-status:
66861         type: string
66862         description: Trigger for operational monitoring of this resource by Service Assurance systems.
66863       in-maint:
66864         type: boolean
66865       relationship-list:
66866         type: array
66867         items:
66868           $ref: "#/getDefinitions/relationship"
66869       l-interfaces:
66870         type: array
66871         items:
66872           $ref: "#/getDefinitions/l-interface"
66873   lag-interfaces:
66874     description: |
66875       Collection of link aggregate interfaces.
66876     properties:
66877       lag-interface:
66878         type: array
66879         items:
66880           $ref: "#/getDefinitions/lag-interface"
66881   lag-link:
66882     description: |
66883       LAG links can connect lag-interfaces
66884       ###### Related Nodes
66885       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
66886       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
66887     required:
66888     - link-name
66889     properties:
66890       link-name:
66891         type: string
66892         description: Alphabetical concatenation of lag-interface names
66893       resource-version:
66894         type: string
66895         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66896       relationship-list:
66897         type: array
66898         items:
66899           $ref: "#/getDefinitions/relationship"
66900   lag-links:
66901     description: |
66902       Collection of link aggregation connections
66903     properties:
66904       lag-link:
66905         type: array
66906         items:
66907           $ref: "#/getDefinitions/lag-link"
66908   license:
66909     description: |
66910       Metadata for license group.
66911       ###### Related Nodes
66912       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66913       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66914     required:
66915     - group-uuid
66916     - resource-uuid
66917     properties:
66918       group-uuid:
66919         type: string
66920         description: Unique ID for the license group the resource belongs to, should be uuid.
66921       resource-uuid:
66922         type: string
66923         description: Unique ID of a license resource.
66924       resource-version:
66925         type: string
66926         description: Concurrency value
66927       relationship-list:
66928         type: array
66929         items:
66930           $ref: "#/getDefinitions/relationship"
66931   licenses:
66932     description: |
66933       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
66934     properties:
66935       license:
66936         type: array
66937         items:
66938           $ref: "#/getDefinitions/license"
66939   line-of-business:
66940     description: |
66941       describes a line-of-business
66942       ###### Related Nodes
66943       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
66944     required:
66945     - line-of-business-name
66946     properties:
66947       line-of-business-name:
66948         type: string
66949         description: Name of the line-of-business (product)
66950       resource-version:
66951         type: string
66952         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66953       relationship-list:
66954         type: array
66955         items:
66956           $ref: "#/getDefinitions/relationship"
66957   lines-of-business:
66958     description: |
66959       Collection of lines-of-business
66960     properties:
66961       line-of-business:
66962         type: array
66963         items:
66964           $ref: "#/getDefinitions/line-of-business"
66965   logical-link:
66966     description: |
66967       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
66968       ###### Related Nodes
66969       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
66970       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
66971       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
66972       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
66973       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
66974       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66975       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
66976       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
66977       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
66978       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
66979       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
66980       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
66981       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66982       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
66983       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
66984       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
66985       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66986       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66987     required:
66988     - link-name
66989     - in-maint
66990     - link-type
66991     properties:
66992       link-name:
66993         type: string
66994         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
66995       in-maint:
66996         type: boolean
66997       link-type:
66998         type: string
66999         description: Type of logical link, e.g., evc
67000       speed-value:
67001         type: string
67002         description: Captures the numeric part of the speed
67003       speed-units:
67004         type: string
67005         description: Captures the units corresponding to the speed
67006       ip-version:
67007         type: string
67008         description: v4, v6, or ds for dual stack
67009       routing-protocol:
67010         type: string
67011         description: For example, static or BGP
67012       resource-version:
67013         type: string
67014         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67015       model-invariant-id:
67016         type: string
67017         description: the ASDC model id for this resource or service model.
67018       model-version-id:
67019         type: string
67020         description: the ASDC model version for this resource or service model.
67021       persona-model-version:
67022         type: string
67023         description: the ASDC model version for this resource or service model.
67024       widget-model-id:
67025         type: string
67026         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
67027       widget-model-version:
67028         type: string
67029         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
67030       operational-status:
67031         type: string
67032         description: Indication of operational status of the logical link.
67033       prov-status:
67034         type: string
67035         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
67036       link-role:
67037         type: string
67038         description: Indication of the network use of the logical link.
67039       link-name2:
67040         type: string
67041         description: Alias or alternate name (CLCI or D1 name).
67042       link-id:
67043         type: string
67044         description: UUID of the logical-link, SDNC generates this.
67045       circuit-id:
67046         type: string
67047         description: Circuit id
67048       purpose:
67049         type: string
67050         description: Reason for this entity, role it is playing
67051       relationship-list:
67052         type: array
67053         items:
67054           $ref: "#/getDefinitions/relationship"
67055   logical-links:
67056     description: |
67057       Collection of logical connections
67058     properties:
67059       logical-link:
67060         type: array
67061         items:
67062           $ref: "#/getDefinitions/logical-link"
67063   metadata:
67064     description: |
67065       Collection of metadatum (key/value pairs)
67066     properties:
67067       metadatum:
67068         type: array
67069         items:
67070           $ref: "#/getDefinitions/metadatum"
67071   metadatum:
67072     description: |
67073       Key/value pairs
67074       ###### Related Nodes
67075       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
67076       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
67077       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
67078       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
67079       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
67080     required:
67081     - metaname
67082     - metaval
67083     properties:
67084       metaname:
67085         type: string
67086       metaval:
67087         type: string
67088       resource-version:
67089         type: string
67090         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67091   model:
67092     description: |
67093       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
67094       ###### Related Nodes
67095       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
67096       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
67097       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
67098       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
67099       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
67100       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
67101       - MODEL is DELETED when these are DELETED MODEL-VER
67102     required:
67103     - model-invariant-id
67104     - model-type
67105     properties:
67106       model-invariant-id:
67107         type: string
67108         description: Unique identifier corresponding to the main definition of a model in ASDC
67109       model-type:
67110         type: string
67111         description: Type of the model, e.g., service, resource, widget, etc.
67112       resource-version:
67113         type: string
67114         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67115       model-vers:
67116         type: array
67117         items:
67118           $ref: "#/getDefinitions/model-ver"
67119       relationship-list:
67120         type: array
67121         items:
67122           $ref: "#/getDefinitions/relationship"
67123   model-and-named-query-search:
67124     description: |
67125       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
67126     properties:
67127       query-parameters:
67128         type: object
67129         $ref: "#/getDefinitions/query-parameters"
67130       instance-filters:
67131         type: object
67132         $ref: "#/getDefinitions/instance-filters"
67133       secondary-filts:
67134         type: object
67135         $ref: "#/getDefinitions/secondary-filts"
67136       top-node-type:
67137         type: string
67138       secondary-filter-cut-point:
67139         type: string
67140   model-constraint:
67141     description: |
67142       This is how we would capture constraints defining allowed sets of elements.
67143       ###### Related Nodes
67144       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
67145       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
67146       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
67147     required:
67148     - model-constraint-uuid
67149     - constrained-element-set-uuid-to-replace
67150     properties:
67151       model-constraint-uuid:
67152         type: string
67153       constrained-element-set-uuid-to-replace:
67154         type: string
67155       constrained-element-sets:
67156         type: array
67157         items:
67158           $ref: "#/getDefinitions/constrained-element-set"
67159       resource-version:
67160         type: string
67161         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67162   model-constraints:
67163     properties:
67164       model-constraint:
67165         type: array
67166         items:
67167           $ref: "#/getDefinitions/model-constraint"
67168   model-element:
67169     description: |
67170       Defines how other models combine to make up a higher-level model.
67171       ###### Related Nodes
67172       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
67173       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
67174       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
67175       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
67176       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
67177       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
67178       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
67179       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
67180     required:
67181     - model-element-uuid
67182     - new-data-del-flag
67183     - cardinality
67184     properties:
67185       model-element-uuid:
67186         type: string
67187       new-data-del-flag:
67188         type: string
67189         description: Indicates whether this element was created as part of instantiation from this model
67190       cardinality:
67191         type: string
67192         description: How many of this type of element are required/allowed
67193       linkage-points:
67194         type: string
67195       resource-version:
67196         type: string
67197         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67198       model-elements:
67199         type: array
67200         items:
67201           $ref: "#/getDefinitions/model-element"
67202         description: Defines how other models combine to make up a higher-level model
67203       model-constraints:
67204         type: array
67205         items:
67206           $ref: "#/getDefinitions/model-constraint"
67207         description: Describes new constraints on this model element that are not part of that model's definition
67208       relationship-list:
67209         type: array
67210         items:
67211           $ref: "#/getDefinitions/relationship"
67212   model-elements:
67213     properties:
67214       model-element:
67215         type: array
67216         items:
67217           $ref: "#/getDefinitions/model-element"
67218   model-ver:
67219     description: |
67220       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
67221       ###### Related Nodes
67222       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
67223       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
67224       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
67225       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
67226       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
67227       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
67228       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
67229       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
67230       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
67231       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
67232       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
67233       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
67234     required:
67235     - model-version-id
67236     - model-name
67237     - model-version
67238     properties:
67239       model-version-id:
67240         type: string
67241         description: Unique identifier corresponding to one version of a model in ASDC
67242       model-name:
67243         type: string
67244         description: Name of the model, which can change from version to version.
67245       model-version:
67246         type: string
67247         description: Version
67248       distribution-status:
67249         type: string
67250         description: Distribution Status
67251       model-description:
67252         type: string
67253         description: Description
67254       resource-version:
67255         type: string
67256         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67257       model-elements:
67258         type: array
67259         items:
67260           $ref: "#/getDefinitions/model-element"
67261       metadata:
67262         type: array
67263         items:
67264           $ref: "#/getDefinitions/metadatum"
67265       relationship-list:
67266         type: array
67267         items:
67268           $ref: "#/getDefinitions/relationship"
67269   model-vers:
67270     properties:
67271       model-ver:
67272         type: array
67273         items:
67274           $ref: "#/getDefinitions/model-ver"
67275   models:
67276     description: |
67277       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
67278     properties:
67279       model:
67280         type: array
67281         items:
67282           $ref: "#/getDefinitions/model"
67283   multicast-configuration:
67284     description: |
67285       ###### Related Nodes
67286       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
67287     required:
67288     - multicast-configuration-id
67289     - multicast-protocol
67290     - rp-type
67291     properties:
67292       multicast-configuration-id:
67293         type: string
67294         description: Unique id of multicast configuration.
67295       multicast-protocol:
67296         type: string
67297         description: protocol of multicast configuration
67298       rp-type:
67299         type: string
67300         description: rp type of multicast configuration
67301       resource-version:
67302         type: string
67303         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67304       relationship-list:
67305         type: array
67306         items:
67307           $ref: "#/getDefinitions/relationship"
67308   multicast-configurations:
67309     description: |
67310       multicast configuration of generic-vnf ip-address
67311     properties:
67312       multicast-configuration:
67313         type: array
67314         items:
67315           $ref: "#/getDefinitions/multicast-configuration"
67316   named-queries:
67317     properties:
67318       named-query:
67319         type: array
67320         items:
67321           $ref: "#/getDefinitions/named-query"
67322   named-query:
67323     description: |
67324       TBD
67325       ###### Related Nodes
67326       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
67327       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
67328       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
67329       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
67330     required:
67331     - named-query-uuid
67332     - named-query-name
67333     - named-query-version
67334     properties:
67335       named-query-uuid:
67336         type: string
67337       named-query-name:
67338         type: string
67339       named-query-version:
67340         type: string
67341       required-input-param:
67342         type: string
67343       description:
67344         type: string
67345       resource-version:
67346         type: string
67347       named-query-elements:
67348         type: array
67349         items:
67350           $ref: "#/getDefinitions/named-query-element"
67351       relationship-list:
67352         type: array
67353         items:
67354           $ref: "#/getDefinitions/relationship"
67355   named-query-element:
67356     description: |
67357       TBD
67358       ###### Related Nodes
67359       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
67360       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
67361       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67362       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67363       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67364       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67365       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
67366     required:
67367     - named-query-element-uuid
67368     properties:
67369       named-query-element-uuid:
67370         type: string
67371       property-collect-list:
67372         type: string
67373       resource-version:
67374         type: string
67375       property-limit-desc:
67376         type: string
67377       do-not-output:
67378         type: string
67379       named-query-elements:
67380         type: array
67381         items:
67382           $ref: "#/getDefinitions/named-query-element"
67383       related-lookups:
67384         type: array
67385         items:
67386           $ref: "#/getDefinitions/related-lookup"
67387       property-constraints:
67388         type: array
67389         items:
67390           $ref: "#/getDefinitions/property-constraint"
67391       relationship-list:
67392         type: array
67393         items:
67394           $ref: "#/getDefinitions/relationship"
67395   named-query-elements:
67396     properties:
67397       named-query-element:
67398         type: array
67399         items:
67400           $ref: "#/getDefinitions/named-query-element"
67401   network:
67402     description: |
67403       Namespace for network inventory resources.
67404     properties:
67405       logical-links:
67406         type: array
67407         items:
67408           $ref: "#/getDefinitions/logical-link"
67409       site-pair-sets:
67410         type: array
67411         items:
67412           $ref: "#/getDefinitions/site-pair-set"
67413       vpn-bindings:
67414         type: array
67415         items:
67416           $ref: "#/getDefinitions/vpn-binding"
67417       vpls-pes:
67418         type: array
67419         items:
67420           $ref: "#/getDefinitions/vpls-pe"
67421       multicast-configurations:
67422         type: array
67423         items:
67424           $ref: "#/getDefinitions/multicast-configuration"
67425       vces:
67426         type: array
67427         items:
67428           $ref: "#/getDefinitions/vce"
67429       vnfcs:
67430         type: array
67431         items:
67432           $ref: "#/getDefinitions/vnfc"
67433       l3-networks:
67434         type: array
67435         items:
67436           $ref: "#/getDefinitions/l3-network"
67437       network-policies:
67438         type: array
67439         items:
67440           $ref: "#/getDefinitions/network-policy"
67441       generic-vnfs:
67442         type: array
67443         items:
67444           $ref: "#/getDefinitions/generic-vnf"
67445       lag-links:
67446         type: array
67447         items:
67448           $ref: "#/getDefinitions/lag-link"
67449       newvces:
67450         type: array
67451         items:
67452           $ref: "#/getDefinitions/newvce"
67453       pnfs:
67454         type: array
67455         items:
67456           $ref: "#/getDefinitions/pnf"
67457       physical-links:
67458         type: array
67459         items:
67460           $ref: "#/getDefinitions/physical-link"
67461       ipsec-configurations:
67462         type: array
67463         items:
67464           $ref: "#/getDefinitions/ipsec-configuration"
67465       route-table-references:
67466         type: array
67467         items:
67468           $ref: "#/getDefinitions/route-table-reference"
67469       instance-groups:
67470         type: array
67471         items:
67472           $ref: "#/getDefinitions/instance-group"
67473       zones:
67474         type: array
67475         items:
67476           $ref: "#/getDefinitions/zone"
67477       configurations:
67478         type: array
67479         items:
67480           $ref: "#/getDefinitions/configuration"
67481       forwarding-paths:
67482         type: array
67483         items:
67484           $ref: "#/getDefinitions/forwarding-path"
67485   network-policies:
67486     properties:
67487       network-policy:
67488         type: array
67489         items:
67490           $ref: "#/getDefinitions/network-policy"
67491   network-policy:
67492     description: |
67493       ###### Related Nodes
67494       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
67495       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
67496     required:
67497     - network-policy-id
67498     properties:
67499       network-policy-id:
67500         type: string
67501         description: UUID representing unique key to this instance
67502       network-policy-fqdn:
67503         type: string
67504         description: Contrail FQDN for the policy
67505       heat-stack-id:
67506         type: string
67507         description: ID for the openStack Heat instance
67508       resource-version:
67509         type: string
67510         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67511       relationship-list:
67512         type: array
67513         items:
67514           $ref: "#/getDefinitions/relationship"
67515   network-profile:
67516     description: |
67517       Network profile populated by SDN-GP for SNMP
67518       ###### Related Nodes
67519       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
67520     required:
67521     - nm-profile-name
67522     properties:
67523       nm-profile-name:
67524         type: string
67525         description: Unique name of network profile.
67526       community-string:
67527         type: string
67528         description: Encrypted SNMP community string
67529       resource-version:
67530         type: string
67531         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67532       relationship-list:
67533         type: array
67534         items:
67535           $ref: "#/getDefinitions/relationship"
67536   network-profiles:
67537     description: |
67538       Collection of network profiles
67539     properties:
67540       network-profile:
67541         type: array
67542         items:
67543           $ref: "#/getDefinitions/network-profile"
67544   newvce:
67545     description: |
67546       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
67547       ###### Related Nodes
67548       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
67549       - NEWVCE is DELETED when these are DELETED L-INTERFACE
67550     required:
67551     - vnf-id2
67552     - vnf-name
67553     - vnf-type
67554     properties:
67555       vnf-id2:
67556         type: string
67557         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
67558       vnf-name:
67559         type: string
67560         description: Name of VNF.
67561       vnf-name2:
67562         type: string
67563         description: Alternate name of VNF.
67564       vnf-type:
67565         type: string
67566         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.
67567       prov-status:
67568         type: string
67569         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
67570       operational-status:
67571         type: string
67572         description: Indicator for whether the resource is considered operational
67573       license-key:
67574         type: string
67575         description: OBSOLETE -  do not use
67576       ipv4-oam-address:
67577         type: string
67578         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).
67579       equipment-role:
67580         type: string
67581         description: Client should send valid enumerated value.
67582       resource-version:
67583         type: string
67584         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67585       ipv4-loopback0-address:
67586         type: string
67587         description: v4 Loopback0 address
67588       orchestration-status:
67589         type: string
67590         description: Orchestration status of this VNF, mastered by MSO.
67591       heat-stack-id:
67592         type: string
67593         description: Heat stack id corresponding to this instance, managed by MSO
67594       mso-catalog-key:
67595         type: string
67596         description: Corresponds to the SDN-C catalog id used to configure this VCE
67597       relationship-list:
67598         type: array
67599         items:
67600           $ref: "#/getDefinitions/relationship"
67601       l-interfaces:
67602         type: array
67603         items:
67604           $ref: "#/getDefinitions/l-interface"
67605   newvces:
67606     description: |
67607       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
67608     properties:
67609       newvce:
67610         type: array
67611         items:
67612           $ref: "#/getDefinitions/newvce"
67613   notification-event:
67614     properties:
67615       cambria.partition:
67616         type: string
67617       notification-event-header:
67618         type: object
67619         $ref: "#/getDefinitions/notification-event-header"
67620   notification-event-header:
67621     properties:
67622       id:
67623         type: string
67624       timestamp:
67625         type: string
67626       source-name:
67627         type: string
67628       domain:
67629         type: string
67630       sequence-number:
67631         type: string
67632       severity:
67633         type: string
67634       event-type:
67635         type: string
67636       version:
67637         type: string
67638       action:
67639         type: string
67640       entity-type:
67641         type: string
67642       top-entity-type:
67643         type: string
67644       entity-link:
67645         type: string
67646       status:
67647         type: string
67648   notify:
67649     required:
67650     - event-id
67651     properties:
67652       event-id:
67653         type: string
67654       node-type:
67655         type: string
67656       event-trigger:
67657         type: string
67658       key-data:
67659         type: array
67660         items:
67661           $ref: "#/getDefinitions/key-data"
67662       selflink:
67663         type: string
67664   oam-network:
67665     description: |
67666       OAM network, to be deprecated shortly.  Do not use for new purposes.
67667       ###### Related Nodes
67668       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67669       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
67670       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
67671     required:
67672     - network-uuid
67673     - network-name
67674     - cvlan-tag
67675     properties:
67676       network-uuid:
67677         type: string
67678         description: UUID of the network. Unique across a cloud-region
67679       network-name:
67680         type: string
67681         description: Name of the network.
67682       cvlan-tag:
67683         type: integer
67684         format: int64
67685         description: cvlan-id
67686       ipv4-oam-gateway-address:
67687         type: string
67688         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
67689       ipv4-oam-gateway-address-prefix-length:
67690         type: integer
67691         format: int32
67692         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
67693       resource-version:
67694         type: string
67695         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67696       relationship-list:
67697         type: array
67698         items:
67699           $ref: "#/getDefinitions/relationship"
67700   oam-networks:
67701     description: |
67702       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
67703     properties:
67704       oam-network:
67705         type: array
67706         items:
67707           $ref: "#/getDefinitions/oam-network"
67708   operational-environment:
67709     description: |
67710       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
67711       ###### Related Nodes
67712       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
67713       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
67714     required:
67715     - operational-environment-id
67716     - operational-environment-name
67717     - operational-environment-type
67718     - operational-environment-status
67719     - tenant-context
67720     - workload-context
67721     properties:
67722       operational-environment-id:
67723         type: string
67724         description: UUID of an operational environment
67725       operational-environment-name:
67726         type: string
67727         description: Operational Environment name
67728       operational-environment-type:
67729         type: string
67730         description: Operational Environment Type.
67731       operational-environment-status:
67732         type: string
67733         description: Status
67734       tenant-context:
67735         type: string
67736         description: Tenant Context.
67737       workload-context:
67738         type: string
67739         description: Workload Context.
67740       resource-version:
67741         type: string
67742         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67743       relationship-list:
67744         type: array
67745         items:
67746           $ref: "#/getDefinitions/relationship"
67747   operational-environments:
67748     description: |
67749       a logical partition of the cloud which allows to have multiple environments in the production AIC.
67750     properties:
67751       operational-environment:
67752         type: array
67753         items:
67754           $ref: "#/getDefinitions/operational-environment"
67755   overloaded-model:
67756     description: |
67757       Allows for legacy POST of old-style and new-style models
67758     required:
67759     - model-invariant-id
67760     - model-name-version-id
67761     - model-type
67762     - model-name
67763     - model-id
67764     - model-version
67765     properties:
67766       model-invariant-id:
67767         type: string
67768         description: Unique identifier corresponding to the main definition of a model in ASDC
67769       model-name-version-id:
67770         type: string
67771         description: Unique identifier corresponding to one version of a model in ASDC
67772       model-type:
67773         type: string
67774         description: Type of the model, e.g., service, resource, widget, etc.
67775       model-name:
67776         type: string
67777         description: Name of the model, which can change from version to version.
67778       model-id:
67779         type: string
67780         description: Invariant unique ID which does not change from version to version
67781       model-version:
67782         type: string
67783         description: Version
67784       model-description:
67785         type: string
67786         description: Description
67787       resource-version:
67788         type: string
67789         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67790       model-vers:
67791         type: object
67792         $ref: "#/getDefinitions/model-vers"
67793       relationship-list:
67794         type: object
67795         $ref: "#/getDefinitions/relationship-list"
67796   owning-entities:
67797     description: |
67798       Collection of owning-entities
67799     properties:
67800       owning-entity:
67801         type: array
67802         items:
67803           $ref: "#/getDefinitions/owning-entity"
67804   owning-entity:
67805     description: |
67806       describes an owning-entity
67807       ###### Related Nodes
67808       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
67809     required:
67810     - owning-entity-id
67811     - owning-entity-name
67812     properties:
67813       owning-entity-id:
67814         type: string
67815         description: UUID of an owning entity
67816       owning-entity-name:
67817         type: string
67818         description: Owning entity name
67819       resource-version:
67820         type: string
67821         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67822       relationship-list:
67823         type: array
67824         items:
67825           $ref: "#/getDefinitions/relationship"
67826   p-interface:
67827     description: |
67828       Physical interface (e.g., nic)
67829       ###### Related Nodes
67830       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
67831       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
67832       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
67833       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
67834       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
67835       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
67836       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
67837       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
67838       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
67839       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
67840       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
67841     required:
67842     - interface-name
67843     - in-maint
67844     properties:
67845       interface-name:
67846         type: string
67847         description: Name that identifies the physical interface
67848       selflink:
67849         type: string
67850         description: URL to endpoint where AAI can get more details.
67851       speed-value:
67852         type: string
67853         description: Captures the numeric part of the speed
67854       speed-units:
67855         type: string
67856         description: Captures the units corresponding to the speed
67857       port-description:
67858         type: string
67859         description: Nature of the services and connectivity on this port.
67860       equipment-identifier:
67861         type: string
67862         description: CLEI or other specification for p-interface hardware.
67863       interface-role:
67864         type: string
67865         description: Role specification for p-interface hardware.
67866       interface-type:
67867         type: string
67868         description: Indicates the physical properties of the interface.
67869       prov-status:
67870         type: string
67871         description: Trigger for operational monitoring of this resource by Service Assurance systems.
67872       mac-addresss:
67873         type: string
67874         description: MAC Address of the p-interface.
67875       resource-version:
67876         type: string
67877         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67878       in-maint:
67879         type: boolean
67880       inv-status:
67881         type: string
67882         description: inventory status
67883       relationship-list:
67884         type: array
67885         items:
67886           $ref: "#/getDefinitions/relationship"
67887       sriov-pfs:
67888         type: array
67889         items:
67890           $ref: "#/getDefinitions/sriov-pf"
67891       l-interfaces:
67892         type: array
67893         items:
67894           $ref: "#/getDefinitions/l-interface"
67895   p-interfaces:
67896     description: |
67897       Collection of physical interfaces.
67898     properties:
67899       p-interface:
67900         type: array
67901         items:
67902           $ref: "#/getDefinitions/p-interface"
67903   physical-link:
67904     description: |
67905       Collection of physical connections, typically between p-interfaces
67906       ###### Related Nodes
67907       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
67908     required:
67909     - link-name
67910     properties:
67911       link-name:
67912         type: string
67913         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
67914       speed-value:
67915         type: string
67916         description: Captures the numeric part of the speed
67917       speed-units:
67918         type: string
67919         description: Captures the units corresponding to the speed
67920       circuit-id:
67921         type: string
67922         description: Circuit it
67923       dual-mode:
67924         type: string
67925         description: Dual access mode (e.g., primary, secondary
67926       management-option:
67927         type: string
67928         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
67929       service-provider-name:
67930         type: string
67931         description: Name of the service Provider on this link.
67932       service-provider-bandwidth-up-value:
67933         type: integer
67934         format: int32
67935         description: Upstream Bandwidth value agreed with the service provider
67936       service-provider-bandwidth-up-units:
67937         type: string
67938         description: Units for the upstream BW value
67939       service-provider-bandwidth-down-value:
67940         type: integer
67941         format: int32
67942         description: Downstream Bandwidth value agreed with the service provider
67943       service-provider-bandwidth-down-units:
67944         type: string
67945         description: Units for downstream BW value
67946       resource-version:
67947         type: string
67948         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67949       relationship-list:
67950         type: array
67951         items:
67952           $ref: "#/getDefinitions/relationship"
67953   physical-links:
67954     description: |
67955       Collection of physical connections, typically between p-interfaces
67956     properties:
67957       physical-link:
67958         type: array
67959         items:
67960           $ref: "#/getDefinitions/physical-link"
67961   platform:
67962     description: |
67963       describes a platform
67964       ###### Related Nodes
67965       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
67966     required:
67967     - platform-name
67968     properties:
67969       platform-name:
67970         type: string
67971         description: Name of the platform
67972       resource-version:
67973         type: string
67974         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67975       relationship-list:
67976         type: array
67977         items:
67978           $ref: "#/getDefinitions/relationship"
67979   platforms:
67980     description: |
67981       Collection of platforms
67982     properties:
67983       platform:
67984         type: array
67985         items:
67986           $ref: "#/getDefinitions/platform"
67987   pnf:
67988     description: |
67989       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.
67990       ###### Related Nodes
67991       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67992       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67993       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67994       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
67995       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
67996       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
67997       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
67998       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
67999       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
68000       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
68001       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
68002     required:
68003     - pnf-name
68004     - in-maint
68005     properties:
68006       pnf-name:
68007         type: string
68008         description: unique name of Physical Network Function.
68009       pnf-name2:
68010         type: string
68011         description: name of Physical Network Function.
68012       selflink:
68013         type: string
68014         description: URL to endpoint where AAI can get more details.
68015       pnf-name2-source:
68016         type: string
68017         description: source of name2
68018       pnf-id:
68019         type: string
68020         description: id of pnf
68021       equip-type:
68022         type: string
68023         description: Equipment type.  Source of truth should define valid values.
68024       equip-vendor:
68025         type: string
68026         description: Equipment vendor.  Source of truth should define valid values.
68027       equip-model:
68028         type: string
68029         description: Equipment model.  Source of truth should define valid values.
68030       management-option:
68031         type: string
68032         description: identifier of managed by ATT or customer
68033       ipaddress-v4-oam:
68034         type: string
68035         description: ipv4-oam-address with new naming convention for IP addresses
68036       sw-version:
68037         type: string
68038         description: sw-version is the version of SW for the hosted application on the PNF.
68039       in-maint:
68040         type: boolean
68041       frame-id:
68042         type: string
68043         description: ID of the physical frame (relay rack) where pnf is installed.
68044       serial-number:
68045         type: string
68046         description: Serial number of the device
68047       ipaddress-v4-loopback-0:
68048         type: string
68049         description: IPV4 Loopback 0 address
68050       ipaddress-v6-loopback-0:
68051         type: string
68052         description: IPV6 Loopback 0 address
68053       ipaddress-v4-aim:
68054         type: string
68055         description: IPV4 AIM address
68056       ipaddress-v6-aim:
68057         type: string
68058         description: IPV6 AIM address
68059       ipaddress-v6-oam:
68060         type: string
68061         description: IPV6 OAM address
68062       inv-status:
68063         type: string
68064         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
68065       resource-version:
68066         type: string
68067         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68068       prov-status:
68069         type: string
68070         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
68071       nf-role:
68072         type: string
68073         description: Nf Role is the role performed by this instance in the network.
68074       relationship-list:
68075         type: array
68076         items:
68077           $ref: "#/getDefinitions/relationship"
68078       p-interfaces:
68079         type: array
68080         items:
68081           $ref: "#/getDefinitions/p-interface"
68082       lag-interfaces:
68083         type: array
68084         items:
68085           $ref: "#/getDefinitions/lag-interface"
68086   pnfs:
68087     description: |
68088       Collection of Physical Network Functions.
68089     properties:
68090       pnf:
68091         type: array
68092         items:
68093           $ref: "#/getDefinitions/pnf"
68094   port-group:
68095     description: |
68096       Used to capture the network interfaces of this VCE
68097       ###### Related Nodes
68098       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
68099       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
68100       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
68101     required:
68102     - interface-id
68103     - orchestration-status
68104     properties:
68105       interface-id:
68106         type: string
68107         description: Unique ID of the interface
68108       neutron-network-id:
68109         type: string
68110         description: Neutron network id of this Interface
68111       neutron-network-name:
68112         type: string
68113         description: Neutron network name of this Interface
68114       interface-role:
68115         type: string
68116         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
68117       resource-version:
68118         type: string
68119         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68120       port-group-id:
68121         type: string
68122         description: Unique ID for port group in vmware
68123       port-group-name:
68124         type: string
68125         description: Likely to duplicate value of neutron network name
68126       switch-name:
68127         type: string
68128         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
68129       orchestration-status:
68130         type: string
68131         description: Orchestration status of this VNF, mastered by MSO
68132       heat-stack-id:
68133         type: string
68134         description: Heat stack id corresponding to this instance, managed by MSO
68135       mso-catalog-key:
68136         type: string
68137         description: Corresponds to the SDN-C catalog id used to configure this VCE
68138       cvlan-tags:
68139         type: array
68140         items:
68141           $ref: "#/getDefinitions/cvlan-tag-entry"
68142       relationship-list:
68143         type: array
68144         items:
68145           $ref: "#/getDefinitions/relationship"
68146   port-groups:
68147     properties:
68148       port-group:
68149         type: array
68150         items:
68151           $ref: "#/getDefinitions/port-group"
68152   project:
68153     description: |
68154       describes the project
68155       ###### Related Nodes
68156       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
68157     required:
68158     - project-name
68159     properties:
68160       project-name:
68161         type: string
68162         description: Name of the project deploying a service
68163       resource-version:
68164         type: string
68165         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68166       relationship-list:
68167         type: array
68168         items:
68169           $ref: "#/getDefinitions/relationship"
68170   projects:
68171     description: |
68172       Collection of projects
68173     properties:
68174       project:
68175         type: array
68176         items:
68177           $ref: "#/getDefinitions/project"
68178   properties:
68179     description: |
68180       Property holder for query properties or instance properties
68181     properties:
68182       property-name:
68183         type: string
68184       property-value:
68185         type: string
68186   property-constraint:
68187     description: |
68188       TBD
68189       ###### Related Nodes
68190       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
68191     required:
68192     - property-constraint-uuid
68193     - constraint-type
68194     - property-name
68195     - property-value
68196     properties:
68197       property-constraint-uuid:
68198         type: string
68199       constraint-type:
68200         type: string
68201       property-name:
68202         type: string
68203       property-value:
68204         type: string
68205       resource-version:
68206         type: string
68207   property-constraints:
68208     properties:
68209       property-constraint:
68210         type: array
68211         items:
68212           $ref: "#/getDefinitions/property-constraint"
68213   pserver:
68214     description: |
68215       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
68216       ###### Related Nodes
68217       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
68218       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
68219       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
68220       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
68221       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68222       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
68223       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
68224       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
68225       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
68226       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
68227       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
68228       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
68229       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
68230     required:
68231     - hostname
68232     - in-maint
68233     properties:
68234       hostname:
68235         type: string
68236         description: Value from executing hostname on the compute node.
68237       ptnii-equip-name:
68238         type: string
68239         description: PTNII name
68240       number-of-cpus:
68241         type: integer
68242         format: int32
68243         description: Number of cpus
68244       disk-in-gigabytes:
68245         type: integer
68246         format: int32
68247         description: Disk size, in GBs
68248       ram-in-megabytes:
68249         type: integer
68250         format: int32
68251         description: RAM size, in MBs
68252       equip-type:
68253         type: string
68254         description: Equipment type.  Source of truth should define valid values.
68255       equip-vendor:
68256         type: string
68257         description: Equipment vendor.  Source of truth should define valid values.
68258       equip-model:
68259         type: string
68260         description: Equipment model.  Source of truth should define valid values.
68261       fqdn:
68262         type: string
68263         description: Fully-qualified domain name
68264       pserver-selflink:
68265         type: string
68266         description: URL to endpoint where AAI can get more details
68267       ipv4-oam-address:
68268         type: string
68269         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
68270       serial-number:
68271         type: string
68272         description: Serial number, may be queried
68273       ipaddress-v4-loopback-0:
68274         type: string
68275         description: IPV4 Loopback 0 address
68276       ipaddress-v6-loopback-0:
68277         type: string
68278         description: IPV6 Loopback 0 address
68279       ipaddress-v4-aim:
68280         type: string
68281         description: IPV4 AIM address
68282       ipaddress-v6-aim:
68283         type: string
68284         description: IPV6 AIM address
68285       ipaddress-v6-oam:
68286         type: string
68287         description: IPV6 OAM address
68288       inv-status:
68289         type: string
68290         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
68291       pserver-id:
68292         type: string
68293         description: ID of Pserver
68294       internet-topology:
68295         type: string
68296         description: internet topology of Pserver
68297       in-maint:
68298         type: boolean
68299       resource-version:
68300         type: string
68301         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68302       pserver-name2:
68303         type: string
68304         description: alternative pserver name
68305       purpose:
68306         type: string
68307         description: purpose of pserver
68308       prov-status:
68309         type: string
68310         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
68311       management-option:
68312         type: string
68313         description: Indicates who owns and or manages the device.
68314       host-profile:
68315         type: string
68316         description: The host profile that defines the configuration of the pserver.
68317       relationship-list:
68318         type: array
68319         items:
68320           $ref: "#/getDefinitions/relationship"
68321       p-interfaces:
68322         type: array
68323         items:
68324           $ref: "#/getDefinitions/p-interface"
68325       lag-interfaces:
68326         type: array
68327         items:
68328           $ref: "#/getDefinitions/lag-interface"
68329   pservers:
68330     description: |
68331       Collection of compute hosts.
68332     properties:
68333       pserver:
68334         type: array
68335         items:
68336           $ref: "#/getDefinitions/pserver"
68337   query-parameters:
68338     description: |
68339       QueryParameters for performing a named-query or model query
68340     properties:
68341       named-query:
68342         type: object
68343         $ref: "#/getDefinitions/named-query"
68344       overloaded-model:
68345         type: object
68346         $ref: "#/getDefinitions/overloaded-model"
68347   related-lookup:
68348     description: |
68349       TBD
68350       ###### Related Nodes
68351       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
68352     required:
68353     - related-lookup-uuid
68354     - source-node-type
68355     - source-node-property
68356     - target-node-type
68357     - target-node-property
68358     properties:
68359       related-lookup-uuid:
68360         type: string
68361       source-node-type:
68362         type: string
68363       source-node-property:
68364         type: string
68365       target-node-type:
68366         type: string
68367       target-node-property:
68368         type: string
68369       property-collect-list:
68370         type: string
68371       resource-version:
68372         type: string
68373       relationship-list:
68374         type: array
68375         items:
68376           $ref: "#/getDefinitions/relationship"
68377   related-lookups:
68378     properties:
68379       related-lookup:
68380         type: array
68381         items:
68382           $ref: "#/getDefinitions/related-lookup"
68383   related-to-property:
68384     properties:
68385       property-key:
68386         type: string
68387         description: Key part of a key/value pair
68388       property-value:
68389         type: string
68390         description: Value part of a key/value pair
68391   relationship:
68392     properties:
68393       related-to:
68394         type: string
68395         description: A keyword provided by A&AI to indicate type of node.
68396       relationship-label:
68397         type: string
68398         description: The edge label for this relationship.
68399       related-link:
68400         type: string
68401         description: URL to the object in A&AI.
68402       relationship-data:
68403         type: array
68404         items:
68405           $ref: "#/getDefinitions/relationship-data"
68406       related-to-property:
68407         type: array
68408         items:
68409           $ref: "#/getDefinitions/related-to-property"
68410   relationship-data:
68411     required:
68412     - relationship-key
68413     - relationship-value
68414     properties:
68415       relationship-key:
68416         type: string
68417         description: A keyword provided by A&AI to indicate an attribute.
68418       relationship-value:
68419         type: string
68420         description: Value of the attribute.
68421   relationship-list:
68422     properties:
68423       relationship:
68424         type: array
68425         items:
68426           $ref: "#/getDefinitions/relationship"
68427   reserved-prop-names:
68428     description: |
68429       Internal map to define some reserved properties of a vertex
68430     properties:
68431       last-mod-source-of-truth:
68432         type: string
68433       aai-node-type:
68434         type: string
68435       aai-created-ts:
68436         type: integer
68437         format: int64
68438       aai-unique-key:
68439         type: string
68440       aai-last-mod-ts:
68441         type: integer
68442         format: int64
68443       source-of-truth:
68444         type: string
68445       aai-uri:
68446         type: string
68447   response-list:
68448     description: |
68449       Response container for the results of a named-query or model query
68450     properties:
68451       inventory-response-items:
68452         type: object
68453         $ref: "#/getDefinitions/inventory-response-items"
68454   result-data:
68455     properties:
68456       resource-type:
68457         type: string
68458         description: The specific type of node in the A&AI graph
68459       resource-link:
68460         type: string
68461         description: The URL to the specific resource
68462   route-table-reference:
68463     description: |
68464       Openstack route table reference.
68465       ###### Related Nodes
68466       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
68467     required:
68468     - route-table-reference-id
68469     - route-table-reference-fqdn
68470     properties:
68471       route-table-reference-id:
68472         type: string
68473         description: Route Table Reference id, UUID assigned to this instance.
68474       route-table-reference-fqdn:
68475         type: string
68476         description: FQDN entry in the route table.
68477       resource-version:
68478         type: string
68479         description: Concurrency value
68480       relationship-list:
68481         type: array
68482         items:
68483           $ref: "#/getDefinitions/relationship"
68484   route-table-references:
68485     description: |
68486       Collection of openstack route table references
68487     properties:
68488       route-table-reference:
68489         type: array
68490         items:
68491           $ref: "#/getDefinitions/route-table-reference"
68492   route-target:
68493     description: |
68494       Route target information
68495       ###### Related Nodes
68496       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
68497     required:
68498     - global-route-target
68499     - route-target-role
68500     properties:
68501       global-route-target:
68502         type: string
68503         description: Number used to identify an RT, globally unique in the network
68504       route-target-role:
68505         type: string
68506         description: Role assigned to this route target
68507       resource-version:
68508         type: string
68509         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68510       relationship-list:
68511         type: array
68512         items:
68513           $ref: "#/getDefinitions/relationship"
68514   route-targets:
68515     description: |
68516       Collection of route target information
68517     properties:
68518       route-target:
68519         type: array
68520         items:
68521           $ref: "#/getDefinitions/route-target"
68522   routing-instance:
68523     description: |
68524       ###### Related Nodes
68525       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
68526       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
68527       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
68528     required:
68529     - routing-instance-id
68530     properties:
68531       routing-instance-id:
68532         type: string
68533         description: Unique id of routing instance
68534       rpm-owner:
68535         type: string
68536         description: rpm owner
68537       resource-version:
68538         type: string
68539         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68540       site-pairs:
68541         type: array
68542         items:
68543           $ref: "#/getDefinitions/site-pair"
68544       relationship-list:
68545         type: array
68546         items:
68547           $ref: "#/getDefinitions/relationship"
68548   routing-instances:
68549     description: |
68550       set of probes related to generic-vnf routing instance
68551     properties:
68552       routing-instance:
68553         type: array
68554         items:
68555           $ref: "#/getDefinitions/routing-instance"
68556   sdn-zone-response:
68557     properties:
68558       oam-networks:
68559         type: object
68560         $ref: "#/getDefinitions/oam-networks"
68561       az-and-dvs-switches:
68562         type: array
68563         items:
68564           $ref: "#/getDefinitions/az-and-dvs-switches"
68565   search:
68566     properties:
68567       edge-tag-query-result:
68568         type: object
68569         $ref: "#/getDefinitions/edge-tag-query-result"
68570       edge-tag-query-request:
68571         type: object
68572         $ref: "#/getDefinitions/edge-tag-query-request"
68573       search-results:
68574         type: object
68575         $ref: "#/getDefinitions/search-results"
68576       sdn-zone-response:
68577         type: object
68578         $ref: "#/getDefinitions/sdn-zone-response"
68579   search-results:
68580     properties:
68581       result-data:
68582         type: array
68583         items:
68584           $ref: "#/getDefinitions/result-data"
68585   secondary-filt:
68586     description: |
68587       SecondaryFilt for performing a named-query or model query
68588   secondary-filter:
68589     properties:
68590       property-name:
68591         type: string
68592       filter-type:
68593         type: string
68594       property-value:
68595         type: string
68596   secondary-filts:
68597     description: |
68598       SecondaryFilts for performing a named-query or model query
68599     properties:
68600       secondary-filt:
68601         type: array
68602         items:
68603           $ref: "#/getDefinitions/secondary-filt"
68604   segmentation-assignment:
68605     description: |
68606       Openstack segmentation assignment.
68607       ###### Related Nodes
68608       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
68609     required:
68610     - segmentation-id
68611     properties:
68612       segmentation-id:
68613         type: string
68614         description: Route Table Reference id, UUID assigned to this instance.
68615       resource-version:
68616         type: string
68617         description: Concurrency value
68618       relationship-list:
68619         type: array
68620         items:
68621           $ref: "#/getDefinitions/relationship"
68622   segmentation-assignments:
68623     description: |
68624       Collection of openstack segmentation assignments
68625     properties:
68626       segmentation-assignment:
68627         type: array
68628         items:
68629           $ref: "#/getDefinitions/segmentation-assignment"
68630   service:
68631     description: |
68632       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
68633     required:
68634     - service-id
68635     - service-description
68636     properties:
68637       service-id:
68638         type: string
68639         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
68640       service-description:
68641         type: string
68642         description: Description of the service
68643       service-selflink:
68644         type: string
68645         description: URL to endpoint where AAI can get more details
68646       resource-version:
68647         type: string
68648         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68649       service-version:
68650         type: string
68651         description: service version
68652       relationship-list:
68653         type: array
68654         items:
68655           $ref: "#/getDefinitions/relationship"
68656   service-capabilities:
68657     description: |
68658       Collection of service capabilities.
68659     properties:
68660       service-capability:
68661         type: array
68662         items:
68663           $ref: "#/getDefinitions/service-capability"
68664   service-capability:
68665     description: |
68666       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
68667       ###### Related Nodes
68668       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
68669       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
68670       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
68671     required:
68672     - service-type
68673     - vnf-type
68674     properties:
68675       service-type:
68676         type: string
68677         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
68678       vnf-type:
68679         type: string
68680         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.
68681       resource-version:
68682         type: string
68683         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68684       relationship-list:
68685         type: array
68686         items:
68687           $ref: "#/getDefinitions/relationship"
68688   service-design-and-creation:
68689     description: |
68690       Namespace for objects managed by ASDC
68691     properties:
68692       vnf-images:
68693         type: array
68694         items:
68695           $ref: "#/getDefinitions/vnf-image"
68696       services:
68697         type: array
68698         items:
68699           $ref: "#/getDefinitions/service"
68700       service-capabilities:
68701         type: array
68702         items:
68703           $ref: "#/getDefinitions/service-capability"
68704       models:
68705         type: array
68706         items:
68707           $ref: "#/getDefinitions/model"
68708       named-queries:
68709         type: array
68710         items:
68711           $ref: "#/getDefinitions/named-query"
68712   service-instance:
68713     description: |
68714       Instance of a service
68715       ###### Related Nodes
68716       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
68717       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
68718       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
68719       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
68720       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
68721       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
68722       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
68723       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
68724       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
68725       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
68726       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
68727       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
68728       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
68729       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68730       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
68731       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
68732       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
68733       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
68734       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
68735       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
68736       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
68737       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
68738       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
68739       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
68740     required:
68741     - service-instance-id
68742     - service-type
68743     - service-role
68744     - created-at
68745     - updated-at
68746     - description
68747     properties:
68748       service-instance-id:
68749         type: string
68750         description: Uniquely identifies this instance of a service
68751       service-instance-name:
68752         type: string
68753         description: This field will store a name assigned to the service-instance.
68754       service-type:
68755         type: string
68756         description: String capturing type of service.
68757       service-role:
68758         type: string
68759         description: String capturing the service role.
68760       environment-context:
68761         type: string
68762         description: This field will store the environment context assigned to the service-instance.
68763       workload-context:
68764         type: string
68765         description: This field will store the workload context assigned to the service-instance.
68766       created-at:
68767         type: string
68768         description: create time of Network Service.
68769       updated-at:
68770         type: string
68771         description: last update of Network Service.
68772       description:
68773         type: string
68774         description: short description for service-instance.
68775       model-invariant-id:
68776         type: string
68777         description: the ASDC model id for this resource or service model.
68778       model-version-id:
68779         type: string
68780         description: the ASDC model version for this resource or service model.
68781       persona-model-version:
68782         type: string
68783         description: the ASDC model version for this resource or service model.
68784       widget-model-id:
68785         type: string
68786         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
68787       widget-model-version:
68788         type: string
68789         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
68790       bandwidth-total:
68791         type: string
68792         description: Indicates the total bandwidth to be used for this service.
68793       bandwidth-up-wan1:
68794         type: string
68795         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
68796       bandwidth-down-wan1:
68797         type: string
68798         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
68799       bandwidth-up-wan2:
68800         type: string
68801         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
68802       bandwidth-down-wan2:
68803         type: string
68804         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
68805       vhn-portal-url:
68806         type: string
68807         description: URL customers will use to access the vHN Portal.
68808       service-instance-location-id:
68809         type: string
68810         description: An identifier that customers assign to the location where this service is being used.
68811       resource-version:
68812         type: string
68813         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68814       selflink:
68815         type: string
68816         description: Path to the controller object.
68817       orchestration-status:
68818         type: string
68819         description: Orchestration status of this service.
68820       relationship-list:
68821         type: array
68822         items:
68823           $ref: "#/getDefinitions/relationship"
68824       metadata:
68825         type: array
68826         items:
68827           $ref: "#/getDefinitions/metadatum"
68828       allotted-resources:
68829         type: array
68830         items:
68831           $ref: "#/getDefinitions/allotted-resource"
68832   service-instances:
68833     description: |
68834       Collection of service instances
68835     properties:
68836       service-instance:
68837         type: array
68838         items:
68839           $ref: "#/getDefinitions/service-instance"
68840   service-subscription:
68841     description: |
68842       Object that group service instances.
68843       ###### Related Nodes
68844       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
68845       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
68846       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
68847       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
68848     required:
68849     - service-type
68850     properties:
68851       service-type:
68852         type: string
68853         description: Value defined by orchestration to identify this service across ECOMP.
68854       temp-ub-sub-account-id:
68855         type: string
68856         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
68857       resource-version:
68858         type: string
68859         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68860       service-instances:
68861         type: array
68862         items:
68863           $ref: "#/getDefinitions/service-instance"
68864       relationship-list:
68865         type: array
68866         items:
68867           $ref: "#/getDefinitions/relationship"
68868   service-subscriptions:
68869     description: |
68870       Collection of objects that group service instances.
68871     properties:
68872       service-subscription:
68873         type: array
68874         items:
68875           $ref: "#/getDefinitions/service-subscription"
68876   services:
68877     description: |
68878       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
68879     properties:
68880       service:
68881         type: array
68882         items:
68883           $ref: "#/getDefinitions/service"
68884   site-pair:
68885     description: |
68886       ###### Related Nodes
68887       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
68888       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
68889       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
68890     required:
68891     - site-pair-id
68892     properties:
68893       site-pair-id:
68894         type: string
68895         description: unique identifier of probe
68896       source-ip:
68897         type: string
68898         description: Prefix address
68899       destination-ip:
68900         type: string
68901         description: Prefix address
68902       ip-version:
68903         type: string
68904         description: ip version, v4, v6
68905       destination-hostname:
68906         type: string
68907         description: Hostname of the destination equipment to which SLAs are measured against.
68908       destination-equip-type:
68909         type: string
68910         description: The type of destinatination equipment. Could be Router, UCPE, etc.
68911       resource-version:
68912         type: string
68913         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68914       classes-of-service:
68915         type: array
68916         items:
68917           $ref: "#/getDefinitions/class-of-service"
68918       relationship-list:
68919         type: array
68920         items:
68921           $ref: "#/getDefinitions/relationship"
68922   site-pair-set:
68923     description: |
68924       Set of instances for probes used to measure service level agreements
68925       ###### Related Nodes
68926       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
68927       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
68928       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
68929     required:
68930     - site-pair-set-id
68931     properties:
68932       site-pair-set-id:
68933         type: string
68934         description: Unique id of site pair set.
68935       resource-version:
68936         type: string
68937         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68938       routing-instances:
68939         type: array
68940         items:
68941           $ref: "#/getDefinitions/routing-instance"
68942       relationship-list:
68943         type: array
68944         items:
68945           $ref: "#/getDefinitions/relationship"
68946   site-pair-sets:
68947     description: |
68948       Collection of sets of instances for probes related to generic-vnf
68949     properties:
68950       site-pair-set:
68951         type: array
68952         items:
68953           $ref: "#/getDefinitions/site-pair-set"
68954   site-pairs:
68955     description: |
68956       probe within a set
68957     properties:
68958       site-pair:
68959         type: array
68960         items:
68961           $ref: "#/getDefinitions/site-pair"
68962   snapshot:
68963     description: |
68964       Openstack snapshot
68965       ###### Related Nodes
68966       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
68967       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
68968     required:
68969     - snapshot-id
68970     properties:
68971       snapshot-id:
68972         type: string
68973         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
68974       snapshot-name:
68975         type: string
68976         description: Snapshot name
68977       snapshot-architecture:
68978         type: string
68979         description: Operating system architecture
68980       snapshot-os-distro:
68981         type: string
68982         description: The common name of the operating system distribution in lowercase
68983       snapshot-os-version:
68984         type: string
68985         description: The operating system version as specified by the distributor.
68986       application:
68987         type: string
68988         description: The application that the image instantiates.
68989       application-vendor:
68990         type: string
68991         description: The vendor of the application.
68992       application-version:
68993         type: string
68994         description: The version of the application.
68995       snapshot-selflink:
68996         type: string
68997         description: URL to endpoint where AAI can get more details
68998       prev-snapshot-id:
68999         type: string
69000         description: This field contains the UUID of the previous snapshot (if any).
69001       resource-version:
69002         type: string
69003         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69004       relationship-list:
69005         type: array
69006         items:
69007           $ref: "#/getDefinitions/relationship"
69008   snapshots:
69009     description: |
69010       Collection of openstack snapshots
69011     properties:
69012       snapshot:
69013         type: array
69014         items:
69015           $ref: "#/getDefinitions/snapshot"
69016   sriov-pf:
69017     description: |
69018       SR-IOV Physical Function
69019       ###### Related Nodes
69020       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
69021       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
69022     required:
69023     - pf-pci-id
69024     properties:
69025       pf-pci-id:
69026         type: string
69027         description: Identifier for the sriov-pf
69028       resource-version:
69029         type: string
69030         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69031       relationship-list:
69032         type: array
69033         items:
69034           $ref: "#/getDefinitions/relationship"
69035   sriov-pfs:
69036     description: |
69037       Collection of SR-IOV Physical Functions.
69038     properties:
69039       sriov-pf:
69040         type: array
69041         items:
69042           $ref: "#/getDefinitions/sriov-pf"
69043   sriov-vf:
69044     description: |
69045       SR-IOV Virtual Function (not to be confused with virtual network function)
69046       ###### Related Nodes
69047       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
69048       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
69049     required:
69050     - pci-id
69051     properties:
69052       pci-id:
69053         type: string
69054         description: PCI ID used to identify the sriov-vf
69055       vf-vlan-filter:
69056         type: string
69057         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
69058       vf-mac-filter:
69059         type: string
69060         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
69061       vf-vlan-strip:
69062         type: boolean
69063         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
69064       vf-vlan-anti-spoof-check:
69065         type: boolean
69066         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.
69067       vf-mac-anti-spoof-check:
69068         type: boolean
69069         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.
69070       vf-mirrors:
69071         type: string
69072         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
69073       vf-broadcast-allow:
69074         type: boolean
69075         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
69076       vf-unknown-multicast-allow:
69077         type: boolean
69078         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
69079       vf-unknown-unicast-allow:
69080         type: boolean
69081         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
69082       vf-insert-stag:
69083         type: boolean
69084         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
69085       vf-link-status:
69086         type: string
69087         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
69088       resource-version:
69089         type: string
69090         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69091       neutron-network-id:
69092         type: string
69093         description: Neutron network id of the interface
69094       relationship-list:
69095         type: array
69096         items:
69097           $ref: "#/getDefinitions/relationship"
69098   sriov-vfs:
69099     description: |
69100       Collection of SR-IOV Virtual Functions.
69101     properties:
69102       sriov-vf:
69103         type: array
69104         items:
69105           $ref: "#/getDefinitions/sriov-vf"
69106   start-node-filter:
69107     properties:
69108       property-name:
69109         type: string
69110       property-value:
69111         type: string
69112   subnet:
69113     description: |
69114       ###### Related Nodes
69115       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
69116       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
69117       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
69118       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
69119       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
69120       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
69121       - 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
69122       - SUBNET is DELETED when these are DELETED HOST-ROUTE
69123     required:
69124     - subnet-id
69125     - dhcp-enabled
69126     properties:
69127       subnet-id:
69128         type: string
69129         description: Subnet ID, should be UUID.
69130       subnet-name:
69131         type: string
69132         description: Name associated with the subnet.
69133       neutron-subnet-id:
69134         type: string
69135         description: Neutron id of this subnet
69136       gateway-address:
69137         type: string
69138         description: gateway ip address
69139       network-start-address:
69140         type: string
69141         description: network start address
69142       cidr-mask:
69143         type: string
69144         description: cidr mask
69145       ip-version:
69146         type: string
69147         description: ip version
69148       orchestration-status:
69149         type: string
69150         description: Orchestration status of this VNF, mastered by MSO
69151       dhcp-enabled:
69152         type: boolean
69153       dhcp-start:
69154         type: string
69155         description: the start address reserved for use by dhcp
69156       dhcp-end:
69157         type: string
69158         description: the last address reserved for use by dhcp
69159       subnet-role:
69160         type: string
69161         description: role of the subnet, referenced when assigning IPs
69162       ip-assignment-direction:
69163         type: string
69164         description: ip address assignment direction of the subnet
69165       resource-version:
69166         type: string
69167         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69168       subnet-sequence:
69169         type: integer
69170         format: int32
69171         description: sequence of the subnet
69172       host-routes:
69173         type: array
69174         items:
69175           $ref: "#/getDefinitions/host-route"
69176       relationship-list:
69177         type: array
69178         items:
69179           $ref: "#/getDefinitions/relationship"
69180   subnets:
69181     properties:
69182       subnet:
69183         type: array
69184         items:
69185           $ref: "#/getDefinitions/subnet"
69186   tagged-inventory-item-list:
69187     properties:
69188       inventory-item:
69189         type: array
69190         items:
69191           $ref: "#/getDefinitions/inventory-item"
69192   tenant:
69193     description: |
69194       Openstack tenant
69195       ###### Related Nodes
69196       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69197       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
69198       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
69199       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
69200       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
69201       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
69202       - TENANT cannot be deleted if linked to VSERVER
69203     required:
69204     - tenant-id
69205     - tenant-name
69206     properties:
69207       tenant-id:
69208         type: string
69209         description: Unique id relative to the cloud-region.
69210       tenant-name:
69211         type: string
69212         description: Readable name of tenant
69213       tenant-context:
69214         type: string
69215         description: This field will store the tenant context.
69216       resource-version:
69217         type: string
69218         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69219       vservers:
69220         type: array
69221         items:
69222           $ref: "#/getDefinitions/vserver"
69223       relationship-list:
69224         type: array
69225         items:
69226           $ref: "#/getDefinitions/relationship"
69227   tenants:
69228     description: |
69229       Collection of openstack tenants.
69230     properties:
69231       tenant:
69232         type: array
69233         items:
69234           $ref: "#/getDefinitions/tenant"
69235   tunnel-xconnect:
69236     description: |
69237       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
69238       ###### Related Nodes
69239       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
69240     required:
69241     - id
69242     properties:
69243       id:
69244         type: string
69245         description: Allotted Resource id UUID assigned to this instance.
69246       bandwidth-up-wan1:
69247         type: string
69248         description: The WAN uplink bandwidth for WAN1
69249       bandwidth-down-wan1:
69250         type: string
69251         description: The WAN downlink bandwidth for WAN1
69252       bandwidth-up-wan2:
69253         type: string
69254         description: The WAN uplink bandwidth for WAN2
69255       bandwidth-down-wan2:
69256         type: string
69257         description: The WAN downlink bandwidth for WAN2
69258       resource-version:
69259         type: string
69260         description: Concurrency value
69261       relationship-list:
69262         type: array
69263         items:
69264           $ref: "#/getDefinitions/relationship"
69265   tunnel-xconnects:
69266     description: |
69267       This object is used to store the specific tunnel cross connect aspects of an allotted resource
69268     properties:
69269       tunnel-xconnect:
69270         type: array
69271         items:
69272           $ref: "#/getDefinitions/tunnel-xconnect"
69273   update:
69274     description: |
69275       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
69276     required:
69277     - update-node-type
69278     properties:
69279       update-node-type:
69280         type: string
69281       update-node-key:
69282         type: array
69283         items:
69284           $ref: "#/getDefinitions/update-node-key"
69285       update-node-uri:
69286         type: string
69287       action:
69288         type: array
69289         items:
69290           $ref: "#/getDefinitions/action"
69291   update-node-key:
69292     properties:
69293       key-name:
69294         type: string
69295       key-value:
69296         type: string
69297   vce:
69298     description: |
69299       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
69300       ###### Related Nodes
69301       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
69302       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
69303       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
69304       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
69305       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
69306       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
69307       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
69308       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
69309     required:
69310     - vnf-id
69311     - vnf-name
69312     - vnf-type
69313     properties:
69314       vnf-id:
69315         type: string
69316         description: Unique id of VNF.  This is unique across the graph.
69317       vnf-name:
69318         type: string
69319         description: Name of VNF.
69320       vnf-name2:
69321         type: string
69322         description: Alternate name of VNF.
69323       vnf-type:
69324         type: string
69325         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.
69326       service-id:
69327         type: string
69328         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
69329       regional-resource-zone:
69330         type: string
69331         description: Regional way of organizing pservers, source of truth should define values
69332       prov-status:
69333         type: string
69334         description: Trigger for operational monitoring of this resource by Service Assurance systems.
69335       operational-status:
69336         type: string
69337         description: Indicator for whether the resource is considered operational
69338       license-key:
69339         type: string
69340         description: OBSOLETE -  do not use
69341       equipment-role:
69342         type: string
69343         description: Network role being played by this VNF
69344       orchestration-status:
69345         type: string
69346         description: Orchestration status of this VNF, mastered by MSO
69347       heat-stack-id:
69348         type: string
69349         description: Heat stack id corresponding to this instance, managed by MSO
69350       mso-catalog-key:
69351         type: string
69352         description: Corresponds to the SDN-C catalog id used to configure this VCE
69353       vpe-id:
69354         type: string
69355         description: Unique ID of VPE connected to this VCE.
69356       v6-vce-wan-address:
69357         type: string
69358         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
69359       ipv4-oam-address:
69360         type: string
69361         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
69362       resource-version:
69363         type: string
69364         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69365       ipv4-loopback0-address:
69366         type: string
69367         description: Loopback0 address
69368       entitlement-resource-uuid:
69369         type: string
69370         description: OBSOLETE -  see child relationships
69371       port-groups:
69372         type: array
69373         items:
69374           $ref: "#/getDefinitions/port-group"
69375       licenses:
69376         type: array
69377         items:
69378           $ref: "#/getDefinitions/license"
69379       entitlements:
69380         type: array
69381         items:
69382           $ref: "#/getDefinitions/entitlement"
69383       relationship-list:
69384         type: array
69385         items:
69386           $ref: "#/getDefinitions/relationship"
69387   vces:
69388     description: |
69389       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
69390     properties:
69391       vce:
69392         type: array
69393         items:
69394           $ref: "#/getDefinitions/vce"
69395   vf-module:
69396     description: |
69397       a deployment unit of VNFCs
69398       ###### Related Nodes
69399       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
69400       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
69401       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
69402       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
69403       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
69404       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
69405       - VF-MODULE cannot be deleted if linked to VNFC
69406     required:
69407     - vf-module-id
69408     - is-base-vf-module
69409     properties:
69410       vf-module-id:
69411         type: string
69412         description: Unique ID of vf-module.
69413       vf-module-name:
69414         type: string
69415         description: Name of vf-module
69416       heat-stack-id:
69417         type: string
69418         description: Heat stack id corresponding to this instance.
69419       orchestration-status:
69420         type: string
69421         description: orchestration status of this vf-module, mastered by MSO
69422       is-base-vf-module:
69423         type: boolean
69424       resource-version:
69425         type: string
69426         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69427       model-invariant-id:
69428         type: string
69429         description: the ASDC model id for this resource or service model.
69430       model-version-id:
69431         type: string
69432         description: the ASDC model version for this resource or service model.
69433       persona-model-version:
69434         type: string
69435         description: the ASDC model version for this resource or service model.
69436       model-customization-id:
69437         type: string
69438         description: captures the id of all the configuration used to customize the resource for the service.
69439       widget-model-id:
69440         type: string
69441         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
69442       widget-model-version:
69443         type: string
69444         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
69445       contrail-service-instance-fqdn:
69446         type: string
69447         description: the Contrail unique ID for a service-instance
69448       module-index:
69449         type: integer
69450         format: int32
69451         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
69452       selflink:
69453         type: string
69454         description: Path to the controller object.
69455       relationship-list:
69456         type: array
69457         items:
69458           $ref: "#/getDefinitions/relationship"
69459   vf-modules:
69460     description: |
69461       Collection of vf-modules, a deployment unit of VNFCs
69462     properties:
69463       vf-module:
69464         type: array
69465         items:
69466           $ref: "#/getDefinitions/vf-module"
69467   vig-server:
69468     description: |
69469       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
69470       ###### Related Nodes
69471       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
69472     required:
69473     - vig-address-type
69474     properties:
69475       vig-address-type:
69476         type: string
69477         description: indicates whether the VIG is for AVPN or INTERNET
69478       ipaddress-v4-vig:
69479         type: string
69480         description: v4 IP of the vig server
69481       ipaddress-v6-vig:
69482         type: string
69483         description: v6 IP of the vig server
69484       resource-version:
69485         type: string
69486         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69487       relationship-list:
69488         type: array
69489         items:
69490           $ref: "#/getDefinitions/relationship"
69491   vig-servers:
69492     properties:
69493       vig-server:
69494         type: array
69495         items:
69496           $ref: "#/getDefinitions/vig-server"
69497   vip-ipv4-address-list:
69498     description: |
69499       IPv4 Address Range
69500       ###### Related Nodes
69501       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69502       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
69503       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
69504       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
69505     required:
69506     - vip-ipv4-address
69507     properties:
69508       vip-ipv4-address:
69509         type: string
69510         description: IP address
69511       vip-ipv4-prefix-length:
69512         type: integer
69513         format: int64
69514         description: Prefix length, 32 for single address
69515       vlan-id-inner:
69516         type: integer
69517         format: int64
69518         description: Inner VLAN tag
69519       vlan-id-outer:
69520         type: integer
69521         format: int64
69522         description: Outer VLAN tag
69523       is-floating:
69524         type: boolean
69525         description: Indicator of fixed or floating address
69526       resource-version:
69527         type: string
69528         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69529       neutron-network-id:
69530         type: string
69531         description: Neutron network id of the interface that address belongs to
69532       neutron-subnet-id:
69533         type: string
69534         description: Neutron id of subnet that address belongs to
69535       relationship-list:
69536         type: array
69537         items:
69538           $ref: "#/getDefinitions/relationship"
69539   vip-ipv6-address-list:
69540     description: |
69541       IPv6 Address Range
69542       ###### Related Nodes
69543       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69544       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
69545       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
69546       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
69547     required:
69548     - vip-ipv6-address
69549     properties:
69550       vip-ipv6-address:
69551         type: string
69552         description: IP address
69553       vip-ipv6-prefix-length:
69554         type: integer
69555         format: int64
69556         description: Prefix length, 128 for single address
69557       vlan-id-inner:
69558         type: integer
69559         format: int64
69560         description: Inner VLAN tag
69561       vlan-id-outer:
69562         type: integer
69563         format: int64
69564         description: Outer VLAN tag
69565       is-floating:
69566         type: boolean
69567         description: Indicator of fixed or floating address
69568       resource-version:
69569         type: string
69570         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69571       neutron-network-id:
69572         type: string
69573         description: Neutron network id of the interface that address belongs to
69574       neutron-subnet-id:
69575         type: string
69576         description: Neutron id of subnet that address belongs to
69577       relationship-list:
69578         type: array
69579         items:
69580           $ref: "#/getDefinitions/relationship"
69581   virtual-data-center:
69582     description: |
69583       Virtual organization of cloud infrastructure elements in a data center context
69584       ###### Related Nodes
69585       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
69586       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
69587       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
69588     required:
69589     - vdc-id
69590     - vdc-name
69591     properties:
69592       vdc-id:
69593         type: string
69594         description: Unique ID of the vdc
69595       vdc-name:
69596         type: string
69597         description: Name of the virtual data center
69598       resource-version:
69599         type: string
69600         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69601       relationship-list:
69602         type: array
69603         items:
69604           $ref: "#/getDefinitions/relationship"
69605   virtual-data-centers:
69606     description: |
69607       Virtual organization of cloud infrastructure elements in a data center context
69608     properties:
69609       virtual-data-center:
69610         type: array
69611         items:
69612           $ref: "#/getDefinitions/virtual-data-center"
69613   vlan:
69614     description: |
69615       Definition of vlan
69616       ###### Related Nodes
69617       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
69618       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
69619       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
69620       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
69621       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
69622       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
69623       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
69624       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
69625       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
69626     required:
69627     - vlan-interface
69628     - in-maint
69629     - is-ip-unnumbered
69630     properties:
69631       vlan-interface:
69632         type: string
69633         description: String that identifies the interface
69634       vlan-id-inner:
69635         type: integer
69636         format: int64
69637         description: Inner VLAN tag
69638       vlan-id-outer:
69639         type: integer
69640         format: int64
69641         description: Outer VLAN tag
69642       resource-version:
69643         type: string
69644         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69645       speed-value:
69646         type: string
69647         description: Captures the numeric part of the speed
69648       speed-units:
69649         type: string
69650         description: Captures the units corresponding to the speed
69651       vlan-description:
69652         type: string
69653         description: Used to describe (the service associated with) the vlan
69654       backdoor-connection:
69655         type: string
69656         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
69657       vpn-key:
69658         type: string
69659         description: This indicates the customers VPN ID associated with this vlan
69660       orchestration-status:
69661         type: string
69662         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
69663       in-maint:
69664         type: boolean
69665       prov-status:
69666         type: string
69667         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
69668       is-ip-unnumbered:
69669         type: boolean
69670       relationship-list:
69671         type: array
69672         items:
69673           $ref: "#/getDefinitions/relationship"
69674       l3-interface-ipv4-address-list:
69675         type: array
69676         items:
69677           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
69678       l3-interface-ipv6-address-list:
69679         type: array
69680         items:
69681           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
69682   vlans:
69683     properties:
69684       vlan:
69685         type: array
69686         items:
69687           $ref: "#/getDefinitions/vlan"
69688   vnf:
69689     description: |
69690       Abstract vnf class
69691     required:
69692     - vnf-id
69693     properties:
69694       vnf-id:
69695         type: string
69696         description: Unique id of VNF.  This is unique across the graph.
69697   vnf-image:
69698     description: |
69699       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
69700       ###### Related Nodes
69701       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
69702       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
69703     required:
69704     - vnf-image-uuid
69705     - application
69706     - application-vendor
69707     properties:
69708       vnf-image-uuid:
69709         type: string
69710         description: Unique ID of this asset
69711       application:
69712         type: string
69713         description: The application that the image instantiates.
69714       application-vendor:
69715         type: string
69716         description: The vendor of the application.
69717       application-version:
69718         type: string
69719         description: The version of the application.
69720       selflink:
69721         type: string
69722         description: URL to endpoint where AAI can get more details
69723       resource-version:
69724         type: string
69725         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69726       relationship-list:
69727         type: array
69728         items:
69729           $ref: "#/getDefinitions/relationship"
69730   vnf-images:
69731     description: |
69732       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
69733     properties:
69734       vnf-image:
69735         type: array
69736         items:
69737           $ref: "#/getDefinitions/vnf-image"
69738   vnfc:
69739     description: |
69740       ###### Related Nodes
69741       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
69742       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
69743       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
69744       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
69745       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
69746       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
69747       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
69748       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
69749       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
69750     required:
69751     - vnfc-name
69752     - nfc-naming-code
69753     - nfc-function
69754     - in-maint
69755     - is-closed-loop-disabled
69756     properties:
69757       vnfc-name:
69758         type: string
69759         description: Unique ID of vnfc.
69760       nfc-naming-code:
69761         type: string
69762         description: Short code that is used in naming instances of the item being modeled
69763       nfc-function:
69764         type: string
69765         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
69766       prov-status:
69767         type: string
69768         description: prov status of this vnfc
69769       orchestration-status:
69770         type: string
69771         description: Orchestration status of this VNF, mastered by APP-C
69772       ipaddress-v4-oam-vip:
69773         type: string
69774         description: Oam V4 vip address of this vnfc
69775       in-maint:
69776         type: boolean
69777       is-closed-loop-disabled:
69778         type: boolean
69779       group-notation:
69780         type: string
69781         description: Group notation of VNFC
69782       model-invariant-id:
69783         type: string
69784         description: the ASDC model id for this resource or service model.
69785       model-version-id:
69786         type: string
69787         description: the ASDC model version for this resource or service model.
69788       resource-version:
69789         type: string
69790         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69791       relationship-list:
69792         type: array
69793         items:
69794           $ref: "#/getDefinitions/relationship"
69795       l3-interface-ipv4-address-list:
69796         type: array
69797         items:
69798           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
69799       l3-interface-ipv6-address-list:
69800         type: array
69801         items:
69802           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
69803   vnfcs:
69804     description: |
69805       virtual network components associated with a vserver from application controller.
69806     properties:
69807       vnfc:
69808         type: array
69809         items:
69810           $ref: "#/getDefinitions/vnfc"
69811   volume:
69812     description: |
69813       Ephemeral Block storage volume.
69814       ###### Related Nodes
69815       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
69816     required:
69817     - volume-id
69818     - volume-selflink
69819     properties:
69820       volume-id:
69821         type: string
69822         description: Unique ID of block storage volume relative to the vserver.
69823       volume-selflink:
69824         type: string
69825         description: URL to endpoint where AAI can get more details
69826       resource-version:
69827         type: string
69828         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69829       relationship-list:
69830         type: array
69831         items:
69832           $ref: "#/getDefinitions/relationship"
69833   volume-group:
69834     description: |
69835       Persistent block-level storage.
69836       ###### Related Nodes
69837       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69838       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
69839       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
69840       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
69841       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
69842     required:
69843     - volume-group-id
69844     - volume-group-name
69845     - vnf-type
69846     properties:
69847       volume-group-id:
69848         type: string
69849         description: Unique ID of volume-group.
69850       volume-group-name:
69851         type: string
69852         description: Name of the volume group.
69853       heat-stack-id:
69854         type: string
69855         description: Heat stack id corresponding to this volume-group
69856       vnf-type:
69857         type: string
69858         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.
69859       orchestration-status:
69860         type: string
69861         description: Orchestration status of this volume-group
69862       model-customization-id:
69863         type: string
69864         description: captures the id of all the configuration used to customize the resource for the service.
69865       vf-module-model-customization-id:
69866         type: string
69867         description: helps relate the volume group to the vf-module whose components will require the volume group
69868       resource-version:
69869         type: string
69870         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69871       relationship-list:
69872         type: array
69873         items:
69874           $ref: "#/getDefinitions/relationship"
69875   volume-groups:
69876     description: |
69877       Collection of persistent block-level storage.
69878     properties:
69879       volume-group:
69880         type: array
69881         items:
69882           $ref: "#/getDefinitions/volume-group"
69883   volumes:
69884     description: |
69885       Collection of ephemeral Block storage volumes.
69886     properties:
69887       volume:
69888         type: array
69889         items:
69890           $ref: "#/getDefinitions/volume"
69891   vpls-pe:
69892     description: |
69893       VPLS Provider Edge routers.
69894       ###### Related Nodes
69895       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
69896       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
69897       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
69898       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
69899       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
69900     required:
69901     - equipment-name
69902     properties:
69903       equipment-name:
69904         type: string
69905       prov-status:
69906         type: string
69907         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
69908       ipv4-oam-address:
69909         type: string
69910         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).
69911       equipment-role:
69912         type: string
69913         description: Client should send valid enumerated value, e.g., VPLS-PE.
69914       vlan-id-outer:
69915         type: integer
69916         format: int64
69917         description: Temporary location for stag to get to VCE
69918       resource-version:
69919         type: string
69920         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69921       relationship-list:
69922         type: array
69923         items:
69924           $ref: "#/getDefinitions/relationship"
69925       p-interfaces:
69926         type: array
69927         items:
69928           $ref: "#/getDefinitions/p-interface"
69929       lag-interfaces:
69930         type: array
69931         items:
69932           $ref: "#/getDefinitions/lag-interface"
69933   vpls-pes:
69934     description: |
69935       Collection of VPLS Provider Edge routers
69936     properties:
69937       vpls-pe:
69938         type: array
69939         items:
69940           $ref: "#/getDefinitions/vpls-pe"
69941   vpn-binding:
69942     description: |
69943       VPN binding
69944       ###### Related Nodes
69945       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
69946       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
69947       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
69948       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
69949       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
69950       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
69951     required:
69952     - vpn-id
69953     - vpn-name
69954     properties:
69955       vpn-id:
69956         type: string
69957         description: VPN ID, globally unique within A&AI
69958       vpn-name:
69959         type: string
69960         description: VPN Name
69961       vpn-platform:
69962         type: string
69963         description: the platform associated with the VPN example AVPN, Mobility
69964       vpn-type:
69965         type: string
69966         description: Type of the vpn, should be taken from enumerated/valid values
69967       vpn-region:
69968         type: string
69969         description: region of customer vpn
69970       customer-vpn-id:
69971         type: string
69972         description: id for this customer vpn
69973       route-distinguisher:
69974         type: string
69975         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
69976       resource-version:
69977         type: string
69978         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69979       route-targets:
69980         type: array
69981         items:
69982           $ref: "#/getDefinitions/route-target"
69983       relationship-list:
69984         type: array
69985         items:
69986           $ref: "#/getDefinitions/relationship"
69987         description: l3-networks relate to vpn-bindings
69988   vpn-bindings:
69989     properties:
69990       vpn-binding:
69991         type: array
69992         items:
69993           $ref: "#/getDefinitions/vpn-binding"
69994   vserver:
69995     description: |
69996       Virtual Servers, aka virtual machine or VM.
69997       ###### Related Nodes
69998       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
69999       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
70000       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
70001       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
70002       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
70003       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
70004       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
70005       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
70006       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
70007       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
70008       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
70009       - VSERVER is DELETED when these are DELETED L-INTERFACE
70010       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
70011     required:
70012     - vserver-id
70013     - vserver-name
70014     - vserver-selflink
70015     - in-maint
70016     - is-closed-loop-disabled
70017     properties:
70018       vserver-id:
70019         type: string
70020         description: Unique identifier for this vserver relative to its tenant
70021       vserver-name:
70022         type: string
70023         description: Name of vserver
70024       vserver-name2:
70025         type: string
70026         description: Alternative name of vserver
70027       prov-status:
70028         type: string
70029         description: Trigger for operational monitoring of this resource by Service Assurance systems.
70030       vserver-selflink:
70031         type: string
70032         description: URL to endpoint where AAI can get more details
70033       in-maint:
70034         type: boolean
70035       is-closed-loop-disabled:
70036         type: boolean
70037       resource-version:
70038         type: string
70039         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
70040       volumes:
70041         type: array
70042         items:
70043           $ref: "#/getDefinitions/volume"
70044       relationship-list:
70045         type: array
70046         items:
70047           $ref: "#/getDefinitions/relationship"
70048       l-interfaces:
70049         type: array
70050         items:
70051           $ref: "#/getDefinitions/l-interface"
70052   vservers:
70053     description: |
70054       Collection of virtual Servers, aka virtual machines or VMs.
70055     properties:
70056       vserver:
70057         type: array
70058         items:
70059           $ref: "#/getDefinitions/vserver"
70060   zone:
70061     description: |
70062       A zone is a grouping of assets in a location homing to the same connections into the CBB
70063       ###### Related Nodes
70064       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
70065       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
70066       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
70067       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
70068       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
70069     required:
70070     - zone-id
70071     - zone-name
70072     - design-type
70073     - zone-context
70074     properties:
70075       zone-id:
70076         type: string
70077         description: Code assigned by AIC to the zone
70078       zone-name:
70079         type: string
70080         description: English name associated with the zone
70081       design-type:
70082         type: string
70083         description: Design of zone [Medium/Large…]
70084       zone-context:
70085         type: string
70086         description: Context of zone [production/test]
70087       status:
70088         type: string
70089         description: Status of a zone.
70090       resource-version:
70091         type: string
70092         description: Concurrency value
70093       relationship-list:
70094         type: array
70095         items:
70096           $ref: "#/getDefinitions/relationship"
70097   zones:
70098     description: |
70099       Collection of zones
70100     properties:
70101       zone:
70102         type: array
70103         items:
70104           $ref: "#/getDefinitions/zone"