X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v11.yaml;h=629ae58d3d675628db3ba31b1e83ea543e69d6bd;hb=7e9f827af41471e51c5b910443953eb85747279e;hp=46a08b5496d18769bf3ba2dee6cb417a62dd87c0;hpb=8dd94f5ef470840a9f58db22c38349914ff27d5f;p=aai%2Faai-common.git diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml index 46a08b54..629ae58d 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v11.yaml @@ -1,6 +1,9 @@ swagger: "2.0" info: description: | + + [Differences versus the previous schema version](apidocs/aai_swagger_v11.diff) + Copyright © 2017 AT&T Intellectual Property. All rights reserved. Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License. @@ -49,19 +52,22 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string + example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string + example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true schema: $ref: "#/definitions/relationship" @@ -86,16 +92,19 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string + example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string + example: __AVAILABILITY-ZONE-NAME__ /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}: get: tags: @@ -110,7 +119,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ctag-pool" + $ref: "#/getDefinitions/ctag-pool" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -119,36 +128,27 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string + example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url - in: query - description: URL of the keystone identity service - required: false - type: string + example: __AVAILABILITY-ZONE-NAME__ put: tags: - CloudInfrastructure summary: create or update an existing ctag-pool - description: create or update an existing ctag-pool + description: | + Create or update an existing ctag-pool. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool consumes: - application/json @@ -165,22 +165,76 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string + example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string + example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: ctag-pool object that needs to be created or updated + description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true schema: $ref: "#/definitions/ctag-pool" + patch: + tags: + - CloudInfrastructure + summary: update an existing ctag-pool + description: | + Update an existing ctag-pool + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: target-pe + in: path + description: The Target provider edge router + required: true + type: string + example: __TARGET-PE__ + - name: availability-zone-name + in: path + description: Name of the availability zone + required: true + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: ctag-pool object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-pool" delete: tags: - CloudInfrastructure @@ -202,16 +256,19 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: target-pe in: path description: The Target provider edge router required: true type: string + example: __TARGET-PE__ - name: availability-zone-name in: path description: Name of the availability zone required: true type: string + example: __AVAILABILITY-ZONE-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -231,7 +288,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ctag-pools" + $ref: "#/getDefinitions/ctag-pools" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -240,19 +297,10 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url + example: __PHYSICAL-LOCATION-ID__ + - name: availability-zone-name in: query - description: URL of the keystone identity service + description: required: false type: string /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: @@ -276,9 +324,10 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplex.json) required: true schema: $ref: "#/definitions/relationship" @@ -303,6 +352,7 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ /cloud-infrastructure/complexes/complex/{physical-location-id}: get: tags: @@ -317,7 +367,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/complex" + $ref: "#/getDefinitions/complex" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -326,26 +376,15 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string - - name: data-center-code - in: query - description: Data center code which can be an alternate way to identify a complex - required: false - type: string - - name: complex-name - in: query - description: Gamma complex name for LCP instance. - required: false - type: string - - name: identity-url - in: query - description: URL of the keystone identity service - required: false - type: string + example: __PHYSICAL-LOCATION-ID__ put: tags: - CloudInfrastructure summary: create or update an existing complex - description: create or update an existing complex + description: | + Create or update an existing complex. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureComplexesComplex consumes: - application/json @@ -362,12 +401,52 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: body in: body - description: complex object that needs to be created or updated + description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplex.json) required: true schema: $ref: "#/definitions/complex" + patch: + tags: + - CloudInfrastructure + summary: update an existing complex + description: | + Update an existing complex + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureComplexesComplex + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: path + description: Unique identifier for physical location, e.g., CLLI + required: true + type: string + example: __PHYSICAL-LOCATION-ID__ + - name: body + in: body + description: complex object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/complex" delete: tags: - CloudInfrastructure @@ -389,6 +468,7 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -408,9 +488,30 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/complexes" + $ref: "#/getDefinitions/complexes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: physical-location-id + in: query + description: + required: false + type: string + - name: data-center-code + in: query + description: + required: false + type: string + - name: complex-name + in: query + description: + required: false + type: string + - name: identity-url + in: query + description: + required: false + type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: put: tags: @@ -432,19 +533,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string + example: __VOLUME-GROUP-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true schema: $ref: "#/definitions/relationship" @@ -469,16 +573,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string + example: __VOLUME-GROUP-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}: get: tags: @@ -493,7 +600,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/volume-group" + $ref: "#/getDefinitions/volume-group" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -502,46 +609,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: volume-group-name - in: query - description: Name of the volume group. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this volume-group - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string + example: __VOLUME-GROUP-ID__ put: tags: - CloudInfrastructure summary: create or update an existing volume-group - description: create or update an existing volume-group + description: | + Create or update an existing volume-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup consumes: - application/json @@ -558,22 +646,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string + example: __VOLUME-GROUP-ID__ - name: body in: body - description: volume-group object that needs to be created or updated + description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true schema: $ref: "#/definitions/volume-group" + patch: + tags: + - CloudInfrastructure + summary: update an existing volume-group + description: | + Update an existing volume-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: volume-group-id + in: path + description: Unique ID of volume-group. + required: true + type: string + example: __VOLUME-GROUP-ID__ + - name: body + in: body + description: volume-group object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/volume-group" delete: tags: - CloudInfrastructure @@ -595,16 +737,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: volume-group-id in: path description: Unique ID of volume-group. required: true type: string + example: __VOLUME-GROUP-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -624,7 +769,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/volume-groups" + $ref: "#/getDefinitions/volume-groups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -633,19 +778,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: volume-group-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: volume-group-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + - name: vnf-type + in: query + description: required: false type: string /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: @@ -669,29 +826,34 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string + example: __VOLUME-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: $ref: "#/definitions/relationship" @@ -716,26 +878,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string + example: __VOLUME-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}: get: tags: @@ -750,7 +917,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/volume" + $ref: "#/getDefinitions/volume" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -759,75 +926,103 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false + example: __VOLUME-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing volume + description: | + Create or update an existing volume. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: vserver-name - in: query - description: Name of vserver - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __VSERVER-ID__ + - name: volume-id + in: path + description: Unique ID of block storage volume relative to the vserver. + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - put: + example: __VOLUME-ID__ + - name: body + in: body + description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) + required: true + schema: + $ref: "#/definitions/volume" + patch: tags: - CloudInfrastructure - summary: create or update an existing volume - description: create or update an existing volume - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume + summary: update an existing volume + description: | + Update an existing volume + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume consumes: - application/json - application/xml @@ -843,32 +1038,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string + example: __VOLUME-ID__ - name: body in: body - description: volume object that needs to be created or updated + description: volume object that needs to be updated. required: true schema: - $ref: "#/definitions/volume" + $ref: "#/patchDefinitions/volume" delete: tags: - CloudInfrastructure @@ -890,26 +1090,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true type: string + example: __VOLUME-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -929,7 +1134,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/volumes" + $ref: "#/getDefinitions/volumes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -938,64 +1143,30 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status + example: __VSERVER-ID__ + - name: volume-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship: put: tags: @@ -1017,24 +1188,28 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1059,21 +1234,25 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ /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: put: tags: @@ -1095,34 +1274,40 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1147,31 +1332,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ /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: put: tags: @@ -1193,39 +1384,46 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -1250,36 +1448,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ /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}: get: tags: @@ -1294,7 +1499,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1303,127 +1508,127 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -1439,42 +1644,49 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure @@ -1496,36 +1708,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency @@ -1552,39 +1771,46 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -1609,36 +1835,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ /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}: get: tags: @@ -1653,7 +1886,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1662,127 +1895,127 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -1798,42 +2031,49 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure @@ -1855,36 +2095,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency @@ -1904,7 +2151,62 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -1913,106 +2215,60 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: tags: - CloudInfrastructure - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -2028,37 +2284,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated + description: vlan object that needs to be updated. required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/patchDefinitions/vlan" delete: tags: - CloudInfrastructure @@ -2080,31 +2342,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: resource-version in: query description: resource-version for concurrency @@ -2124,7 +2392,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -2133,82 +2401,45 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string /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: @@ -2232,34 +2463,40 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -2284,31 +2521,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ /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}: get: tags: @@ -2323,7 +2566,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -2332,115 +2575,115 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __PCI-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - put: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: tags: - CloudInfrastructure - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -2456,37 +2699,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - CloudInfrastructure @@ -2508,31 +2757,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -2552,7 +2807,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -2561,82 +2816,54 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: vf-vlan-filter in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: vf-mac-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string /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: @@ -2660,29 +2887,34 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -2707,26 +2939,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ /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: put: tags: @@ -2748,34 +2985,40 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -2800,31 +3043,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ /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}: get: tags: @@ -2839,7 +3088,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -2848,110 +3097,45 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -2968,37 +3152,112 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure @@ -3020,31 +3279,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency @@ -3071,34 +3336,40 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -3123,31 +3394,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ /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}: get: tags: @@ -3162,7 +3439,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -3171,111 +3448,115 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -3291,37 +3572,43 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure @@ -3343,31 +3630,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency @@ -3387,7 +3680,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -3396,90 +3689,103 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false + example: __INTERFACE-NAME__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: interface-id - in: query - description: ID of interface - required: false + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VSERVER-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - put: + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: tags: - CloudInfrastructure - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface consumes: - application/json - application/xml @@ -3495,32 +3801,37 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated + description: l-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/patchDefinitions/l-interface" delete: tags: - CloudInfrastructure @@ -3542,26 +3853,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -3581,7 +3897,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -3590,64 +3906,45 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context + example: __VSERVER-ID__ + - name: interface-name in: query - description: This field will store the tenant context. + description: required: false type: string - - name: vserver-name + - name: interface-id in: query - description: Name of vserver + description: required: false type: string - - name: vserver-name2 + - name: macaddr in: query - description: Alternative name of vserver + description: required: false type: string - - name: prov-status + - name: network-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}: get: tags: @@ -3662,7 +3959,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vserver" + $ref: "#/getDefinitions/vserver" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -3671,69 +3968,33 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string - - name: vserver-name - in: query - description: Name of vserver - required: false - type: string - - name: vserver-name2 - in: query - description: Alternative name of vserver - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean + example: __VSERVER-ID__ put: tags: - CloudInfrastructure summary: create or update an existing vserver - description: create or update an existing vserver + description: | + Create or update an existing vserver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver consumes: - application/json @@ -3750,27 +4011,88 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: body in: body - description: vserver object that needs to be created or updated + description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/vserver" + patch: + tags: + - CloudInfrastructure + summary: update an existing vserver + description: | + Update an existing vserver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: vserver-id + in: path + description: Unique identifier for this vserver relative to its tenant + required: true + type: string + example: __VSERVER-ID__ + - name: body + in: body + description: vserver object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vserver" delete: tags: - CloudInfrastructure @@ -3792,21 +4114,25 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true type: string + example: __VSERVER-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -3826,7 +4152,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vservers" + $ref: "#/getDefinitions/vservers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -3835,36 +4161,49 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string - - name: cloud-type + example: __TENANT-ID__ + - name: vserver-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: vserver-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string - - name: tenant-name + - name: vserver-name2 in: query - description: Readable name of tenant + description: required: false type: string - - name: tenant-context + - name: prov-status in: query - description: This field will store the tenant context. + description: required: false type: string + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship: put: tags: @@ -3886,19 +4225,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) required: true schema: $ref: "#/definitions/relationship" @@ -3923,16 +4265,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}: get: tags: @@ -3947,7 +4292,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/tenant" + $ref: "#/getDefinitions/tenant" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -3956,41 +4301,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: tenant-name - in: query - description: Readable name of tenant - required: false - type: string - - name: tenant-context - in: query - description: This field will store the tenant context. - required: false - type: string + example: __TENANT-ID__ put: tags: - CloudInfrastructure summary: create or update an existing tenant - description: create or update an existing tenant + description: | + Create or update an existing tenant. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant consumes: - application/json @@ -4007,22 +4338,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: body in: body - description: tenant object that needs to be created or updated + description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) required: true schema: $ref: "#/definitions/tenant" + patch: + tags: + - CloudInfrastructure + summary: update an existing tenant + description: | + Update an existing tenant + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: tenant-id + in: path + description: Unique id relative to the cloud-region. + required: true + type: string + example: __TENANT-ID__ + - name: body + in: body + description: tenant object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/tenant" delete: tags: - CloudInfrastructure @@ -4044,16 +4429,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -4073,7 +4461,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/tenants" + $ref: "#/getDefinitions/tenants" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4082,19 +4470,26 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: tenant-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: tenant-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: tenant-context + in: query + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: @@ -4118,19 +4513,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true type: string + example: __FLAVOR-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: $ref: "#/definitions/relationship" @@ -4155,16 +4553,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true type: string + example: __FLAVOR-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: get: tags: @@ -4179,7 +4580,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/flavor" + $ref: "#/getDefinitions/flavor" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4188,36 +4589,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: flavor-name - in: query - description: Flavor name - required: false - type: string + example: __FLAVOR-ID__ put: tags: - CloudInfrastructure summary: create or update an existing flavor - description: create or update an existing flavor + description: | + Create or update an existing flavor. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json @@ -4234,22 +4626,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true type: string + example: __FLAVOR-ID__ - name: body in: body - description: flavor object that needs to be created or updated + description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: $ref: "#/definitions/flavor" + patch: + tags: + - CloudInfrastructure + summary: update an existing flavor + description: | + Update an existing flavor + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: flavor-id + in: path + description: Flavor id, expected to be unique across cloud-region. + required: true + type: string + example: __FLAVOR-ID__ + - name: body + in: body + description: flavor object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/flavor" delete: tags: - CloudInfrastructure @@ -4271,16 +4717,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true type: string + example: __FLAVOR-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -4300,7 +4749,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/flavors" + $ref: "#/getDefinitions/flavors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4309,19 +4758,21 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: flavor-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: flavor-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: @@ -4345,19 +4796,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true type: string + example: __GROUP-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true schema: $ref: "#/definitions/relationship" @@ -4382,16 +4836,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true type: string + example: __GROUP-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}: get: tags: @@ -4406,7 +4863,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/group-assignment" + $ref: "#/getDefinitions/group-assignment" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4415,79 +4872,119 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false + example: __GROUP-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing group-assignment + description: | + Create or update an existing group-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true type: string - - name: group-type - in: query - description: Group type - the type of group this instance refers to - required: false + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true type: string - - name: group-name - in: query - description: Group name - name assigned to the group - required: false + example: __GROUP-ID__ + - name: body + in: body + description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + required: true + schema: + $ref: "#/definitions/group-assignment" + patch: + tags: + - CloudInfrastructure + summary: update an existing group-assignment + description: | + Update an existing group-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true type: string - put: + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: group-id + in: path + description: Group id, expected to be unique across cloud-region. + required: true + type: string + example: __GROUP-ID__ + - name: body + in: body + description: group-assignment object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/group-assignment" + delete: tags: - CloudInfrastructure - summary: create or update an existing group-assignment - description: create or update an existing group-assignment - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - - name: group-id - in: path - description: Group id, expected to be unique across cloud-region. - required: true - type: string - - name: body - in: body - description: group-assignment object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/group-assignment" - delete: - tags: - - CloudInfrastructure - summary: delete an existing group-assignment - description: delete an existing group-assignment - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + summary: delete an existing group-assignment + description: delete an existing group-assignment + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -4503,16 +5000,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true type: string + example: __GROUP-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -4532,7 +5032,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/group-assignments" + $ref: "#/getDefinitions/group-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4541,19 +5041,26 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: group-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: group-type + in: query + description: + required: false + type: string + - name: group-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: @@ -4577,19 +5084,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string + example: __SNAPSHOT-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: $ref: "#/definitions/relationship" @@ -4614,16 +5124,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string + example: __SNAPSHOT-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: get: tags: @@ -4638,7 +5151,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/snapshot" + $ref: "#/getDefinitions/snapshot" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4647,56 +5160,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: snapshot-name - in: query - description: Snapshot name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string - - name: prev-snapshot-id - in: query - description: This field contains the UUID of the previous snapshot (if any). - required: false - type: string + example: __SNAPSHOT-ID__ put: tags: - CloudInfrastructure summary: create or update an existing snapshot - description: create or update an existing snapshot + description: | + Create or update an existing snapshot. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json @@ -4713,22 +5197,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string + example: __SNAPSHOT-ID__ - name: body in: body - description: snapshot object that needs to be created or updated + description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: $ref: "#/definitions/snapshot" + patch: + tags: + - CloudInfrastructure + summary: update an existing snapshot + description: | + Update an existing snapshot + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: snapshot-id + in: path + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + required: true + type: string + example: __SNAPSHOT-ID__ + - name: body + in: body + description: snapshot object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/snapshot" delete: tags: - CloudInfrastructure @@ -4750,16 +5288,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string + example: __SNAPSHOT-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -4779,7 +5320,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/snapshots" + $ref: "#/getDefinitions/snapshots" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4788,19 +5329,41 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: snapshot-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: snapshot-name + in: query + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: + required: false + type: string + - name: prev-snapshot-id in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: @@ -4824,19 +5387,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true schema: $ref: "#/definitions/relationship" @@ -4861,16 +5427,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}: get: tags: @@ -4885,7 +5454,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/metadatum" + $ref: "#/getDefinitions/metadatum" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -4894,55 +5463,32 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ - name: metaname in: path required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string + example: __METANAME__ put: tags: - CloudInfrastructure summary: create or update an existing metadatum - description: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json @@ -4959,26 +5505,86 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ - name: metaname in: path required: true type: string + example: __METANAME__ - name: body in: body - description: metadatum object that needs to be created or updated + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) required: true schema: $ref: "#/definitions/metadatum" + patch: + tags: + - CloudInfrastructure + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" delete: tags: - CloudInfrastructure @@ -5000,20 +5606,24 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ - name: metaname in: path required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency @@ -5033,7 +5643,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/metadata" + $ref: "#/getDefinitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5042,44 +5652,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version + example: __IMAGE-ID__ + - name: metaname in: query - description: The version of the application. + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: @@ -5096,7 +5684,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/image" + $ref: "#/getDefinitions/image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5105,51 +5693,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string + example: __IMAGE-ID__ put: tags: - CloudInfrastructure summary: create or update an existing image - description: create or update an existing image + description: | + Create or update an existing image. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json @@ -5166,22 +5730,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ - name: body in: body - description: image object that needs to be created or updated + description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true schema: $ref: "#/definitions/image" + patch: + tags: + - CloudInfrastructure + summary: update an existing image + description: | + Update an existing image + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: image-id + in: path + description: Image id, expected to be unique across cloud region + required: true + type: string + example: __IMAGE-ID__ + - name: body + in: body + description: image object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/image" delete: tags: - CloudInfrastructure @@ -5203,16 +5821,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: image-id in: path description: Image id, expected to be unique across cloud region required: true type: string + example: __IMAGE-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -5232,7 +5853,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/images" + $ref: "#/getDefinitions/images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5241,19 +5862,36 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: image-id in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: image-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: + required: false + type: string + - name: application + in: query + description: + required: false + type: string + - name: application-vendor + in: query + description: + required: false + type: string + - name: application-version + in: query + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: @@ -5277,19 +5915,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: switch-name in: path description: DVS switch name required: true type: string + example: __SWITCH-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: $ref: "#/definitions/relationship" @@ -5314,16 +5955,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: switch-name in: path description: DVS switch name required: true type: string + example: __SWITCH-NAME__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: get: tags: @@ -5338,7 +5982,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/dvs-switch" + $ref: "#/getDefinitions/dvs-switch" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5347,36 +5991,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: switch-name in: path description: DVS switch name required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: vcenter-url - in: query - description: URL used to reach the vcenter - required: false - type: string + example: __SWITCH-NAME__ put: tags: - CloudInfrastructure summary: create or update an existing dvs-switch - description: create or update an existing dvs-switch + description: | + Create or update an existing dvs-switch. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json @@ -5393,22 +6028,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: switch-name in: path description: DVS switch name required: true type: string + example: __SWITCH-NAME__ - name: body in: body - description: dvs-switch object that needs to be created or updated + description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: $ref: "#/definitions/dvs-switch" + patch: + tags: + - CloudInfrastructure + summary: update an existing dvs-switch + description: | + Update an existing dvs-switch + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: switch-name + in: path + description: DVS switch name + required: true + type: string + example: __SWITCH-NAME__ + - name: body + in: body + description: dvs-switch object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/dvs-switch" delete: tags: - CloudInfrastructure @@ -5430,16 +6119,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: switch-name in: path description: DVS switch name required: true type: string + example: __SWITCH-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -5459,7 +6151,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/dvs-switches" + $ref: "#/getDefinitions/dvs-switches" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5468,19 +6160,21 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: switch-name in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: vcenter-url in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: @@ -5504,19 +6198,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true type: string + example: __NETWORK-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) required: true schema: $ref: "#/definitions/relationship" @@ -5541,16 +6238,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true type: string + example: __NETWORK-UUID__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: get: tags: @@ -5565,7 +6265,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/oam-network" + $ref: "#/getDefinitions/oam-network" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5574,42 +6274,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: network-name - in: query - description: Name of the network. - required: false - type: string - - name: cvlan-tag - in: query - description: cvlan-id - required: false - type: integer - format: int64 + example: __NETWORK-UUID__ put: tags: - CloudInfrastructure summary: create or update an existing oam-network - description: create or update an existing oam-network + description: | + Create or update an existing oam-network. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork consumes: - application/json @@ -5626,22 +6311,76 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true type: string + example: __NETWORK-UUID__ - name: body in: body - description: oam-network object that needs to be created or updated + description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) required: true schema: $ref: "#/definitions/oam-network" + patch: + tags: + - CloudInfrastructure + summary: update an existing oam-network + description: | + Update an existing oam-network + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: network-uuid + in: path + description: UUID of the network. Unique across a cloud-region + required: true + type: string + example: __NETWORK-UUID__ + - name: body + in: body + description: oam-network object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/oam-network" delete: tags: - CloudInfrastructure @@ -5663,16 +6402,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true type: string + example: __NETWORK-UUID__ - name: resource-version in: query description: resource-version for concurrency @@ -5692,7 +6434,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/oam-networks" + $ref: "#/getDefinitions/oam-networks" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5701,21 +6443,29 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type + example: __CLOUD-REGION-ID__ + - name: network-uuid in: query - description: Type of the cloud (e.g., openstack) + description: required: false type: string - - name: owner-defined-type + - name: network-name in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) + description: required: false type: string + - name: cvlan-tag + in: query + description: + required: false + type: integer + format: int64 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: put: tags: @@ -5737,19 +6487,22 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true type: string + example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) required: true schema: $ref: "#/definitions/relationship" @@ -5774,16 +6527,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true type: string + example: __AVAILABILITY-ZONE-NAME__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}: get: tags: @@ -5798,7 +6554,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/availability-zone" + $ref: "#/getDefinitions/availability-zone" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5807,31 +6563,27 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string + example: __AVAILABILITY-ZONE-NAME__ put: tags: - CloudInfrastructure summary: create or update an existing availability-zone - description: create or update an existing availability-zone + description: | + Create or update an existing availability-zone. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone consumes: - application/json @@ -5848,28 +6600,42 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true type: string + example: __AVAILABILITY-ZONE-NAME__ - name: body in: body - description: availability-zone object that needs to be created or updated + description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) required: true schema: $ref: "#/definitions/availability-zone" - delete: + patch: tags: - CloudInfrastructure - summary: delete an existing availability-zone - description: delete an existing availability-zone - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone + summary: update an existing availability-zone + description: | + Update an existing availability-zone + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone consumes: - application/json - application/xml @@ -5885,65 +6651,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __AVAILABILITY-ZONE-NAME__ + - name: body + in: body + description: availability-zone object that needs to be updated. required: true - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones: - get: - tags: - - CloudInfrastructure - summary: returns availability-zones - description: returns availability-zones - operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation schema: - $ref: "#/definitions/availability-zones" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: - put: + $ref: "#/patchDefinitions/availability-zone" + delete: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship + summary: delete an existing availability-zone + description: delete an existing availability-zone + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone consumes: - application/json - application/xml @@ -5959,30 +6691,39 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: path + description: Name of the availability zone. Unique across a cloud region required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __AVAILABILITY-ZONE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones: + get: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns availability-zones + description: returns availability-zones + operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/availability-zones" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5991,17 +6732,24 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}/relationship-list/relationship: + example: __CLOUD-REGION-ID__ + - name: availability-zone-name + in: query + description: + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItemRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship consumes: - application/json - application/xml @@ -6017,19 +6765,16 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: auth-info-item-id - in: path - description: Unique ID of auth-info-item. - required: true - type: string + example: __CLOUD-REGION-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json) required: true schema: $ref: "#/definitions/relationship" @@ -6038,7 +6783,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItemRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship consumes: - application/json - application/xml @@ -6054,75 +6799,19 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: auth-info-item-id - in: path - description: Unique ID of auth-info-item. - required: true - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}: - get: - tags: - - CloudInfrastructure - summary: returns auth-info-item - description: returns auth-info-item - operationId: getCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItem - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/auth-info-item" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - - name: auth-info-item-id - in: path - description: Unique ID of auth-info-item. - required: true - type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false - type: string - - name: username - in: query - description: user name of auth infomation to access VIM. - required: false - type: string - - name: auth-url - in: query - description: authentication url of the cloud. - required: false - type: string + example: __CLOUD-REGION-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing auth-info-item - description: create or update an existing auth-info-item - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItem + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship consumes: - application/json - application/xml @@ -6138,28 +6827,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: auth-info-item-id + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id in: path - description: Unique ID of auth-info-item. + description: Unique ID of esr system info. required: true type: string + example: __ESR-SYSTEM-INFO-ID__ - name: body in: body - description: auth-info-item object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) required: true schema: - $ref: "#/definitions/auth-info-item" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing auth-info-item - description: delete an existing auth-info-item - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAuthInfoItemsAuthInfoItem + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship consumes: - application/json - application/xml @@ -6175,28 +6867,26 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: auth-info-item-id + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id in: path - description: Unique ID of auth-info-item. - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Unique ID of esr system info. required: true type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items: + example: __ESR-SYSTEM-INFO-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}: get: tags: - CloudInfrastructure - summary: returns auth-info-items - description: returns auth-info-items - operationId: getCloudInfrastructureCloudRegionsCloudRegionAuthInfoItems + summary: returns esr-system-info + description: returns esr-system-info + operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo produces: - application/json - application/xml @@ -6204,7 +6894,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/auth-info-items" + $ref: "#/getDefinitions/esr-system-info" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6213,36 +6903,35 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: - get: + example: __ESR-SYSTEM-INFO-ID__ + put: tags: - CloudInfrastructure - summary: returns cloud-region - description: returns cloud-region - operationId: getCloudInfrastructureCloudRegionsCloudRegion + summary: create or update an existing esr-system-info + description: | + Create or update an existing esr-system-info. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/cloud-region" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6251,27 +6940,42 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: cloud-type - in: query - description: Type of the cloud (e.g., openstack) - required: false - type: string - - name: owner-defined-type - in: query - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - required: false + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true type: string - put: + example: __ESR-SYSTEM-INFO-ID__ + - name: body + in: body + description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) + required: true + schema: + $ref: "#/definitions/esr-system-info" + patch: tags: - CloudInfrastructure - summary: create or update an existing cloud-region - description: create or update an existing cloud-region - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion + summary: update an existing esr-system-info + description: | + Update an existing esr-system-info + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo consumes: - application/json - application/xml @@ -6287,23 +6991,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ - name: body in: body - description: cloud-region object that needs to be created or updated + description: esr-system-info object that needs to be updated. required: true schema: - $ref: "#/definitions/cloud-region" + $ref: "#/patchDefinitions/esr-system-info" delete: tags: - CloudInfrastructure - summary: delete an existing cloud-region - description: delete an existing cloud-region - operationId: deleteCloudInfrastructureCloudRegionsCloudRegion + summary: delete an existing esr-system-info + description: delete an existing esr-system-info + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo consumes: - application/json - application/xml @@ -6319,23 +7031,31 @@ paths: description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string + example: __CLOUD-OWNER__ - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: path + description: Unique ID of esr system info. + required: true + type: string + example: __ESR-SYSTEM-INFO-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /cloud-infrastructure/cloud-regions: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list: get: tags: - CloudInfrastructure - summary: returns cloud-regions - description: returns cloud-regions - operationId: getCloudInfrastructureCloudRegions + summary: returns esr-system-info-list + description: returns esr-system-info-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList produces: - application/json - application/xml @@ -6343,15 +7063,43 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/cloud-regions" + $ref: "#/getDefinitions/esr-system-info-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: esr-system-info-id + in: query + description: + required: false + type: string + - name: system-name + in: query + description: + required: false + type: string + - name: system-type + in: query + description: + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -6362,14 +7110,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: nm-profile-name + - name: cloud-owner in: path - description: Unique name of network profile. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address required: true type: string + example: __VIP-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -6378,7 +7139,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -6389,18 +7150,31 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: nm-profile-name + - name: cloud-owner in: path - description: Unique name of network profile. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}: + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}: get: tags: - CloudInfrastructure - summary: returns network-profile - description: returns network-profile - operationId: getCloudInfrastructureNetworkProfilesNetworkProfile + summary: returns vip-ipv4-address-list + description: returns vip-ipv4-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList produces: - application/json - application/xml @@ -6408,21 +7182,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-profile" + $ref: "#/getDefinitions/vip-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: nm-profile-name + - name: cloud-owner in: path - description: Unique name of network profile. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address required: true type: string + example: __VIP-IPV4-ADDRESS__ put: tags: - CloudInfrastructure - summary: create or update an existing network-profile - description: create or update an existing network-profile - operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile + summary: create or update an existing vip-ipv4-address-list + description: | + Create or update an existing vip-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList consumes: - application/json - application/xml @@ -6433,23 +7223,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: nm-profile-name + - name: cloud-owner in: path - description: Unique name of network profile. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ - name: body in: body - description: network-profile object that needs to be created or updated + description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) required: true schema: - $ref: "#/definitions/network-profile" - delete: + $ref: "#/definitions/vip-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing network-profile - description: delete an existing network-profile - operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile + summary: update an existing vip-ipv4-address-list + description: | + Update an existing vip-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList consumes: - application/json - application/xml @@ -6460,39 +7274,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: nm-profile-name + - name: cloud-owner in: path - description: Unique name of network profile. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - /cloud-infrastructure/network-profiles: - get: + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: body + in: body + description: vip-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv4-address-list" + delete: tags: - CloudInfrastructure - summary: returns network-profiles - description: returns network-profiles - operationId: getCloudInfrastructureNetworkProfiles + summary: delete an existing vip-ipv4-address-list + description: delete an existing vip-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/network-profiles" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv4-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -6503,14 +7353,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address required: true type: string + example: __VIP-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -6519,7 +7382,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -6530,49 +7393,69 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: - put: + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + get: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns vip-ipv6-address-list + description: returns vip-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: interface-name + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Name that identifies the physical interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __VIP-IPV6-ADDRESS__ + put: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship + summary: create or update an existing vip-ipv6-address-list + description: | + Create or update an existing vip-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList consumes: - application/json - application/xml @@ -6583,22 +7466,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: interface-name + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Name that identifies the physical interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: - put: + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + summary: update an existing vip-ipv6-address-list + description: | + Update an existing vip-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList consumes: - application/json - application/xml @@ -6609,33 +7517,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: interface-name + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Name that identifies the physical interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: pf-pci-id + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address in: path - description: Identifier for the sriov-pf + description: IP address required: true type: string + example: __VIP-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: vip-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/vip-ipv6-address-list" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + summary: delete an existing vip-ipv6-address-list + description: delete an existing vip-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList consumes: - application/json - application/xml @@ -6646,28 +7557,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: interface-name + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Name that identifies the physical interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: pf-pci-id + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address in: path - description: Identifier for the sriov-pf + description: IP address required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + example: __VIP-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: get: tags: - CloudInfrastructure - summary: returns sriov-pf - description: returns sriov-pf - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + summary: returns cloud-region + description: returns cloud-region + operationId: getCloudInfrastructureCloudRegionsCloudRegion produces: - application/json - application/xml @@ -6675,55 +7594,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-pf" + $ref: "#/getDefinitions/cloud-region" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name + - name: cloud-owner in: path - description: Name that identifies the physical interface + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: pf-pci-id + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Identifier for the sriov-pf + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string + example: __CLOUD-REGION-ID__ put: tags: - CloudInfrastructure - summary: create or update an existing sriov-pf - description: create or update an existing sriov-pf - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + summary: create or update an existing cloud-region + description: | + Create or update an existing cloud-region. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion consumes: - application/json - application/xml @@ -6734,33 +7629,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: cloud-owner in: path - description: Value from executing hostname on the compute node. + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: interface-name + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Name that identifies the physical interface + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string - - name: pf-pci-id + example: __CLOUD-REGION-ID__ + - name: body + in: body + description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json) + required: true + schema: + $ref: "#/definitions/cloud-region" + patch: + tags: + - CloudInfrastructure + summary: update an existing cloud-region + description: | + Update an existing cloud-region + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner in: path - description: Identifier for the sriov-pf + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: body in: body - description: sriov-pf object that needs to be created or updated + description: cloud-region object that needs to be updated. required: true schema: - $ref: "#/definitions/sriov-pf" + $ref: "#/patchDefinitions/cloud-region" delete: tags: - CloudInfrastructure - summary: delete an existing sriov-pf - description: delete an existing sriov-pf - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + summary: delete an existing cloud-region + description: delete an existing cloud-region + operationId: deleteCloudInfrastructureCloudRegionsCloudRegion consumes: - application/json - application/xml @@ -6771,33 +7708,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name + - name: cloud-owner in: path - description: Name that identifies the physical interface + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true type: string - - name: pf-pci-id + example: __CLOUD-OWNER__ + - name: cloud-region-id in: path - description: Identifier for the sriov-pf + description: Identifier used by the vendor for the region. Second part of composite key required: true type: string + example: __CLOUD-REGION-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + /cloud-infrastructure/cloud-regions: get: tags: - CloudInfrastructure - summary: returns sriov-pfs - description: returns sriov-pfs - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs + summary: returns cloud-regions + description: returns cloud-regions + operationId: getCloudInfrastructureCloudRegions produces: - application/json - application/xml @@ -6805,50 +7739,36 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-pfs" + $ref: "#/getDefinitions/cloud-regions" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: inv-status + - name: cloud-owner in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: pserver-id + - name: cloud-region-id in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + - name: cloud-type in: query - description: alternative pserver name + description: required: false type: string - - name: prov-status + - name: owner-defined-type in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship consumes: - application/json - application/xml @@ -6859,29 +7779,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: nm-profile-name in: path - description: String that identifies the interface + description: Unique name of network profile. required: true type: string + example: __NM-PROFILE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json) required: true schema: $ref: "#/definitions/relationship" @@ -6890,7 +7796,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship consumes: - application/json - application/xml @@ -6901,32 +7807,45 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: nm-profile-name in: path - description: Name given to the interface + description: Unique name of network profile. required: true type: string - - name: vlan-interface + example: __NM-PROFILE-NAME__ + /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}: + get: + tags: + - CloudInfrastructure + summary: returns network-profile + description: returns network-profile + operationId: getCloudInfrastructureNetworkProfilesNetworkProfile + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-profile" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name in: path - description: String that identifies the interface + description: Unique name of network profile. required: true type: string - /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: + example: __NM-PROFILE-NAME__ put: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: create or update an existing network-profile + description: | + Create or update an existing network-profile. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile consumes: - application/json - application/xml @@ -6937,34 +7856,132 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: hostname + - name: nm-profile-name in: path - description: Value from executing hostname on the compute node. + description: Unique name of network profile. required: true type: string - - name: interface-name - in: path - description: Name that identifies the physical interface + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json) required: true - type: string - - name: interface-name - in: path - description: Name given to the interface + schema: + $ref: "#/definitions/network-profile" + patch: + tags: + - CloudInfrastructure + summary: update an existing network-profile + description: | + Update an existing network-profile + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: path + description: Unique name of network profile. required: true type: string - - name: vlan-interface + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/network-profile" + delete: + tags: + - CloudInfrastructure + summary: delete an existing network-profile + description: delete an existing network-profile + operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name in: path - description: String that identifies the interface + description: Unique name of network profile. required: true type: string - - name: l3-interface-ipv4-address + example: __NM-PROFILE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/network-profiles: + get: + tags: + - CloudInfrastructure + summary: returns network-profiles + description: returns network-profiles + operationId: getCloudInfrastructureNetworkProfiles + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-profiles" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: nm-profile-name + in: query + description: + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname in: path - description: IP address + description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -6973,7 +7990,63 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -6989,33 +8062,94 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the physical interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: String that identifies the interface + description: Identifier for the sriov-pf required: true type: string - - name: l3-interface-ipv4-address + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname in: path - description: IP address + description: Value from executing hostname on the compute node. required: true type: string - /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}: + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns sriov-pf + description: returns sriov-pf + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf produces: - application/json - application/xml @@ -7023,7 +8157,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/sriov-pf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7032,98 +8166,193 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: Name given to the interface + description: Identifier for the sriov-pf required: true type: string - - name: vlan-interface + example: __PF-PCI-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname in: path - description: String that identifies the interface + description: Value from executing hostname on the compute node. required: true type: string - - name: l3-interface-ipv4-address + example: __HOSTNAME__ + - name: interface-name in: path - description: IP address + description: Name that identifies the physical interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - CloudInfrastructure + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - CloudInfrastructure + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key + example: __PF-PCI-ID__ + - name: resource-version in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + description: resource-version for concurrency + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - CloudInfrastructure + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string - - name: neutron-subnet-id + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -7139,38 +8368,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -7186,37 +8414,31 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /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: + example: __VLAN-INTERFACE__ + /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: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -7232,29 +8454,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -7263,7 +8490,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -7279,33 +8506,38 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -7313,7 +8545,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7322,98 +8554,40 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -7429,38 +8603,54 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -7476,46 +8666,50 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. required: true - type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - CloudInfrastructure - summary: returns vlan - description: returns vlan - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7524,77 +8718,42 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + description: resource-version for concurrency + required: true type: string + /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: put: tags: - CloudInfrastructure - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -7610,33 +8769,43 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: vlan object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -7652,33 +8821,38 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - CloudInfrastructure - summary: returns vlans - description: returns vlans - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -7686,7 +8860,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7695,61 +8869,40 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - /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: + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -7765,33 +8918,54 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -7807,36 +8981,50 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - CloudInfrastructure - summary: returns sriov-vf - description: returns sriov-vf - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7845,93 +9033,51 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: Neutron network id of the interface - required: false + description: resource-version for concurrency + required: true type: string - put: + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: tags: - CloudInfrastructure - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf - consumes: - - application/json - - application/xml + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7940,33 +9086,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: body - in: body - description: sriov-vf object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/sriov-vf" - delete: + example: __VLAN-INTERFACE__ + put: tags: - CloudInfrastructure - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -7982,41 +9129,55 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true - type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: - get: + schema: + $ref: "#/definitions/vlan" + patch: tags: - CloudInfrastructure - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8025,61 +9186,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -8095,35 +9232,45 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8132,22 +9279,41 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - /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: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: query + description: + required: false + type: string + - name: vlan-id-inner + in: query + description: + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: + required: false + type: string + /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: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -8163,24 +9329,28 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -8189,7 +9359,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -8205,28 +9375,32 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string - /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}: + example: __PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -8234,7 +9408,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8243,82 +9417,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __PCI-ID__ put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -8334,74 +9460,48 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: - tags: - - CloudInfrastructure - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /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: - put: + $ref: "#/definitions/sriov-vf" + patch: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -8417,33 +9517,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -8459,28 +9563,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string - /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}: + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -8488,7 +9601,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8497,82 +9610,50 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-filter in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vf-mac-filter in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner + - name: vf-vlan-strip in: query - description: Inner VLAN tag + description: required: false - type: integer - format: int64 + type: boolean - name: neutron-network-id in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -8588,33 +9669,31 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -8630,104 +9709,25 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: - get: - tags: - - CloudInfrastructure - summary: returns l-interface - description: returns l-interface - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interface" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname - in: path - description: Value from executing hostname on the compute node. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string + example: __INTERFACE-NAME__ + /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: put: tags: - CloudInfrastructure - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -8743,28 +9743,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l-interface object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -8780,28 +9789,32 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - CloudInfrastructure - summary: returns l-interfaces - description: returns l-interfaces - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -8809,7 +9822,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8818,50 +9831,41 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: - get: + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: tags: - CloudInfrastructure - summary: returns p-interface - description: returns p-interface - operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8870,41 +9874,48 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: create or update an existing p-interface - description: create or update an existing p-interface - operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -8920,23 +9931,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: p-interface object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/p-interface" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure - summary: delete an existing p-interface - description: delete an existing p-interface - operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -8952,64 +9977,36 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the physical interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces: - get: - tags: - - CloudInfrastructure - summary: returns p-interfaces - description: returns p-interfaces - operationId: getCloudInfrastructurePserversPserverPInterfaces - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/p-interfaces" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: hostname + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: Value from executing hostname on the compute node. + description: IP address required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: alternative pserver name - required: false + description: resource-version for concurrency + required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + /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: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -9025,14 +10022,28 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -9041,7 +10052,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -9057,24 +10068,40 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: - put: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: + get: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -9083,33 +10110,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: String that identifies the interface + description: IP address required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -9125,27 +10153,48 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: String that identifies the interface + description: IP address required: true type: string - /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: - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -9161,38 +10210,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -9208,33 +10256,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: String that identifies the interface + description: IP address required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface produces: - application/json - application/xml @@ -9242,7 +10294,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -9251,103 +10303,28 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __INTERFACE-NAME__ put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -9363,38 +10340,42 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + $ref: "#/definitions/l-interface" + patch: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -9410,37 +10391,31 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be updated. required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /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: - put: + schema: + $ref: "#/patchDefinitions/l-interface" + delete: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -9456,45 +10431,39 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces: + get: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -9503,33 +10472,40 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name - in: path - description: Name given to the interface - required: true + in: query + description: + required: false type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true + - name: interface-id + in: query + description: + required: false type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true + - name: macaddr + in: query + description: + required: false type: string - /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}: + - name: network-name + in: query + description: + required: false + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns p-interface + description: returns p-interface + operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface produces: - application/json - application/xml @@ -9537,7 +10513,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -9546,103 +10522,22 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + description: Name that identifies the physical interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __INTERFACE-NAME__ put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface consumes: - application/json - application/xml @@ -9658,38 +10553,70 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json) required: true - type: string - - name: vlan-interface + schema: + $ref: "#/definitions/p-interface" + patch: + tags: + - CloudInfrastructure + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname in: path - description: String that identifies the interface + description: Value from executing hostname on the compute node. required: true type: string - - name: l3-interface-ipv6-address + example: __HOSTNAME__ + - name: interface-name in: path - description: IP address + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: p-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/p-interface" delete: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface consumes: - application/json - application/xml @@ -9705,38 +10632,25 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces: get: tags: - CloudInfrastructure - summary: returns vlan - description: returns vlan - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: returns p-interfaces + description: returns p-interfaces + operationId: getCloudInfrastructurePserversPserverPInterfaces produces: - application/json - application/xml @@ -9744,7 +10658,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/p-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -9753,82 +10667,23 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key + - name: prov-status in: query - description: This indicates the customers VPN ID associated with this vlan + description: required: false type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -9844,33 +10699,53 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname in: path - description: Name given to the interface + description: Value from executing hostname on the compute node. required: true type: string - - name: vlan-interface + example: __HOSTNAME__ + - name: interface-name in: path - description: String that identifies the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: body - in: body - description: vlan object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/vlan" - delete: + example: __INTERFACE-NAME__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: tags: - CloudInfrastructure - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -9886,41 +10761,44 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true - type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: - get: + schema: + $ref: "#/definitions/relationship" + delete: tags: - CloudInfrastructure - summary: returns vlans - description: returns vlans - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -9929,66 +10807,31 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - /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: + example: __VLAN-INTERFACE__ + /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: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -10004,24 +10847,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -10030,7 +10883,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -10046,28 +10899,38 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - CloudInfrastructure - summary: returns sriov-vf - description: returns sriov-vf - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -10075,7 +10938,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10084,91 +10947,40 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -10184,33 +10996,54 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/sriov-vf" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -10226,41 +11059,50 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: - get: - tags: - - CloudInfrastructure - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10269,66 +11111,42 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: network-name + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: Name of the network - required: false + description: resource-version for concurrency + required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /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: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -10344,19 +11162,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -10365,7 +11198,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -10381,22 +11214,88 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - /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: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: + get: + tags: + - CloudInfrastructure + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -10412,33 +11311,54 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -10454,36 +11374,50 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /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}: - get: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - CloudInfrastructure - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10492,94 +11426,51 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: neutron-subnet-id + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: Neutron id of subnet that address belongs to - required: false + description: resource-version for concurrency + required: true type: string - put: + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList - consumes: - - application/json - - application/xml + summary: returns vlan + description: returns vlan + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10588,33 +11479,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - - name: body - in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + example: __VLAN-INTERFACE__ + put: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -10630,32 +11522,48 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true - type: string - /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: - put: + schema: + $ref: "#/definitions/vlan" + patch: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -10671,33 +11579,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: relationship object that needs to be created or updated + description: vlan object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/vlan" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -10713,28 +11625,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - /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}: + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - CloudInfrastructure - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: returns vlans + description: returns vlans + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -10742,7 +11663,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10751,87 +11672,41 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: Name of the network + description: required: false type: string - name: vlan-id-inner in: query - description: Inner VLAN tag + description: required: false type: integer format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id + - name: vpn-key in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /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: put: tags: - CloudInfrastructure - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -10847,33 +11722,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -10889,33 +11768,32 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: PCI ID used to identify the sriov-vf required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + example: __PCI-ID__ + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - CloudInfrastructure - summary: returns l-interface - description: returns l-interface - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + summary: returns sriov-vf + description: returns sriov-vf + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -10923,7 +11801,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10932,66 +11810,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string + example: __PCI-ID__ put: tags: - CloudInfrastructure - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -11007,28 +11853,48 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ - name: body in: body - description: l-interface object that needs to be created or updated + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: - $ref: "#/definitions/l-interface" - delete: + $ref: "#/definitions/sriov-vf" + patch: tags: - CloudInfrastructure - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -11044,36 +11910,44 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: - get: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: tags: - CloudInfrastructure - summary: returns l-interfaces - description: returns l-interfaces - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11082,47 +11956,37 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - - name: interface-role + example: __PCI-ID__ + - name: resource-version in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + description: resource-version for concurrency + required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - CloudInfrastructure - summary: returns lag-interface - description: returns lag-interface - operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -11130,7 +11994,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interface" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11139,46 +12003,50 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string - - name: inv-status + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: pserver-id + - name: vf-vlan-filter in: query - description: ID of Pserver + description: required: false type: string - - name: in-maint + - name: vf-mac-filter in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name + description: required: false type: string - - name: interface-id + - name: vf-vlan-strip in: query - description: ID of interface + description: required: false - type: string - - name: interface-role + type: boolean + - name: neutron-network-id in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - CloudInfrastructure - summary: create or update an existing lag-interface - description: create or update an existing lag-interface - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -11194,23 +12062,31 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/lag-interface" + $ref: "#/definitions/relationship" delete: tags: - CloudInfrastructure - summary: delete an existing lag-interface - description: delete an existing lag-interface - operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -11226,31 +12102,78 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: interface-name in: path description: Name that identifies the link aggregate interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces: - get: + example: __INTERFACE-NAME__ + /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: + put: tags: - CloudInfrastructure - summary: returns lag-interfaces - description: returns lag-interfaces - operationId: getCloudInfrastructurePserversPserverLagInterfaces + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11259,32 +12182,32 @@ paths: description: Value from executing hostname on the compute node. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - /cloud-infrastructure/pservers/pserver/{hostname}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - CloudInfrastructure - summary: returns pserver - description: returns pserver - operationId: getCloudInfrastructurePserversPserver + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -11292,7 +12215,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/pserver" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11301,31 +12224,34 @@ paths: description: Value from executing hostname on the compute node. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: pserver-id - in: query - description: ID of Pserver - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: pserver-name2 - in: query - description: alternative pserver name - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - CloudInfrastructure - summary: create or update an existing pserver - description: create or update an existing pserver - operationId: createOrUpdateCloudInfrastructurePserversPserver + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -11341,18 +12267,48 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: pserver object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/pserver" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing pserver - description: delete an existing pserver - operationId: deleteCloudInfrastructurePserversPserver + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -11368,34 +12324,82 @@ paths: description: Value from executing hostname on the compute node. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string - /cloud-infrastructure/pservers: - get: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - CloudInfrastructure - summary: returns pservers - description: returns pservers - operationId: getCloudInfrastructurePservers + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/pservers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /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: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -11406,14 +12410,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vdc-id + - name: hostname in: path - description: Unique ID of the vdc + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -11422,7 +12445,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -11433,18 +12456,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vdc-id + - name: hostname in: path - description: Unique ID of the vdc + description: Value from executing hostname on the compute node. required: true type: string - /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}: + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - CloudInfrastructure - summary: returns virtual-data-center - description: returns virtual-data-center - operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -11452,26 +12494,43 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/virtual-data-center" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vdc-id + - name: hostname in: path - description: Unique ID of the vdc + description: Value from executing hostname on the compute node. required: true type: string - - name: vdc-name - in: query - description: Name of the virtual data center - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - CloudInfrastructure - summary: create or update an existing virtual-data-center - description: create or update an existing virtual-data-center - operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -11482,23 +12541,53 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vdc-id + - name: hostname in: path - description: Unique ID of the vdc + description: Value from executing hostname on the compute node. + required: true + type: string + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: virtual-data-center object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/virtual-data-center" - delete: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - CloudInfrastructure - summary: delete an existing virtual-data-center - description: delete an existing virtual-data-center - operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -11509,66 +12598,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vdc-id + - name: hostname in: path - description: Unique ID of the vdc + description: Value from executing hostname on the compute node. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string - /cloud-infrastructure/virtual-data-centers: - get: - tags: - - CloudInfrastructure - summary: returns virtual-data-centers - description: returns virtual-data-centers - operationId: getCloudInfrastructureVirtualDataCenters - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/virtual-data-centers" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: - put: - tags: - - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: resource-instance-id + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique id of resource instance. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -11579,18 +12644,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}: + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - - Business - summary: returns metadatum - description: returns metadatum - operationId: getBusinessConnectorsConnectorMetadataMetadatum + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface produces: - application/json - application/xml @@ -11598,45 +12687,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/metadatum" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: metaname + example: __HOSTNAME__ + - name: interface-name in: path + description: Name that identifies the link aggregate interface required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string + example: __INTERFACE-NAME__ put: tags: - - Business - summary: create or update an existing metadatum - description: create or update an existing metadatum - operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum + - CloudInfrastructure + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -11647,27 +12728,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: metaname + example: __HOSTNAME__ + - name: interface-name in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: metadatum object that needs to be created or updated + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/metadatum" - delete: + $ref: "#/definitions/l-interface" + patch: tags: - - Business - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteBusinessConnectorsConnectorMetadataMetadatum + - CloudInfrastructure + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -11678,70 +12779,76 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: metaname + example: __HOSTNAME__ + - name: interface-name in: path + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string - /business/connectors/connector/{resource-instance-id}/metadata: - get: + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: tags: - - Business - summary: returns metadata - description: returns metadata - operationId: getBusinessConnectorsConnectorMetadata + - CloudInfrastructure + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: widget-model-version + example: __INTERFACE-NAME__ + - name: resource-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + description: resource-version for concurrency + required: true type: string - /business/connectors/connector/{resource-instance-id}: + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - - Business - summary: returns connector - description: returns connector - operationId: getBusinessConnectorsConnector + - CloudInfrastructure + summary: returns l-interfaces + description: returns l-interfaces + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces produces: - application/json - application/xml @@ -11749,68 +12856,81 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/connector" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: model-invariant-id + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - - name: model-version-id + - name: interface-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: macaddr in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: network-name in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - put: + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: + get: tags: - - Business - summary: create or update an existing connector - description: create or update an existing connector - operationId: createOrUpdateBusinessConnectorsConnector - consumes: - - application/json - - application/xml + - CloudInfrastructure + summary: returns lag-interface + description: returns lag-interface + operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: body - in: body - description: connector object that needs to be created or updated + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true - schema: - $ref: "#/definitions/connector" - delete: + type: string + example: __INTERFACE-NAME__ + put: tags: - - Business - summary: delete an existing connector - description: delete an existing connector - operationId: deleteBusinessConnectorsConnector + - CloudInfrastructure + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface consumes: - application/json - application/xml @@ -11821,39 +12941,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: resource-instance-id + - name: hostname in: path - description: Unique id of resource instance. + description: Value from executing hostname on the compute node. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __HOSTNAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string - /business/connectors: - get: - tags: - - Business - summary: returns connectors - description: returns connectors - operationId: getBusinessConnectors - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) + required: true schema: - $ref: "#/definitions/connectors" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: - put: + $ref: "#/definitions/lag-interface" + patch: tags: - - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + - CloudInfrastructure + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface consumes: - application/json - application/xml @@ -11864,33 +12986,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type + - name: hostname in: path - description: Value defined by orchestration to identify this service across ECOMP. + description: Value from executing hostname on the compute node. required: true type: string - - name: service-instance-id + example: __HOSTNAME__ + - name: interface-name in: path - description: Uniquely identifies this instance of a service + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: lag-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/lag-interface" delete: tags: - - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship + - CloudInfrastructure + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface consumes: - application/json - application/xml @@ -11901,28 +13020,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id + - name: hostname in: path - description: Global customer id used across ECOMP to uniquely identify customer. + description: Value from executing hostname on the compute node. required: true type: string - - name: service-type + example: __HOSTNAME__ + - name: interface-name in: path - description: Value defined by orchestration to identify this service across ECOMP. + description: Name that identifies the link aggregate interface required: true type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: + /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces: get: tags: - - Business - summary: returns metadatum - description: returns metadatum - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + - CloudInfrastructure + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getCloudInfrastructurePserversPserverLagInterfaces produces: - application/json - application/xml @@ -11930,90 +13051,64 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/metadatum" + $ref: "#/getDefinitions/lag-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - - name: metaname + - name: hostname in: path + description: Value from executing hostname on the compute node. required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + example: __HOSTNAME__ + - name: interface-name in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: interface-id in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - - name: service-instance-location-id + - name: interface-role in: query - description: An identifier that customers assign to the location where this service is being used. + description: required: false type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false + /cloud-infrastructure/pservers/pserver/{hostname}: + get: + tags: + - CloudInfrastructure + summary: returns pserver + description: returns pserver + operationId: getCloudInfrastructurePserversPserver + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pserver" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname + in: path + description: Value from executing hostname on the compute node. + required: true type: string + example: __HOSTNAME__ put: tags: - - Business - summary: create or update an existing metadatum - description: create or update an existing metadatum - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + - CloudInfrastructure + summary: create or update an existing pserver + description: | + Create or update an existing pserver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructurePserversPserver consumes: - application/json - application/xml @@ -12024,37 +13119,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type + - name: hostname in: path - description: Value defined by orchestration to identify this service across ECOMP. + description: Value from executing hostname on the compute node. required: true type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service + example: __HOSTNAME__ + - name: body + in: body + description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json) required: true - type: string - - name: metaname + schema: + $ref: "#/definitions/pserver" + patch: + tags: + - CloudInfrastructure + summary: update an existing pserver + description: | + Update an existing pserver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructurePserversPserver + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: hostname in: path + description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: body in: body - description: metadatum object that needs to be created or updated + description: pserver object that needs to be updated. required: true schema: - $ref: "#/definitions/metadatum" + $ref: "#/patchDefinitions/pserver" delete: tags: - - Business - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + - CloudInfrastructure + summary: delete an existing pserver + description: delete an existing pserver + operationId: deleteCloudInfrastructurePserversPserver consumes: - application/json - application/xml @@ -12065,37 +13186,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - - name: metaname + - name: hostname in: path + description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata: + /cloud-infrastructure/pservers: get: tags: - - Business - summary: returns metadata - description: returns metadata - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata + - CloudInfrastructure + summary: returns pservers + description: returns pservers + operationId: getCloudInfrastructurePservers produces: - application/json - application/xml @@ -12103,86 +13211,41 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/metadata" + $ref: "#/getDefinitions/pservers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id + - name: hostname in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: inv-status in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: pserver-id in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - - name: service-instance-location-id + - name: in-maint in: query - description: An identifier that customers assign to the location where this service is being used. + description: required: false - type: string - - name: orchestration-status + type: boolean + - name: pserver-name2 in: query - description: Orchestration status of this service. + description: required: false type: string - /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: + /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: put: tags: - - Business + - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship consumes: - application/json - application/xml @@ -12193,43 +13256,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - - name: id - in: path - description: Allotted Resource id UUID assigned to this instance. - required: true - type: string - - name: id + - name: vdc-id in: path - description: Allotted Resource id UUID assigned to this instance. + description: Unique ID of the vdc required: true type: string + example: __VDC-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - Business + - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship consumes: - application/json - application/xml @@ -12240,38 +13284,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id - in: path - description: Global customer id used across ECOMP to uniquely identify customer. - required: true - type: string - - name: service-type - in: path - description: Value defined by orchestration to identify this service across ECOMP. - required: true - type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service - required: true - type: string - - name: id - in: path - description: Allotted Resource id UUID assigned to this instance. - required: true - type: string - - name: id + - name: vdc-id in: path - description: Allotted Resource id UUID assigned to this instance. + description: Unique ID of the vdc required: true type: string - /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}: + example: __VDC-ID__ + /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}: get: tags: - - Business - summary: returns tunnel-xconnect - description: returns tunnel-xconnect - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + - CloudInfrastructure + summary: returns virtual-data-center + description: returns virtual-data-center + operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter produces: - application/json - application/xml @@ -12279,116 +13304,147 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/tunnel-xconnect" + $ref: "#/getDefinitions/virtual-data-center" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id + - name: vdc-id in: path - description: Global customer id used across ECOMP to uniquely identify customer. + description: Unique ID of the vdc required: true type: string - - name: service-type + example: __VDC-ID__ + put: + tags: + - CloudInfrastructure + summary: create or update an existing virtual-data-center + description: | + Create or update an existing virtual-data-center. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id in: path - description: Value defined by orchestration to identify this service across ECOMP. + description: Unique ID of the vdc required: true type: string - - name: service-instance-id + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) + required: true + schema: + $ref: "#/definitions/virtual-data-center" + patch: + tags: + - CloudInfrastructure + summary: update an existing virtual-data-center + description: | + Update an existing virtual-data-center + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id in: path - description: Uniquely identifies this instance of a service + description: Unique ID of the vdc required: true type: string - - name: id + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/virtual-data-center" + delete: + tags: + - CloudInfrastructure + summary: delete an existing virtual-data-center + description: delete an existing virtual-data-center + operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id in: path - description: Allotted Resource id UUID assigned to this instance. + description: Unique ID of the vdc required: true type: string - - name: id - in: path - description: Allotted Resource id UUID assigned to this instance. - required: true - type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id + example: __VDC-ID__ + - name: resource-version in: query - description: the ASDC model version for this resource or service model. - required: false + description: resource-version for concurrency + required: true type: string - - name: type + /cloud-infrastructure/virtual-data-centers: + get: + tags: + - CloudInfrastructure + summary: returns virtual-data-centers + description: returns virtual-data-centers + operationId: getCloudInfrastructureVirtualDataCenters + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/virtual-data-centers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vdc-id in: query - description: Generic description of the type of allotted resource. + description: required: false type: string - - name: role + - name: vdc-name in: query - description: role in the network that this resource will be providing. + description: required: false type: string + /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: - Business - summary: create or update an existing tunnel-xconnect - description: create or update an existing tunnel-xconnect - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship consumes: - application/json - application/xml @@ -12399,43 +13455,122 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id + - name: resource-instance-id in: path - description: Global customer id used across ECOMP to uniquely identify customer. + description: Unique id of resource instance. required: true type: string - - name: service-type + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: path - description: Value defined by orchestration to identify this service across ECOMP. + description: Unique id of resource instance. required: true type: string - - name: service-instance-id + example: __RESOURCE-INSTANCE-ID__ + /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}: + get: + tags: + - Business + summary: returns metadatum + description: returns metadatum + operationId: getBusinessConnectorsConnectorMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: path - description: Uniquely identifies this instance of a service + description: Unique id of resource instance. required: true type: string - - name: id + example: __RESOURCE-INSTANCE-ID__ + - name: metaname in: path - description: Allotted Resource id UUID assigned to this instance. required: true type: string - - name: id + example: __METANAME__ + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: metaname in: path - description: Allotted Resource id UUID assigned to this instance. required: true type: string + example: __METANAME__ - name: body in: body - description: tunnel-xconnect object that needs to be created or updated + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json) required: true schema: - $ref: "#/definitions/tunnel-xconnect" - delete: + $ref: "#/definitions/metadatum" + patch: tags: - Business - summary: delete an existing tunnel-xconnect - description: delete an existing tunnel-xconnect - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum consumes: - application/json - application/xml @@ -12446,43 +13581,62 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id + - name: resource-instance-id in: path - description: Global customer id used across ECOMP to uniquely identify customer. + description: Unique id of resource instance. required: true type: string - - name: service-type + example: __RESOURCE-INSTANCE-ID__ + - name: metaname in: path - description: Value defined by orchestration to identify this service across ECOMP. required: true type: string - - name: service-instance-id - in: path - description: Uniquely identifies this instance of a service + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be updated. required: true - type: string - - name: id + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Business + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessConnectorsConnectorMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: path - description: Allotted Resource id UUID assigned to this instance. + description: Unique id of resource instance. required: true type: string - - name: id + example: __RESOURCE-INSTANCE-ID__ + - name: metaname in: path - description: Allotted Resource id UUID assigned to this instance. required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /business/connectors/connector/{resource-instance-id}/metadata: get: tags: - Business - summary: returns tunnel-xconnects - description: returns tunnel-xconnects - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects + summary: returns metadata + description: returns metadata + operationId: getBusinessConnectorsConnectorMetadata produces: - application/json - application/xml @@ -12490,111 +13644,191 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/tunnel-xconnects" + $ref: "#/getDefinitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: global-customer-id + - name: resource-instance-id in: path - description: Global customer id used across ECOMP to uniquely identify customer. + description: Unique id of resource instance. required: true type: string - - name: service-type + example: __RESOURCE-INSTANCE-ID__ + - name: metaname + in: query + description: + required: false + type: string + /business/connectors/connector/{resource-instance-id}: + get: + tags: + - Business + summary: returns connector + description: returns connector + operationId: getBusinessConnectorsConnector + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/connector" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: path - description: Value defined by orchestration to identify this service across ECOMP. + description: Unique id of resource instance. required: true type: string - - name: service-instance-id + example: __RESOURCE-INSTANCE-ID__ + put: + tags: + - Business + summary: create or update an existing connector + description: | + Create or update an existing connector. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: path - description: Uniquely identifies this instance of a service + description: Unique id of resource instance. required: true type: string - - name: id + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json) + required: true + schema: + $ref: "#/definitions/connector" + patch: + tags: + - Business + summary: update an existing connector + description: | + Update an existing connector + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: path - description: Allotted Resource id UUID assigned to this instance. + description: Unique id of resource instance. required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/connector" + delete: + tags: + - Business + summary: delete an existing connector + description: delete an existing connector + operationId: deleteBusinessConnectorsConnector + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id + in: path + description: Unique id of resource instance. + required: true type: string - - name: environment-context + example: __RESOURCE-INSTANCE-ID__ + - name: resource-version in: query - description: This field will store the environment context assigned to the service-instance. - required: false + description: resource-version for concurrency + required: true type: string - - name: workload-context + /business/connectors: + get: + tags: + - Business + summary: returns connectors + description: returns connectors + operationId: getBusinessConnectors + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/connectors" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: resource-instance-id in: query - description: This field will store the workload context assigned to the service-instance. + description: required: false type: string - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false - type: string - - name: role - in: query - description: role in the network that this resource will be providing. + description: required: false type: string - /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: + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship: put: tags: - Business summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship consumes: - application/json - application/xml @@ -12610,24 +13844,22 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: id - in: path - description: Allotted Resource id UUID assigned to this instance. - required: true - type: string + example: __SERVICE-INSTANCE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) required: true schema: $ref: "#/definitions/relationship" @@ -12636,7 +13868,7 @@ paths: - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship consumes: - application/json - application/xml @@ -12652,28 +13884,26 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: id - in: path - description: Allotted Resource id UUID assigned to this instance. - required: true - type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}: + example: __SERVICE-INSTANCE-ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: get: tags: - Business - summary: returns allotted-resource - description: returns allotted-resource - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + summary: returns metadatum + description: returns metadatum + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum produces: - application/json - application/xml @@ -12681,7 +13911,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/allotted-resource" + $ref: "#/getDefinitions/metadatum" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12690,102 +13920,89 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: id + example: __SERVICE-INSTANCE-ID__ + - name: metaname in: path - description: Allotted Resource id UUID assigned to this instance. required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false - type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + example: __METANAME__ + put: + tags: + - Business + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: type - in: query - description: Generic description of the type of allotted resource. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: role - in: query - description: role in the network that this resource will be providing. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: metaname + in: path + required: true type: string - put: + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: tags: - Business - summary: create or update an existing allotted-resource - description: create or update an existing allotted-resource - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum consumes: - application/json - application/xml @@ -12801,33 +14018,36 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: id + example: __SERVICE-INSTANCE-ID__ + - name: metaname in: path - description: Allotted Resource id UUID assigned to this instance. required: true type: string + example: __METANAME__ - name: body in: body - description: allotted-resource object that needs to be created or updated + description: metadatum object that needs to be updated. required: true schema: - $ref: "#/definitions/allotted-resource" + $ref: "#/patchDefinitions/metadatum" delete: tags: - Business - summary: delete an existing allotted-resource - description: delete an existing allotted-resource - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum consumes: - application/json - application/xml @@ -12843,33 +14063,36 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: id + example: __SERVICE-INSTANCE-ID__ + - name: metaname in: path - description: Allotted Resource id UUID assigned to this instance. required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources: + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata: get: tags: - Business - summary: returns allotted-resources - description: returns allotted-resources - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources + summary: returns metadata + description: returns metadata + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata produces: - application/json - application/xml @@ -12877,7 +14100,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/allotted-resources" + $ref: "#/getDefinitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12886,78 +14109,129 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type + example: __SERVICE-INSTANCE-ID__ + - name: metaname in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: required: false type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false + /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: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + /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}: get: tags: - Business - summary: returns service-instance - description: returns service-instance - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + summary: returns tunnel-xconnect + description: returns tunnel-xconnect + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect produces: - application/json - application/xml @@ -12965,7 +14239,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-instance" + $ref: "#/getDefinitions/tunnel-xconnect" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12974,77 +14248,103 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false - type: string - - name: service-instance-name - in: query - description: This field will store a name assigned to the service-instance. - required: false - type: string - - name: environment-context - in: query - description: This field will store the environment context assigned to the service-instance. - required: false - type: string - - name: workload-context - in: query - description: This field will store the workload context assigned to the service-instance. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __ID__ + put: + tags: + - Business + summary: create or update an existing tunnel-xconnect + description: | + Create or update an existing tunnel-xconnect. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: service-instance-location-id - in: query - description: An identifier that customers assign to the location where this service is being used. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - - name: orchestration-status - in: query - description: Orchestration status of this service. - required: false + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string - put: + example: __ID__ + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) + required: true + schema: + $ref: "#/definitions/tunnel-xconnect" + patch: tags: - Business - summary: create or update an existing service-instance - description: create or update an existing service-instance - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + summary: update an existing tunnel-xconnect + description: | + Update an existing tunnel-xconnect + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect consumes: - application/json - application/xml @@ -13060,28 +14360,43 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ - name: body in: body - description: service-instance object that needs to be created or updated + description: tunnel-xconnect object that needs to be updated. required: true schema: - $ref: "#/definitions/service-instance" + $ref: "#/patchDefinitions/tunnel-xconnect" delete: tags: - Business - summary: delete an existing service-instance - description: delete an existing service-instance - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance + summary: delete an existing tunnel-xconnect + description: delete an existing tunnel-xconnect + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect consumes: - application/json - application/xml @@ -13097,28 +14412,43 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances: + /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: get: tags: - Business - summary: returns service-instances - description: returns service-instances - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances + summary: returns tunnel-xconnects + description: returns tunnel-xconnects + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects produces: - application/json - application/xml @@ -13126,7 +14456,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-instances" + $ref: "#/getDefinitions/tunnel-xconnects" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13135,27 +14465,36 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: subscriber-type + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: id in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: required: false type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: + /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: put: tags: - Business summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship consumes: - application/json - application/xml @@ -13171,14 +14510,28 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) required: true schema: $ref: "#/definitions/relationship" @@ -13187,7 +14540,7 @@ paths: - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship consumes: - application/json - application/xml @@ -13203,18 +14556,32 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}: + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}: get: tags: - Business - summary: returns service-subscription - description: returns service-subscription - operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + summary: returns allotted-resource + description: returns allotted-resource + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource produces: - application/json - application/xml @@ -13222,7 +14589,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-subscription" + $ref: "#/getDefinitions/allotted-resource" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13231,27 +14598,34 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true type: string + example: __ID__ put: tags: - Business - summary: create or update an existing service-subscription - description: create or update an existing service-subscription - operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + summary: create or update an existing allotted-resource + description: | + Create or update an existing allotted-resource. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource consumes: - application/json - application/xml @@ -13267,23 +14641,94 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ - name: body in: body - description: service-subscription object that needs to be created or updated + description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) required: true schema: - $ref: "#/definitions/service-subscription" + $ref: "#/definitions/allotted-resource" + patch: + tags: + - Business + summary: update an existing allotted-resource + description: | + Update an existing allotted-resource + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: allotted-resource object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/allotted-resource" delete: tags: - Business - summary: delete an existing service-subscription - description: delete an existing service-subscription - operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + summary: delete an existing allotted-resource + description: delete an existing allotted-resource + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource consumes: - application/json - application/xml @@ -13299,23 +14744,37 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: service-type in: path description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /business/customers/customer/{global-customer-id}/service-subscriptions: + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources: get: tags: - Business - summary: returns service-subscriptions - description: returns service-subscriptions - operationId: getBusinessCustomersCustomerServiceSubscriptions + summary: returns allotted-resources + description: returns allotted-resources + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources produces: - application/json - application/xml @@ -13323,7 +14782,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-subscriptions" + $ref: "#/getDefinitions/allotted-resources" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13332,29 +14791,59 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - - name: subscriber-name + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + - name: id in: query - description: Subscriber name, an alternate way to retrieve a customer. + description: required: false type: string - - name: subscriber-type + - name: model-invariant-id in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: required: false type: string - /business/customers/customer/{global-customer-id}/relationship-list/relationship: - put: + - name: model-version-id + in: query + description: + required: false + type: string + - name: type + in: query + description: + required: false + type: string + - name: role + in: query + description: + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}: + get: tags: - Business - summary: see node definition for valid relationships - operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns service-instance + description: returns service-instance + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service-instance" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13363,18 +14852,28 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ + put: tags: - Business - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteBusinessCustomersCustomerRelationshipListRelationship + summary: create or update an existing service-instance + description: | + Create or update an existing service-instance. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance consumes: - application/json - application/xml @@ -13390,45 +14889,42 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - /business/customers/customer/{global-customer-id}: - get: - tags: - - Business - summary: returns customer - description: returns customer - operationId: getBusinessCustomersCustomer - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/customer" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: global-customer-id + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type in: path - description: Global customer id used across ECOMP to uniquely identify customer. + description: Value defined by orchestration to identify this service across ECOMP. required: true type: string - - name: subscriber-name - in: query - description: Subscriber name, an alternate way to retrieve a customer. - required: false - type: string - - name: subscriber-type - in: query - description: Subscriber type, a way to provide VID with only the INFRA customers. - required: false + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true type: string - put: + example: __SERVICE-INSTANCE-ID__ + - name: body + in: body + description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) + required: true + schema: + $ref: "#/definitions/service-instance" + patch: tags: - Business - summary: create or update an existing customer - description: create or update an existing customer - operationId: createOrUpdateBusinessCustomersCustomer + summary: update an existing service-instance + description: | + Update an existing service-instance + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance consumes: - application/json - application/xml @@ -13444,18 +14940,31 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ - name: body in: body - description: customer object that needs to be created or updated + description: service-instance object that needs to be updated. required: true schema: - $ref: "#/definitions/customer" + $ref: "#/patchDefinitions/service-instance" delete: tags: - Business - summary: delete an existing customer - description: delete an existing customer - operationId: deleteBusinessCustomersCustomer + summary: delete an existing service-instance + description: delete an existing service-instance + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance consumes: - application/json - application/xml @@ -13471,18 +14980,31 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: path + description: Uniquely identifies this instance of a service + required: true + type: string + example: __SERVICE-INSTANCE-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /business/customers: + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances: get: tags: - Business - summary: returns customers - description: returns customers - operationId: getBusinessCustomers + summary: returns service-instances + description: returns service-instances + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances produces: - application/json - application/xml @@ -13490,15 +15012,78 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/customers" + $ref: "#/getDefinitions/service-instances" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: - put: - tags: - - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + - name: service-instance-id + in: query + description: + required: false + type: string + - name: service-instance-name + in: query + description: + required: false + type: string + - name: environment-context + in: query + description: + required: false + type: string + - name: workload-context + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: service-instance-location-id + in: query + description: + required: false + type: string + - name: orchestration-status + in: query + description: + required: false + type: string + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship consumes: - application/json - application/xml @@ -13509,23 +15094,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-image-uuid + - name: global-customer-id in: path - description: Unique ID of this asset + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - ServiceDesignAndCreation + - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship consumes: - application/json - application/xml @@ -13536,18 +15128,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-image-uuid + - name: global-customer-id in: path - description: Unique ID of this asset + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ + /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}: get: tags: - - ServiceDesignAndCreation - summary: returns vnf-image - description: returns vnf-image - operationId: getServiceDesignAndCreationVnfImagesVnfImage + - Business + summary: returns service-subscription + description: returns service-subscription + operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription produces: - application/json - application/xml @@ -13555,36 +15154,76 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnf-image" + $ref: "#/getDefinitions/service-subscription" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-image-uuid + - name: global-customer-id in: path - description: Unique ID of this asset + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - - name: application - in: query - description: The application that the image instantiates. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false + example: __SERVICE-TYPE__ + put: + tags: + - Business + summary: create or update an existing service-subscription + description: | + Create or update an existing service-subscription. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true type: string - - name: application-version - in: query - description: The version of the application. - required: false + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true type: string - put: + example: __SERVICE-TYPE__ + - name: body + in: body + description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) + required: true + schema: + $ref: "#/definitions/service-subscription" + patch: tags: - - ServiceDesignAndCreation - summary: create or update an existing vnf-image - description: create or update an existing vnf-image - operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage + - Business + summary: update an existing service-subscription + description: | + Update an existing service-subscription + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription consumes: - application/json - application/xml @@ -13595,23 +15234,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-image-uuid + - name: global-customer-id in: path - description: Unique ID of this asset + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. + required: true + type: string + example: __SERVICE-TYPE__ - name: body in: body - description: vnf-image object that needs to be created or updated + description: service-subscription object that needs to be updated. required: true schema: - $ref: "#/definitions/vnf-image" + $ref: "#/patchDefinitions/service-subscription" delete: tags: - - ServiceDesignAndCreation - summary: delete an existing vnf-image - description: delete an existing vnf-image - operationId: deleteServiceDesignAndCreationVnfImagesVnfImage + - Business + summary: delete an existing service-subscription + description: delete an existing service-subscription + operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription consumes: - application/json - application/xml @@ -13622,23 +15268,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-image-uuid + - name: global-customer-id in: path - description: Unique ID of this asset + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: path + description: Value defined by orchestration to identify this service across ECOMP. required: true type: string + example: __SERVICE-TYPE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/vnf-images: + /business/customers/customer/{global-customer-id}/service-subscriptions: get: tags: - - ServiceDesignAndCreation - summary: returns vnf-images - description: returns vnf-images - operationId: getServiceDesignAndCreationVnfImages + - Business + summary: returns service-subscriptions + description: returns service-subscriptions + operationId: getBusinessCustomersCustomerServiceSubscriptions produces: - application/json - application/xml @@ -13646,15 +15299,27 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnf-images" + $ref: "#/getDefinitions/service-subscriptions" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: service-type + in: query + description: + required: false + type: string + /business/customers/customer/{global-customer-id}/relationship-list/relationship: put: tags: - - ServiceDesignAndCreation + - Business summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship + operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship consumes: - application/json - application/xml @@ -13665,23 +15330,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-id + - name: global-customer-id in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - ServiceDesignAndCreation + - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship + operationId: deleteBusinessCustomersCustomerRelationshipListRelationship consumes: - application/json - application/xml @@ -13692,18 +15358,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-id + - name: global-customer-id in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - /service-design-and-creation/services/service/{service-id}: + example: __GLOBAL-CUSTOMER-ID__ + /business/customers/customer/{global-customer-id}: get: tags: - - ServiceDesignAndCreation - summary: returns service - description: returns service - operationId: getServiceDesignAndCreationServicesService + - Business + summary: returns customer + description: returns customer + operationId: getBusinessCustomersCustomer produces: - application/json - application/xml @@ -13711,26 +15378,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service" + $ref: "#/getDefinitions/customer" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-id + - name: global-customer-id in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string - - name: service-description - in: query - description: Description of the service - required: false - type: string + example: __GLOBAL-CUSTOMER-ID__ put: tags: - - ServiceDesignAndCreation - summary: create or update an existing service - description: create or update an existing service - operationId: createOrUpdateServiceDesignAndCreationServicesService + - Business + summary: create or update an existing customer + description: | + Create or update an existing customer. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessCustomersCustomer consumes: - application/json - application/xml @@ -13741,23 +15407,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-id + - name: global-customer-id in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: body in: body - description: service object that needs to be created or updated + description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json) required: true schema: - $ref: "#/definitions/service" + $ref: "#/definitions/customer" + patch: + tags: + - Business + summary: update an existing customer + description: | + Update an existing customer + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessCustomersCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: global-customer-id + in: path + description: Global customer id used across ECOMP to uniquely identify customer. + required: true + type: string + example: __GLOBAL-CUSTOMER-ID__ + - name: body + in: body + description: customer object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/customer" delete: tags: - - ServiceDesignAndCreation - summary: delete an existing service - description: delete an existing service - operationId: deleteServiceDesignAndCreationServicesService + - Business + summary: delete an existing customer + description: delete an existing customer + operationId: deleteBusinessCustomersCustomer consumes: - application/json - application/xml @@ -13768,23 +15474,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-id + - name: global-customer-id in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/services: + /business/customers: get: tags: - - ServiceDesignAndCreation - summary: returns services - description: returns services - operationId: getServiceDesignAndCreationServices + - Business + summary: returns customers + description: returns customers + operationId: getBusinessCustomers produces: - application/json - application/xml @@ -13792,15 +15499,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/services" + $ref: "#/getDefinitions/customers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: + parameters: + - name: global-customer-id + in: query + description: + required: false + type: string + - name: subscriber-name + in: query + description: + required: false + type: string + - name: subscriber-type + in: query + description: + required: false + type: string + /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship: put: tags: - - ServiceDesignAndCreation + - Business summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship + operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship consumes: - application/json - application/xml @@ -13811,28 +15534,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-type + - name: line-of-business-name in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. - required: true - type: string - - name: vnf-type - in: path - 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. + description: Name of the line-of-business (product) required: true type: string + example: __LINE-OF-BUSINESS-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - ServiceDesignAndCreation + - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship + operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship consumes: - application/json - application/xml @@ -13843,23 +15562,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-type - in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. - required: true - type: string - - name: vnf-type + - name: line-of-business-name in: path - 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. + description: Name of the line-of-business (product) required: true type: string - /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}: + example: __LINE-OF-BUSINESS-NAME__ + /business/lines-of-business/line-of-business/{line-of-business-name}: get: tags: - - ServiceDesignAndCreation - summary: returns service-capability - description: returns service-capability - operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability + - Business + summary: returns line-of-business + description: returns line-of-business + operationId: getBusinessLinesOfBusinessLineOfBusiness produces: - application/json - application/xml @@ -13867,26 +15582,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-capability" + $ref: "#/getDefinitions/line-of-business" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-type - in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. - required: true - type: string - - name: vnf-type + - name: line-of-business-name in: path - 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. + description: Name of the line-of-business (product) required: true type: string + example: __LINE-OF-BUSINESS-NAME__ put: tags: - - ServiceDesignAndCreation - summary: create or update an existing service-capability - description: create or update an existing service-capability - operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability + - Business + summary: create or update an existing line-of-business + description: | + Create or update an existing line-of-business. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness consumes: - application/json - application/xml @@ -13897,28 +15611,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-type + - name: line-of-business-name in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + description: Name of the line-of-business (product) required: true type: string - - name: vnf-type + example: __LINE-OF-BUSINESS-NAME__ + - name: body + in: body + description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json) + required: true + schema: + $ref: "#/definitions/line-of-business" + patch: + tags: + - Business + summary: update an existing line-of-business + description: | + Update an existing line-of-business + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessLinesOfBusinessLineOfBusiness + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: line-of-business-name in: path - 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. + description: Name of the line-of-business (product) required: true type: string + example: __LINE-OF-BUSINESS-NAME__ - name: body in: body - description: service-capability object that needs to be created or updated + description: line-of-business object that needs to be updated. required: true schema: - $ref: "#/definitions/service-capability" + $ref: "#/patchDefinitions/line-of-business" delete: tags: - - ServiceDesignAndCreation - summary: delete an existing service-capability - description: delete an existing service-capability - operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability + - Business + summary: delete an existing line-of-business + description: delete an existing line-of-business + operationId: deleteBusinessLinesOfBusinessLineOfBusiness consumes: - application/json - application/xml @@ -13929,28 +15678,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: service-type - in: path - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. - required: true - type: string - - name: vnf-type + - name: line-of-business-name in: path - 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. + description: Name of the line-of-business (product) required: true type: string + example: __LINE-OF-BUSINESS-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/service-capabilities: + /business/lines-of-business: get: tags: - - ServiceDesignAndCreation - summary: returns service-capabilities - description: returns service-capabilities - operationId: getServiceDesignAndCreationServiceCapabilities + - Business + summary: returns lines-of-business + description: returns lines-of-business + operationId: getBusinessLinesOfBusiness produces: - application/json - application/xml @@ -13958,15 +15703,21 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-capabilities" + $ref: "#/getDefinitions/lines-of-business" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /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: + parameters: + - name: line-of-business-name + in: query + description: + required: false + type: string + /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship: put: tags: - - ServiceDesignAndCreation + - Business summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship + operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship consumes: - application/json - application/xml @@ -13977,44 +15728,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid - in: path - required: true - type: string - - name: element-choice-set-uuid + - name: owning-entity-id in: path + description: UUID of an owning entity required: true type: string + example: __OWNING-ENTITY-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - ServiceDesignAndCreation + - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship + operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship consumes: - application/json - application/xml @@ -14025,39 +15756,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid - in: path - required: true - type: string - - name: element-choice-set-uuid + - name: owning-entity-id in: path + description: UUID of an owning entity required: true type: string - /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}: + example: __OWNING-ENTITY-ID__ + /business/owning-entities/owning-entity/{owning-entity-id}: get: tags: - - ServiceDesignAndCreation - summary: returns element-choice-set - description: returns element-choice-set - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + - Business + summary: returns owning-entity + description: returns owning-entity + operationId: getBusinessOwningEntitiesOwningEntity produces: - application/json - application/xml @@ -14065,57 +15776,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/element-choice-set" + $ref: "#/getDefinitions/owning-entity" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid - in: path - required: true - type: string - - name: element-choice-set-uuid + - name: owning-entity-id in: path + description: UUID of an owning entity required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string + example: __OWNING-ENTITY-ID__ put: tags: - - ServiceDesignAndCreation - summary: create or update an existing element-choice-set - description: create or update an existing element-choice-set - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + - Business + summary: create or update an existing owning-entity + description: | + Create or update an existing owning-entity. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessOwningEntitiesOwningEntity consumes: - application/json - application/xml @@ -14126,44 +15805,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid + - name: owning-entity-id in: path + description: UUID of an owning entity required: true type: string - - name: constrained-element-set-uuid - in: path + example: __OWNING-ENTITY-ID__ + - name: body + in: body + description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json) required: true - type: string - - name: element-choice-set-uuid + schema: + $ref: "#/definitions/owning-entity" + patch: + tags: + - Business + summary: update an existing owning-entity + description: | + Update an existing owning-entity + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessOwningEntitiesOwningEntity + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: owning-entity-id in: path + description: UUID of an owning entity required: true type: string + example: __OWNING-ENTITY-ID__ - name: body in: body - description: element-choice-set object that needs to be created or updated + description: owning-entity object that needs to be updated. required: true schema: - $ref: "#/definitions/element-choice-set" + $ref: "#/patchDefinitions/owning-entity" delete: tags: - - ServiceDesignAndCreation - summary: delete an existing element-choice-set - description: delete an existing element-choice-set - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet + - Business + summary: delete an existing owning-entity + description: delete an existing owning-entity + operationId: deleteBusinessOwningEntitiesOwningEntity consumes: - application/json - application/xml @@ -14174,44 +15872,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid - in: path - required: true - type: string - - name: element-choice-set-uuid + - name: owning-entity-id in: path + description: UUID of an owning entity required: true type: string + example: __OWNING-ENTITY-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /business/owning-entities: get: tags: - - ServiceDesignAndCreation - summary: returns element-choice-sets - description: returns element-choice-sets - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets + - Business + summary: returns owning-entities + description: returns owning-entities + operationId: getBusinessOwningEntities produces: - application/json - application/xml @@ -14219,53 +15897,21 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/element-choice-sets" + $ref: "#/getDefinitions/owning-entities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid - in: path - required: true - type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: owning-entity-id in: query - description: Version + description: required: false type: string - /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: + /business/platforms/platform/{platform-name}/relationship-list/relationship: put: tags: - - ServiceDesignAndCreation + - Business summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship + operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship consumes: - application/json - application/xml @@ -14276,40 +15922,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid + - name: platform-name in: path + description: Name of the platform required: true type: string + example: __PLATFORM-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - ServiceDesignAndCreation + - Business summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship + operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship consumes: - application/json - application/xml @@ -14320,35 +15950,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid + - name: platform-name in: path + description: Name of the platform required: true type: string - /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}: + example: __PLATFORM-NAME__ + /business/platforms/platform/{platform-name}: get: tags: - - ServiceDesignAndCreation - summary: returns constrained-element-set - description: returns constrained-element-set - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + - Business + summary: returns platform + description: returns platform + operationId: getBusinessPlatformsPlatform produces: - application/json - application/xml @@ -14356,53 +15970,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/constrained-element-set" + $ref: "#/getDefinitions/platform" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid + - name: platform-name in: path + description: Name of the platform required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string + example: __PLATFORM-NAME__ put: tags: - - ServiceDesignAndCreation - summary: create or update an existing constrained-element-set - description: create or update an existing constrained-element-set - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + - Business + summary: create or update an existing platform + description: | + Create or update an existing platform. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessPlatformsPlatform consumes: - application/json - application/xml @@ -14413,40 +15999,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid + - name: platform-name in: path + description: Name of the platform required: true type: string - - name: model-constraint-uuid - in: path + example: __PLATFORM-NAME__ + - name: body + in: body + description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json) required: true - type: string - - name: constrained-element-set-uuid + schema: + $ref: "#/definitions/platform" + patch: + tags: + - Business + summary: update an existing platform + description: | + Update an existing platform + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessPlatformsPlatform + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: platform-name in: path + description: Name of the platform required: true type: string + example: __PLATFORM-NAME__ - name: body in: body - description: constrained-element-set object that needs to be created or updated + description: platform object that needs to be updated. required: true schema: - $ref: "#/definitions/constrained-element-set" + $ref: "#/patchDefinitions/platform" delete: tags: - - ServiceDesignAndCreation - summary: delete an existing constrained-element-set - description: delete an existing constrained-element-set - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + - Business + summary: delete an existing platform + description: delete an existing platform + operationId: deleteBusinessPlatformsPlatform consumes: - application/json - application/xml @@ -14457,40 +16066,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid - in: path - required: true - type: string - - name: constrained-element-set-uuid + - name: platform-name in: path + description: Name of the platform required: true type: string + example: __PLATFORM-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /business/platforms: get: tags: - - ServiceDesignAndCreation - summary: returns constrained-element-sets - description: returns constrained-element-sets - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets + - Business + summary: returns platforms + description: returns platforms + operationId: getBusinessPlatforms produces: - application/json - application/xml @@ -14498,50 +16091,72 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/constrained-element-sets" + $ref: "#/getDefinitions/platforms" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true + - name: platform-name + in: query + description: + required: false type: string - - name: model-version-id + /business/projects/project/{project-name}/relationship-list/relationship: + put: + tags: + - Business + summary: see node definition for valid relationships + operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name in: path - description: Unique identifier corresponding to one version of a model in ASDC + description: Name of the project deploying a service required: true type: string - - name: model-element-uuid - in: path + example: __PROJECT-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json) required: true - type: string - - name: model-constraint-uuid + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Business + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteBusinessProjectsProjectRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name in: path + description: Name of the project deploying a service required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string - /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}: + example: __PROJECT-NAME__ + /business/projects/project/{project-name}: get: tags: - - ServiceDesignAndCreation - summary: returns model-constraint - description: returns model-constraint - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + - Business + summary: returns project + description: returns project + operationId: getBusinessProjectsProject produces: - application/json - application/xml @@ -14549,49 +16164,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-constraint" + $ref: "#/getDefinitions/project" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid + - name: project-name in: path + description: Name of the project deploying a service required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string + example: __PROJECT-NAME__ put: tags: - - ServiceDesignAndCreation - summary: create or update an existing model-constraint - description: create or update an existing model-constraint - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + - Business + summary: create or update an existing project + description: | + Create or update an existing project. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateBusinessProjectsProject consumes: - application/json - application/xml @@ -14602,36 +16193,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id + - name: project-name in: path - description: Unique identifier corresponding to one version of a model in ASDC + description: Name of the project deploying a service required: true type: string - - name: model-element-uuid - in: path + example: __PROJECT-NAME__ + - name: body + in: body + description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json) required: true - type: string - - name: model-constraint-uuid + schema: + $ref: "#/definitions/project" + patch: + tags: + - Business + summary: update an existing project + description: | + Update an existing project + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateBusinessProjectsProject + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: project-name in: path + description: Name of the project deploying a service required: true type: string + example: __PROJECT-NAME__ - name: body in: body - description: model-constraint object that needs to be created or updated + description: project object that needs to be updated. required: true schema: - $ref: "#/definitions/model-constraint" + $ref: "#/patchDefinitions/project" delete: tags: - - ServiceDesignAndCreation - summary: delete an existing model-constraint - description: delete an existing model-constraint - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + - Business + summary: delete an existing project + description: delete an existing project + operationId: deleteBusinessProjectsProject consumes: - application/json - application/xml @@ -14642,36 +16260,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-constraint-uuid + - name: project-name in: path + description: Name of the project deploying a service required: true type: string + example: __PROJECT-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /business/projects: get: tags: - - ServiceDesignAndCreation - summary: returns model-constraints - description: returns model-constraints - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + - Business + summary: returns projects + description: returns projects + operationId: getBusinessProjects produces: - application/json - application/xml @@ -14679,45 +16285,21 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-constraints" + $ref: "#/getDefinitions/projects" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid - in: path - required: true - type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version + - name: project-name in: query - description: Version + description: required: false type: string - /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: + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship consumes: - application/json - application/xml @@ -14728,23 +16310,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid + - name: vnf-image-uuid in: path + description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json) required: true schema: $ref: "#/definitions/relationship" @@ -14753,7 +16327,7 @@ paths: - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship consumes: - application/json - application/xml @@ -14764,27 +16338,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid + - name: vnf-image-uuid in: path + description: Unique ID of this asset required: true type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}: + example: __VNF-IMAGE-UUID__ + /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: get: tags: - ServiceDesignAndCreation - summary: returns model-element - description: returns model-element - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + summary: returns vnf-image + description: returns vnf-image + operationId: getServiceDesignAndCreationVnfImagesVnfImage produces: - application/json - application/xml @@ -14792,45 +16358,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-element" + $ref: "#/getDefinitions/vnf-image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid + - name: vnf-image-uuid in: path + description: Unique ID of this asset required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string + example: __VNF-IMAGE-UUID__ put: tags: - ServiceDesignAndCreation - summary: create or update an existing model-element - description: create or update an existing model-element - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + summary: create or update an existing vnf-image + description: | + Create or update an existing vnf-image. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage consumes: - application/json - application/xml @@ -14841,32 +16387,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: vnf-image-uuid in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: Unique ID of this asset required: true type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC + example: __VNF-IMAGE-UUID__ + - name: body + in: body + description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json) required: true - type: string - - name: model-element-uuid + schema: + $ref: "#/definitions/vnf-image" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing vnf-image + description: | + Update an existing vnf-image + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-image-uuid in: path + description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ - name: body in: body - description: model-element object that needs to be created or updated + description: vnf-image object that needs to be updated. required: true schema: - $ref: "#/definitions/model-element" + $ref: "#/patchDefinitions/vnf-image" delete: tags: - ServiceDesignAndCreation - summary: delete an existing model-element - description: delete an existing model-element - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement + summary: delete an existing vnf-image + description: delete an existing vnf-image + operationId: deleteServiceDesignAndCreationVnfImagesVnfImage consumes: - application/json - application/xml @@ -14877,32 +16454,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-element-uuid + - name: vnf-image-uuid in: path + description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements: + /service-design-and-creation/vnf-images: get: tags: - ServiceDesignAndCreation - summary: returns model-elements - description: returns model-elements - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements + summary: returns vnf-images + description: returns vnf-images + operationId: getServiceDesignAndCreationVnfImages produces: - application/json - application/xml @@ -14910,88 +16479,113 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-elements" + $ref: "#/getDefinitions/vnf-images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-type + - name: vnf-image-uuid in: query - description: Type of the model, e.g., service, resource, widget, etc. + description: required: false type: string - - name: model-name + - name: application in: query - description: Name of the model, which can change from version to version. + description: required: false type: string - - name: model-version + - name: application-vendor in: query - description: Version + description: required: false type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: - get: + - name: application-version + in: query + description: + required: false + type: string + /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: + put: tags: - ServiceDesignAndCreation - summary: returns metadatum - description: returns metadatum - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/metadatum" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-id in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id + example: __SERVICE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - ServiceDesignAndCreation + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id in: path - description: Unique identifier corresponding to one version of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: metaname + example: __SERVICE-ID__ + /service-design-and-creation/services/service/{service-id}: + get: + tags: + - ServiceDesignAndCreation + summary: returns service + description: returns service + operationId: getServiceDesignAndCreationServicesService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false - type: string - - name: model-version - in: query - description: Version - required: false - type: string + example: __SERVICE-ID__ put: tags: - ServiceDesignAndCreation - summary: create or update an existing metadatum - description: create or update an existing metadatum - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + summary: create or update an existing service + description: | + Create or update an existing service. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationServicesService consumes: - application/json - application/xml @@ -15002,32 +16596,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-id in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC + example: __SERVICE-ID__ + - name: body + in: body + description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json) required: true - type: string - - name: metaname + schema: + $ref: "#/definitions/service" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing service + description: | + Update an existing service + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationServicesService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-id in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string + example: __SERVICE-ID__ - name: body in: body - description: metadatum object that needs to be created or updated + description: service object that needs to be updated. required: true schema: - $ref: "#/definitions/metadatum" + $ref: "#/patchDefinitions/service" delete: tags: - ServiceDesignAndCreation - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum + summary: delete an existing service + description: delete an existing service + operationId: deleteServiceDesignAndCreationServicesService consumes: - application/json - application/xml @@ -15038,32 +16663,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: metaname + - name: service-id in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string + example: __SERVICE-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata: + /service-design-and-creation/services: get: tags: - ServiceDesignAndCreation - summary: returns metadata - description: returns metadata - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata + summary: returns services + description: returns services + operationId: getServiceDesignAndCreationServices produces: - application/json - application/xml @@ -15071,41 +16688,26 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/metadata" + $ref: "#/getDefinitions/services" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true - type: string - - name: model-version-id - in: path - description: Unique identifier corresponding to one version of a model in ASDC - required: true - type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name + - name: service-id in: query - description: Name of the model, which can change from version to version. + description: required: false type: string - - name: model-version + - name: service-description in: query - description: Version + description: required: false type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: + /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship consumes: - application/json - application/xml @@ -15116,19 +16718,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-type in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id + example: __SERVICE-TYPE__ + - name: vnf-type in: path - description: Unique identifier corresponding to one version of a model in ASDC + 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. required: true type: string + example: __VNF-TYPE__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) required: true schema: $ref: "#/definitions/relationship" @@ -15137,7 +16741,7 @@ paths: - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship + operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship consumes: - application/json - application/xml @@ -15148,23 +16752,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-type in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id + example: __SERVICE-TYPE__ + - name: vnf-type in: path - description: Unique identifier corresponding to one version of a model in ASDC + 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. required: true type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}: + example: __VNF-TYPE__ + /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}: get: tags: - ServiceDesignAndCreation - summary: returns model-ver - description: returns model-ver - operationId: getServiceDesignAndCreationModelsModelModelVersModelVer + summary: returns service-capability + description: returns service-capability + operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability produces: - application/json - application/xml @@ -15172,41 +16778,76 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-ver" + $ref: "#/getDefinitions/service-capability" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-type in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id + example: __SERVICE-TYPE__ + - name: vnf-type in: path - description: Unique identifier corresponding to one version of a model in ASDC + 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. required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false - type: string - - name: model-name - in: query - description: Name of the model, which can change from version to version. - required: false + example: __VNF-TYPE__ + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing service-capability + description: | + Create or update an existing service-capability. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: service-type + in: path + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + required: true type: string - - name: model-version - in: query - description: Version - required: false + example: __SERVICE-TYPE__ + - name: vnf-type + in: path + 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. + required: true type: string - put: + example: __VNF-TYPE__ + - name: body + in: body + description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) + required: true + schema: + $ref: "#/definitions/service-capability" + patch: tags: - ServiceDesignAndCreation - summary: create or update an existing model-ver - description: create or update an existing model-ver - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer + summary: update an existing service-capability + description: | + Update an existing service-capability + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability consumes: - application/json - application/xml @@ -15217,28 +16858,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-type in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id + example: __SERVICE-TYPE__ + - name: vnf-type in: path - description: Unique identifier corresponding to one version of a model in ASDC + 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. required: true type: string + example: __VNF-TYPE__ - name: body in: body - description: model-ver object that needs to be created or updated + description: service-capability object that needs to be updated. required: true schema: - $ref: "#/definitions/model-ver" + $ref: "#/patchDefinitions/service-capability" delete: tags: - ServiceDesignAndCreation - summary: delete an existing model-ver - description: delete an existing model-ver - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer + summary: delete an existing service-capability + description: delete an existing service-capability + operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability consumes: - application/json - application/xml @@ -15249,28 +16892,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id + - name: service-type in: path - description: Unique identifier corresponding to the main definition of a model in ASDC + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true type: string - - name: model-version-id + example: __SERVICE-TYPE__ + - name: vnf-type in: path - description: Unique identifier corresponding to one version of a model in ASDC + 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. required: true type: string + example: __VNF-TYPE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/models/model/{model-invariant-id}/model-vers: + /service-design-and-creation/service-capabilities: get: tags: - ServiceDesignAndCreation - summary: returns model-vers - description: returns model-vers - operationId: getServiceDesignAndCreationModelsModelModelVers + summary: returns service-capabilities + description: returns service-capabilities + operationId: getServiceDesignAndCreationServiceCapabilities produces: - application/json - application/xml @@ -15278,26 +16923,26 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-vers" + $ref: "#/getDefinitions/service-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: model-invariant-id - in: path - description: Unique identifier corresponding to the main definition of a model in ASDC - required: true + - name: service-type + in: query + description: + required: false type: string - - name: model-type + - name: vnf-type in: query - description: Type of the model, e.g., service, resource, widget, etc. + description: required: false type: string - /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: + /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: put: tags: - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship consumes: - application/json - application/xml @@ -15313,9 +16958,36 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) required: true schema: $ref: "#/definitions/relationship" @@ -15324,7 +16996,7 @@ paths: - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship consumes: - application/json - application/xml @@ -15340,13 +17012,40 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - /service-design-and-creation/models/model/{model-invariant-id}: + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + /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}: get: tags: - ServiceDesignAndCreation - summary: returns model - description: returns model - operationId: getServiceDesignAndCreationModelsModel + summary: returns element-choice-set + description: returns element-choice-set + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet produces: - application/json - application/xml @@ -15354,7 +17053,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model" + $ref: "#/getDefinitions/element-choice-set" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15363,17 +17062,42 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: model-type - in: query - description: Type of the model, e.g., service, resource, widget, etc. - required: false + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true type: string + example: __ELEMENT-CHOICE-SET-UUID__ put: tags: - ServiceDesignAndCreation - summary: create or update an existing model - description: create or update an existing model - operationId: createOrUpdateServiceDesignAndCreationModelsModel + summary: create or update an existing element-choice-set + description: | + Create or update an existing element-choice-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet consumes: - application/json - application/xml @@ -15389,18 +17113,56 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ - name: body in: body - description: model object that needs to be created or updated + description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) required: true schema: - $ref: "#/definitions/model" - delete: + $ref: "#/definitions/element-choice-set" + patch: tags: - ServiceDesignAndCreation - summary: delete an existing model - description: delete an existing model - operationId: deleteServiceDesignAndCreationModelsModel + summary: update an existing element-choice-set + description: | + Update an existing element-choice-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet consumes: - application/json - application/xml @@ -15416,68 +17178,45 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - /service-design-and-creation/models: - get: - tags: - - ServiceDesignAndCreation - summary: returns models - description: returns models - operationId: getServiceDesignAndCreationModels - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/models" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /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: - put: - tags: - - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: named-query-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: named-query-element-uuid + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: path required: true type: string - - name: related-lookup-uuid + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid in: path required: true type: string + example: __ELEMENT-CHOICE-SET-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: element-choice-set object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/element-choice-set" delete: tags: - ServiceDesignAndCreation - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship + summary: delete an existing element-choice-set + description: delete an existing element-choice-set + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet consumes: - application/json - application/xml @@ -15488,25 +17227,50 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: related-lookup-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - /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}: + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid + in: path + required: true + type: string + example: __ELEMENT-CHOICE-SET-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /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: get: tags: - ServiceDesignAndCreation - summary: returns related-lookup - description: returns related-lookup - operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + summary: returns element-choice-sets + description: returns element-choice-sets + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets produces: - application/json - application/xml @@ -15514,32 +17278,48 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/related-lookup" + $ref: "#/getDefinitions/element-choice-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: related-lookup-uuid + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: path required: true type: string - - name: named-query-name + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: element-choice-set-uuid in: query + description: required: false type: string + /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: put: tags: - ServiceDesignAndCreation - summary: create or update an existing related-lookup - description: create or update an existing related-lookup - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship consumes: - application/json - application/xml @@ -15550,30 +17330,45 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: related-lookup-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: body - in: body - description: related-lookup object that needs to be created or updated + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) required: true schema: - $ref: "#/definitions/related-lookup" + $ref: "#/definitions/relationship" delete: tags: - ServiceDesignAndCreation - summary: delete an existing related-lookup - description: delete an existing related-lookup - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship consumes: - application/json - application/xml @@ -15584,30 +17379,40 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: related-lookup-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path required: true type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups: + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + /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}: get: tags: - ServiceDesignAndCreation - summary: returns related-lookups - description: returns related-lookups - operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups + summary: returns constrained-element-set + description: returns constrained-element-set + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet produces: - application/json - application/xml @@ -15615,62 +17420,106 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/related-lookups" + $ref: "#/getDefinitions/constrained-element-set" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: named-query-name - in: query - required: false + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true type: string - /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}: - get: + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + put: tags: - ServiceDesignAndCreation - summary: returns property-constraint - description: returns property-constraint - operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + summary: create or update an existing constrained-element-set + description: | + Create or update an existing constrained-element-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/property-constraint" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: property-constraint-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: named-query-name - in: query - required: false + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true type: string - put: + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ + - name: body + in: body + description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) + required: true + schema: + $ref: "#/definitions/constrained-element-set" + patch: tags: - ServiceDesignAndCreation - summary: create or update an existing property-constraint - description: create or update an existing property-constraint - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + summary: update an existing constrained-element-set + description: | + Update an existing constrained-element-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet consumes: - application/json - application/xml @@ -15681,30 +17530,45 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: property-constraint-uuid + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid in: path required: true type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ - name: body in: body - description: property-constraint object that needs to be created or updated + description: constrained-element-set object that needs to be updated. required: true schema: - $ref: "#/definitions/property-constraint" + $ref: "#/patchDefinitions/constrained-element-set" delete: tags: - ServiceDesignAndCreation - summary: delete an existing property-constraint - description: delete an existing property-constraint - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + summary: delete an existing constrained-element-set + description: delete an existing constrained-element-set + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet consumes: - application/json - application/xml @@ -15715,30 +17579,45 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: property-constraint-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: path required: true type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid + in: path + required: true + type: string + example: __CONSTRAINED-ELEMENT-SET-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints: + /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: get: tags: - ServiceDesignAndCreation - summary: returns property-constraints - description: returns property-constraints - operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints + summary: returns constrained-element-sets + description: returns constrained-element-sets + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets produces: - application/json - application/xml @@ -15746,58 +17625,86 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/property-constraints" + $ref: "#/getDefinitions/constrained-element-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: named-query-name + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + - name: constrained-element-set-uuid in: query + description: required: false type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship: - put: + /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}: + get: tags: - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns model-constraint + description: returns model-constraint + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraint" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid + in: path + required: true + type: string + example: __MODEL-CONSTRAINT-UUID__ + put: tags: - ServiceDesignAndCreation - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship + summary: create or update an existing model-constraint + description: | + Create or update an existing model-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint consumes: - application/json - application/xml @@ -15808,50 +17715,51 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}: - get: - tags: - - ServiceDesignAndCreation - summary: returns named-query-element - description: returns named-query-element - operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/named-query-element" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: named-query-uuid + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string - - name: named-query-element-uuid + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: path required: true type: string - - name: named-query-name - in: query - required: false - type: string - put: + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) + required: true + schema: + $ref: "#/definitions/model-constraint" + patch: tags: - ServiceDesignAndCreation - summary: create or update an existing named-query-element - description: create or update an existing named-query-element - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + summary: update an existing model-constraint + description: | + Update an existing model-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint consumes: - application/json - application/xml @@ -15862,26 +17770,40 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: path required: true type: string + example: __MODEL-CONSTRAINT-UUID__ - name: body in: body - description: named-query-element object that needs to be created or updated + description: model-constraint object that needs to be updated. required: true schema: - $ref: "#/definitions/named-query-element" + $ref: "#/patchDefinitions/model-constraint" delete: tags: - ServiceDesignAndCreation - summary: delete an existing named-query-element - description: delete an existing named-query-element - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint consumes: - application/json - application/xml @@ -15892,26 +17814,40 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-element-uuid + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: path required: true type: string + example: __MODEL-CONSTRAINT-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements: + /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: get: tags: - ServiceDesignAndCreation - summary: returns named-query-elements - description: returns named-query-elements - operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints produces: - application/json - application/xml @@ -15919,24 +17855,38 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/named-query-elements" + $ref: "#/getDefinitions/model-constraints" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: named-query-name + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: model-constraint-uuid in: query + description: required: false type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: + /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: put: tags: - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship consumes: - application/json - application/xml @@ -15947,13 +17897,26 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string + example: __MODEL-ELEMENT-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) required: true schema: $ref: "#/definitions/relationship" @@ -15962,7 +17925,7 @@ paths: - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship consumes: - application/json - application/xml @@ -15973,17 +17936,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - /service-design-and-creation/named-queries/named-query/{named-query-uuid}: + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}: get: tags: - ServiceDesignAndCreation - summary: returns named-query - description: returns named-query - operationId: getServiceDesignAndCreationNamedQueriesNamedQuery + summary: returns model-element + description: returns model-element + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement produces: - application/json - application/xml @@ -15991,24 +17967,36 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/named-query" + $ref: "#/getDefinitions/model-element" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: named-query-name - in: query - required: false + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true type: string + example: __MODEL-ELEMENT-UUID__ put: tags: - ServiceDesignAndCreation - summary: create or update an existing named-query - description: create or update an existing named-query - operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery + summary: create or update an existing model-element + description: | + Create or update an existing model-element. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement consumes: - application/json - application/xml @@ -16019,22 +18007,46 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id + in: path + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path required: true type: string + example: __MODEL-ELEMENT-UUID__ - name: body in: body - description: named-query object that needs to be created or updated + description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) required: true schema: - $ref: "#/definitions/named-query" - delete: + $ref: "#/definitions/model-element" + patch: tags: - ServiceDesignAndCreation - summary: delete an existing named-query - description: delete an existing named-query - operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery + summary: update an existing model-element + description: | + Update an existing model-element + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement consumes: - application/json - application/xml @@ -16045,65 +18057,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: named-query-uuid + - name: model-invariant-id in: path + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - /service-design-and-creation/named-queries: - get: - tags: - - ServiceDesignAndCreation - summary: returns named-queries - description: returns named-queries - operationId: getServiceDesignAndCreationNamedQueries - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/named-queries" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /network/logical-links/logical-link/{link-name}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string + example: __MODEL-ELEMENT-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: model-element object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/model-element" delete: tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship + - ServiceDesignAndCreation + summary: delete an existing model-element + description: delete an existing model-element + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement consumes: - application/json - application/xml @@ -16114,18 +18096,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: model-invariant-id in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - /network/logical-links/logical-link/{link-name}: + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true + type: string + example: __MODEL-VERSION-ID__ + - name: model-element-uuid + in: path + required: true + type: string + example: __MODEL-ELEMENT-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements: get: tags: - - Network - summary: returns logical-link - description: returns logical-link - operationId: getNetworkLogicalLinksLogicalLink + - ServiceDesignAndCreation + summary: returns model-elements + description: returns model-elements + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements produces: - application/json - application/xml @@ -16133,131 +18132,71 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/logical-link" + $ref: "#/getDefinitions/model-elements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: model-invariant-id in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string + example: __MODEL-INVARIANT-ID__ - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: link-id - in: query - description: UUID of the logical-link, SDNC generates this. - required: false - type: string - - name: circuit-id - in: query - description: Circuit id - required: false + in: path + description: Unique identifier corresponding to one version of a model in ASDC + required: true type: string - - name: purpose + example: __MODEL-VERSION-ID__ + - name: model-element-uuid in: query - description: Reason for this entity, role it is playing + description: required: false type: string - put: + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}: + get: tags: - - Network - summary: create or update an existing logical-link - description: create or update an existing logical-link - operationId: createOrUpdateNetworkLogicalLinksLogicalLink - consumes: - - application/json - - application/xml + - ServiceDesignAndCreation + summary: returns metadatum + description: returns metadatum + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: model-invariant-id in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: body - in: body - description: logical-link object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/logical-link" - delete: - tags: - - Network - summary: delete an existing logical-link - description: delete an existing logical-link - operationId: deleteNetworkLogicalLinksLogicalLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __MODEL-VERSION-ID__ + - name: metaname + in: path required: true type: string - /network/logical-links: - get: - tags: - - Network - summary: returns logical-links - description: returns logical-links - operationId: getNetworkLogicalLinks - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/logical-links" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /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: + example: __METANAME__ put: tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship + - ServiceDesignAndCreation + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum consumes: - application/json - application/xml @@ -16268,112 +18207,46 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: cos + example: __MODEL-VERSION-ID__ + - name: metaname in: path - description: unique identifier of probe required: true type: string + example: __METANAME__ - name: body in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id - in: path - description: Unique id of routing instance - required: true - type: string - - name: site-pair-id - in: path - description: unique identifier of probe - required: true - type: string - - name: cos - in: path - description: unique identifier of probe + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json) required: true - type: string - /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}: - get: - tags: - - Network - summary: returns class-of-service - description: returns class-of-service - operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation schema: - $ref: "#/definitions/class-of-service" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id - in: path - description: Unique id of routing instance - required: true - type: string - - name: site-pair-id - in: path - description: unique identifier of probe - required: true - type: string - - name: cos - in: path - description: unique identifier of probe - required: true - type: string - put: + $ref: "#/definitions/metadatum" + patch: tags: - - Network - summary: create or update an existing class-of-service - description: create or update an existing class-of-service - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + - ServiceDesignAndCreation + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum consumes: - application/json - application/xml @@ -16384,38 +18257,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: cos + example: __MODEL-VERSION-ID__ + - name: metaname in: path - description: unique identifier of probe required: true type: string + example: __METANAME__ - name: body in: body - description: class-of-service object that needs to be created or updated + description: metadatum object that needs to be updated. required: true schema: - $ref: "#/definitions/class-of-service" + $ref: "#/patchDefinitions/metadatum" delete: tags: - - Network - summary: delete an existing class-of-service - description: delete an existing class-of-service - operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + - ServiceDesignAndCreation + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum consumes: - application/json - application/xml @@ -16426,38 +18296,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: cos + example: __MODEL-VERSION-ID__ + - name: metaname in: path - description: unique identifier of probe required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata: get: tags: - - Network - summary: returns classes-of-service - description: returns classes-of-service - operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService + - ServiceDesignAndCreation + summary: returns metadata + description: returns metadata + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata produces: - application/json - application/xml @@ -16465,31 +18332,33 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/classes-of-service" + $ref: "#/getDefinitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: model-invariant-id in: path - description: Unique id of site pair set. + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: routing-instance-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: site-pair-id - in: path - description: unique identifier of probe - required: true + example: __MODEL-VERSION-ID__ + - name: metaname + in: query + description: + required: false type: string - /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: + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship: put: tags: - - Network + - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship consumes: - application/json - application/xml @@ -16500,33 +18369,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string + example: __MODEL-VERSION-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - Network + - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship consumes: - application/json - application/xml @@ -16537,28 +18403,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - /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}: + example: __MODEL-VERSION-ID__ + /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}: get: tags: - - Network - summary: returns site-pair - description: returns site-pair - operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + - ServiceDesignAndCreation + summary: returns model-ver + description: returns model-ver + operationId: getServiceDesignAndCreationModelsModelModelVersModelVer produces: - application/json - application/xml @@ -16566,31 +18429,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/site-pair" + $ref: "#/getDefinitions/model-ver" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string + example: __MODEL-VERSION-ID__ put: tags: - - Network - summary: create or update an existing site-pair - description: create or update an existing site-pair - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + - ServiceDesignAndCreation + summary: create or update an existing model-ver + description: | + Create or update an existing model-ver. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer consumes: - application/json - application/xml @@ -16601,33 +18464,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: model-invariant-id in: path - description: Unique id of site pair set. + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: routing-instance-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-VERSION-ID__ + - name: body + in: body + description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json) + required: true + schema: + $ref: "#/definitions/model-ver" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model-ver + description: | + Update an existing model-ver + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: path + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string + example: __MODEL-VERSION-ID__ - name: body in: body - description: site-pair object that needs to be created or updated + description: model-ver object that needs to be updated. required: true schema: - $ref: "#/definitions/site-pair" + $ref: "#/patchDefinitions/model-ver" delete: tags: - - Network - summary: delete an existing site-pair - description: delete an existing site-pair - operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + - ServiceDesignAndCreation + summary: delete an existing model-ver + description: delete an existing model-ver + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer consumes: - application/json - application/xml @@ -16638,33 +18543,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: site-pair-id + example: __MODEL-INVARIANT-ID__ + - name: model-version-id in: path - description: unique identifier of probe + description: Unique identifier corresponding to one version of a model in ASDC required: true type: string + example: __MODEL-VERSION-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs: + /service-design-and-creation/models/model/{model-invariant-id}/model-vers: get: tags: - - Network - summary: returns site-pairs - description: returns site-pairs - operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs + - ServiceDesignAndCreation + summary: returns model-vers + description: returns model-vers + operationId: getServiceDesignAndCreationModelsModelModelVers produces: - application/json - application/xml @@ -16672,26 +18574,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/site-pairs" + $ref: "#/getDefinitions/model-vers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: model-invariant-id in: path - description: Unique id of site pair set. + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: routing-instance-id - in: path - description: Unique id of routing instance - required: true + example: __MODEL-INVARIANT-ID__ + - name: model-version-id + in: query + description: + required: false type: string - /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: + - name: model-name + in: query + description: + required: false + type: string + - name: model-version + in: query + description: + required: false + type: string + /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: put: tags: - - Network + - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship consumes: - application/json - application/xml @@ -16702,28 +18615,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - Network + - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship + operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship consumes: - application/json - application/xml @@ -16734,23 +18643,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}: + example: __MODEL-INVARIANT-ID__ + /service-design-and-creation/models/model/{model-invariant-id}: get: tags: - - Network - summary: returns routing-instance - description: returns routing-instance - operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + - ServiceDesignAndCreation + summary: returns model + description: returns model + operationId: getServiceDesignAndCreationModelsModel produces: - application/json - application/xml @@ -16758,26 +18663,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/routing-instance" + $ref: "#/getDefinitions/model" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ put: tags: - - Network - summary: create or update an existing routing-instance - description: create or update an existing routing-instance - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + - ServiceDesignAndCreation + summary: create or update an existing model + description: | + Create or update an existing model. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationModelsModel consumes: - application/json - application/xml @@ -16788,28 +18692,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: model-invariant-id in: path - description: Unique id of site pair set. + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string - - name: routing-instance-id + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json) + required: true + schema: + $ref: "#/definitions/model" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing model + description: | + Update an existing model + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationModelsModel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ - name: body in: body - description: routing-instance object that needs to be created or updated + description: model object that needs to be updated. required: true schema: - $ref: "#/definitions/routing-instance" + $ref: "#/patchDefinitions/model" delete: tags: - - Network - summary: delete an existing routing-instance - description: delete an existing routing-instance - operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + - ServiceDesignAndCreation + summary: delete an existing model + description: delete an existing model + operationId: deleteServiceDesignAndCreationModelsModel consumes: - application/json - application/xml @@ -16820,28 +18759,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true - type: string - - name: routing-instance-id + - name: model-invariant-id in: path - description: Unique id of routing instance + description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances: + /service-design-and-creation/models: get: tags: - - Network - summary: returns routing-instances - description: returns routing-instances - operationId: getNetworkSitePairSetsSitePairSetRoutingInstances + - ServiceDesignAndCreation + summary: returns models + description: returns models + operationId: getServiceDesignAndCreationModels produces: - application/json - application/xml @@ -16849,21 +18784,26 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/routing-instances" + $ref: "#/getDefinitions/models" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id - in: path - description: Unique id of site pair set. - required: true + - name: model-invariant-id + in: query + description: + required: false type: string - /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: + - name: model-type + in: query + description: + required: false + type: string + /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: put: tags: - - Network + - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship consumes: - application/json - application/xml @@ -16874,23 +18814,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid in: path - description: Unique id of site pair set. required: true type: string + example: __RELATED-LOOKUP-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - Network + - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship consumes: - application/json - application/xml @@ -16901,40 +18851,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: named-query-uuid in: path - description: Unique id of site pair set. required: true type: string - /network/site-pair-sets/site-pair-set/{site-pair-set-id}: - get: - tags: - - Network - summary: returns site-pair-set - description: returns site-pair-set - operationId: getNetworkSitePairSetsSitePairSet - produces: - - application/json + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + /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}: + get: + tags: + - ServiceDesignAndCreation + summary: returns related-lookup + description: returns related-lookup + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup + produces: + - application/json - application/xml responses: "200": description: successful operation schema: - $ref: "#/definitions/site-pair-set" + $ref: "#/getDefinitions/related-lookup" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: Unique id of site pair set. required: true type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ put: tags: - - Network - summary: create or update an existing site-pair-set - description: create or update an existing site-pair-set - operationId: createOrUpdateNetworkSitePairSetsSitePairSet + - ServiceDesignAndCreation + summary: create or update an existing related-lookup + description: | + Create or update an existing related-lookup. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup consumes: - application/json - application/xml @@ -16945,23 +18918,44 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid in: path - description: Unique id of site pair set. required: true type: string + example: __RELATED-LOOKUP-UUID__ - name: body in: body - description: site-pair-set object that needs to be created or updated + description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) required: true schema: - $ref: "#/definitions/site-pair-set" - delete: + $ref: "#/definitions/related-lookup" + patch: tags: - - Network - summary: delete an existing site-pair-set - description: delete an existing site-pair-set - operationId: deleteNetworkSitePairSetsSitePairSet + - ServiceDesignAndCreation + summary: update an existing related-lookup + description: | + Update an existing related-lookup + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup consumes: - application/json - application/xml @@ -16972,39 +18966,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: site-pair-set-id + - name: named-query-uuid in: path - description: Unique id of site pair set. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path required: true type: string - /network/site-pair-sets: - get: - tags: - - Network - summary: returns site-pair-sets - description: returns site-pair-sets - operationId: getNetworkSitePairSets - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: path + required: true + type: string + example: __RELATED-LOOKUP-UUID__ + - name: body + in: body + description: related-lookup object that needs to be updated. + required: true schema: - $ref: "#/definitions/site-pair-sets" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: - put: + $ref: "#/patchDefinitions/related-lookup" + delete: tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship + - ServiceDesignAndCreation + summary: delete an existing related-lookup + description: delete an existing related-lookup + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup consumes: - application/json - application/xml @@ -17015,65 +19003,66 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: global-route-target + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: Number used to identify an RT, globally unique in the network required: true type: string - - name: route-target-role + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid in: path - description: Role assigned to this route target required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __RELATED-LOOKUP-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups: + get: tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship - consumes: - - application/json - - application/xml + - ServiceDesignAndCreation + summary: returns related-lookups + description: returns related-lookups + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/related-lookups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: global-route-target + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: Number used to identify an RT, globally unique in the network required: true type: string - - name: route-target-role - in: path - description: Role assigned to this route target - required: true + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: related-lookup-uuid + in: query + description: + required: false type: string - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + /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}: get: tags: - - Network - summary: returns route-target - description: returns route-target - operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + - ServiceDesignAndCreation + summary: returns property-constraint + description: returns property-constraint + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint produces: - application/json - application/xml @@ -17081,41 +19070,82 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/route-target" + $ref: "#/getDefinitions/property-constraint" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: global-route-target + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: Number used to identify an RT, globally unique in the network required: true type: string - - name: route-target-role + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid in: path - description: Role assigned to this route target required: true type: string - - name: vpn-name - in: query - description: VPN Name - required: false + example: __PROPERTY-CONSTRAINT-UUID__ + put: + tags: + - ServiceDesignAndCreation + summary: create or update an existing property-constraint + description: | + Create or update an existing property-constraint. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true type: string - put: + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid + in: path + required: true + type: string + example: __PROPERTY-CONSTRAINT-UUID__ + - name: body + in: body + description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json) + required: true + schema: + $ref: "#/definitions/property-constraint" + patch: tags: - - Network - summary: create or update an existing route-target - description: create or update an existing route-target - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + - ServiceDesignAndCreation + summary: update an existing property-constraint + description: | + Update an existing property-constraint + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint consumes: - application/json - application/xml @@ -17126,33 +19156,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: global-route-target + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: Number used to identify an RT, globally unique in the network required: true type: string - - name: route-target-role + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid in: path - description: Role assigned to this route target required: true type: string + example: __PROPERTY-CONSTRAINT-UUID__ - name: body in: body - description: route-target object that needs to be created or updated + description: property-constraint object that needs to be updated. required: true schema: - $ref: "#/definitions/route-target" + $ref: "#/patchDefinitions/property-constraint" delete: tags: - - Network - summary: delete an existing route-target - description: delete an existing route-target - operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget + - ServiceDesignAndCreation + summary: delete an existing property-constraint + description: delete an existing property-constraint + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint consumes: - application/json - application/xml @@ -17163,33 +19193,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: global-route-target + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: Number used to identify an RT, globally unique in the network required: true type: string - - name: route-target-role + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid in: path - description: Role assigned to this route target required: true type: string + example: __PROPERTY-CONSTRAINT-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets: + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints: get: tags: - - Network - summary: returns route-targets - description: returns route-targets - operationId: getNetworkVpnBindingsVpnBindingRouteTargets + - ServiceDesignAndCreation + summary: returns property-constraints + description: returns property-constraints + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints produces: - application/json - application/xml @@ -17197,31 +19227,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/route-targets" + $ref: "#/getDefinitions/property-constraints" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: vpn-name - in: query - description: VPN Name - required: false + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true type: string - - name: vpn-type + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: property-constraint-uuid in: query - description: Type of the vpn, should be taken from enumerated/valid values + description: required: false type: string - /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship: put: tags: - - Network + - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship consumes: - application/json - application/xml @@ -17232,23 +19262,28 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string + example: __NAMED-QUERY-ELEMENT-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - Network + - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship consumes: - application/json - application/xml @@ -17259,18 +19294,23 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - /network/vpn-bindings/vpn-binding/{vpn-id}: + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}: get: tags: - - Network - summary: returns vpn-binding - description: returns vpn-binding - operationId: getNetworkVpnBindingsVpnBinding + - ServiceDesignAndCreation + summary: returns named-query-element + description: returns named-query-element + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement produces: - application/json - application/xml @@ -17278,31 +19318,29 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpn-binding" + $ref: "#/getDefinitions/named-query-element" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string - - name: vpn-name - in: query - description: VPN Name - required: false - type: string - - name: vpn-type - in: query - description: Type of the vpn, should be taken from enumerated/valid values - required: false + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true type: string + example: __NAMED-QUERY-ELEMENT-UUID__ put: tags: - - Network - summary: create or update an existing vpn-binding - description: create or update an existing vpn-binding - operationId: createOrUpdateNetworkVpnBindingsVpnBinding + - ServiceDesignAndCreation + summary: create or update an existing named-query-element + description: | + Create or update an existing named-query-element. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement consumes: - application/json - application/xml @@ -17313,23 +19351,71 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ - name: body in: body - description: vpn-binding object that needs to be created or updated + description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) required: true schema: - $ref: "#/definitions/vpn-binding" + $ref: "#/definitions/named-query-element" + patch: + tags: + - ServiceDesignAndCreation + summary: update an existing named-query-element + description: | + Update an existing named-query-element + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-ELEMENT-UUID__ + - name: body + in: body + description: named-query-element object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query-element" delete: tags: - - Network - summary: delete an existing vpn-binding - description: delete an existing vpn-binding - operationId: deleteNetworkVpnBindingsVpnBinding + - ServiceDesignAndCreation + summary: delete an existing named-query-element + description: delete an existing named-query-element + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement consumes: - application/json - application/xml @@ -17340,23 +19426,28 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vpn-id + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid in: path - description: VPN ID, globally unique within A&AI required: true type: string + example: __NAMED-QUERY-ELEMENT-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpn-bindings: + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements: get: tags: - - Network - summary: returns vpn-bindings - description: returns vpn-bindings - operationId: getNetworkVpnBindings + - ServiceDesignAndCreation + summary: returns named-query-elements + description: returns named-query-elements + operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements produces: - application/json - application/xml @@ -17364,15 +19455,26 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpn-bindings" + $ref: "#/getDefinitions/named-query-elements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: + parameters: + - name: named-query-uuid + in: path + required: true + type: string + example: __NAMED-QUERY-UUID__ + - name: named-query-element-uuid + in: query + description: + required: false + type: string + /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: put: tags: - - Network + - ServiceDesignAndCreation summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship consumes: - application/json - application/xml @@ -17383,22 +19485,23 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: named-query-uuid in: path required: true type: string + example: __NAMED-QUERY-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json) required: true schema: $ref: "#/definitions/relationship" delete: tags: - - Network + - ServiceDesignAndCreation summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship consumes: - application/json - application/xml @@ -17409,47 +19512,43 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: named-query-uuid in: path required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: - put: + example: __NAMED-QUERY-UUID__ + /service-design-and-creation/named-queries/named-query/{named-query-uuid}: + get: tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml + - ServiceDesignAndCreation + summary: returns named-query + description: returns named-query + operationId: getServiceDesignAndCreationNamedQueriesNamedQuery produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/named-query" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: named-query-uuid in: path - description: Name that identifies the physical interface required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + example: __NAMED-QUERY-UUID__ + put: tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship + - ServiceDesignAndCreation + summary: create or update an existing named-query + description: | + Create or update an existing named-query. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery consumes: - application/json - application/xml @@ -17460,21 +19559,34 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: named-query-uuid in: path required: true type: string - - name: interface-name - in: path - description: Name that identifies the physical interface + example: __NAMED-QUERY-UUID__ + - name: body + in: body + description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json) required: true - type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: - put: + schema: + $ref: "#/definitions/named-query" + patch: tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + - ServiceDesignAndCreation + summary: update an existing named-query + description: | + Update an existing named-query + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery consumes: - application/json - application/xml @@ -17485,32 +19597,23 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: pf-pci-id + - name: named-query-uuid in: path - description: Identifier for the sriov-pf required: true type: string + example: __NAMED-QUERY-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: named-query object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/named-query" delete: tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + - ServiceDesignAndCreation + summary: delete an existing named-query + description: delete an existing named-query + operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery consumes: - application/json - application/xml @@ -17521,27 +19624,23 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: named-query-uuid in: path - description: Name that identifies the physical interface required: true type: string - - name: pf-pci-id - in: path - description: Identifier for the sriov-pf + example: __NAMED-QUERY-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + /service-design-and-creation/named-queries: get: tags: - - Network - summary: returns sriov-pf - description: returns sriov-pf - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + - ServiceDesignAndCreation + summary: returns named-queries + description: returns named-queries + operationId: getServiceDesignAndCreationNamedQueries produces: - application/json - application/xml @@ -17549,40 +19648,26 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-pf" + $ref: "#/getDefinitions/named-queries" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: pf-pci-id - in: path - description: Identifier for the sriov-pf - required: true - type: string - - name: prov-status + - name: named-query-uuid in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: prov-status + - name: named-query-name in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string + /network/logical-links/logical-link/{link-name}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing sriov-pf - description: create or update an existing sriov-pf - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship consumes: - application/json - application/xml @@ -17593,32 +19678,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: link-name in: path + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: pf-pci-id - in: path - description: Identifier for the sriov-pf - required: true - type: string - - name: body - in: body - description: sriov-pf object that needs to be created or updated + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json) required: true schema: - $ref: "#/definitions/sriov-pf" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing sriov-pf - description: delete an existing sriov-pf - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship consumes: - application/json - application/xml @@ -17629,32 +19706,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: pf-pci-id + - name: link-name in: path - description: Identifier for the sriov-pf - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + example: __LINK-NAME__ + /network/logical-links/logical-link/{link-name}: get: tags: - Network - summary: returns sriov-pfs - description: returns sriov-pfs - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs + summary: returns logical-link + description: returns logical-link + operationId: getNetworkLogicalLinksLogicalLink produces: - application/json - application/xml @@ -17662,35 +19726,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-pfs" + $ref: "#/getDefinitions/logical-link" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: link-name in: path - description: Name that identifies the physical interface + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - /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: + example: __LINK-NAME__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: create or update an existing logical-link + description: | + Create or update an existing logical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLogicalLinksLogicalLink consumes: - application/json - application/xml @@ -17701,72 +19755,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: link-name in: path - description: String that identifies the interface + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string + example: __LINK-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json) required: true schema: - $ref: "#/definitions/relationship" - delete: - tags: - - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - /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: - put: + $ref: "#/definitions/logical-link" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: update an existing logical-link + description: | + Update an existing logical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLogicalLinksLogicalLink consumes: - application/json - application/xml @@ -17777,42 +19794,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address + - name: link-name in: path - description: IP address + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string + example: __LINK-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: logical-link object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/logical-link" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: delete an existing logical-link + description: delete an existing logical-link + operationId: deleteNetworkLogicalLinksLogicalLink consumes: - application/json - application/xml @@ -17823,37 +19822,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: link-name in: path - description: String that identifies the interface + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /network/logical-links: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns logical-links + description: returns logical-links + operationId: getNetworkLogicalLinks produces: - application/json - application/xml @@ -17861,92 +19847,61 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/logical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: prov-status + - name: link-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: prov-status + - name: model-invariant-id in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: model-version-id in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: widget-model-id in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: widget-model-version in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key + - name: prov-status in: query - description: This indicates the customers VPN ID associated with this vlan + description: required: false type: string - - name: vlan-id-inner + - name: link-id in: query - description: Inner VLAN tag + description: required: false - type: integer - format: int64 - - name: neutron-network-id + type: string + - name: circuit-id in: query - description: Neutron network id of the interface that address belongs to + description: required: false type: string - - name: neutron-subnet-id + - name: purpose in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /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: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship consumes: - application/json - application/xml @@ -17957,42 +19912,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name that identifies the physical interface + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name given to the interface + description: Unique id of routing instance required: true type: string - - name: vlan-interface + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: String that identifies the interface + description: unique identifier of probe required: true type: string - - name: l3-interface-ipv4-address + example: __SITE-PAIR-ID__ + - name: cos in: path - description: IP address + description: unique identifier of probe required: true type: string + example: __COS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship consumes: - application/json - application/xml @@ -18003,41 +19958,81 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: site-pair-set-id in: path + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name that identifies the physical interface + description: Unique id of routing instance required: true type: string - - name: interface-name + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: Name given to the interface + description: unique identifier of probe required: true type: string - - name: vlan-interface + example: __SITE-PAIR-ID__ + - name: cos in: path - description: String that identifies the interface + description: unique identifier of probe required: true type: string - - name: l3-interface-ipv4-address + example: __COS__ + /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}: + get: + tags: + - Network + summary: returns class-of-service + description: returns class-of-service + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/class-of-service" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id in: path - description: IP address + description: Unique id of site pair set. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance required: true type: string - /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: + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe + required: true + type: string + example: __COS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: create or update an existing class-of-service + description: | + Create or update an existing class-of-service. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService consumes: - application/json - application/xml @@ -18048,42 +20043,99 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: site-pair-set-id in: path + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name that identifies the physical interface + description: Unique id of routing instance required: true type: string - - name: interface-name + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: Name given to the interface + description: unique identifier of probe required: true type: string - - name: vlan-interface + example: __SITE-PAIR-ID__ + - name: cos in: path - description: String that identifies the interface + description: unique identifier of probe required: true type: string - - name: l3-interface-ipv6-address + example: __COS__ + - name: body + in: body + description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) + required: true + schema: + $ref: "#/definitions/class-of-service" + patch: + tags: + - Network + summary: update an existing class-of-service + description: | + Update an existing class-of-service + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id in: path - description: IP address + description: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true + type: string + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true + type: string + example: __SITE-PAIR-ID__ + - name: cos + in: path + description: unique identifier of probe required: true type: string + example: __COS__ - name: body in: body - description: relationship object that needs to be created or updated + description: class-of-service object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/class-of-service" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing class-of-service + description: delete an existing class-of-service + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService consumes: - application/json - application/xml @@ -18094,37 +20146,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: site-pair-set-id in: path + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name that identifies the physical interface + description: Unique id of routing instance required: true type: string - - name: interface-name + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: Name given to the interface + description: unique identifier of probe required: true type: string - - name: vlan-interface + example: __SITE-PAIR-ID__ + - name: cos in: path - description: String that identifies the interface + description: unique identifier of probe required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + example: __COS__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /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: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns classes-of-service + description: returns classes-of-service + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService produces: - application/json - application/xml @@ -18132,92 +20189,39 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/classes-of-service" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: vlan-interface + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: String that identifies the interface + description: Unique id of routing instance required: true type: string - - name: l3-interface-ipv6-address + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: IP address + description: unique identifier of probe required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id + example: __SITE-PAIR-ID__ + - name: cos in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /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: put: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship consumes: - application/json - application/xml @@ -18228,42 +20232,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: vlan-interface + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: String that identifies the interface + description: Unique id of routing instance required: true type: string - - name: l3-interface-ipv6-address + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: IP address + description: unique identifier of probe required: true type: string + example: __SITE-PAIR-ID__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship consumes: - application/json - application/xml @@ -18274,42 +20272,31 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: site-pair-set-id in: path + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name that identifies the physical interface + description: Unique id of routing instance required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: unique identifier of probe required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + example: __SITE-PAIR-ID__ + /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}: get: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: returns site-pair + description: returns site-pair + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair produces: - application/json - application/xml @@ -18317,71 +20304,88 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/site-pair" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: site-pair-set-id in: path + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name that identifies the physical interface + description: Unique id of routing instance required: true type: string - - name: interface-name + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: Name given to the interface + description: unique identifier of probe required: true type: string - - name: vlan-interface + example: __SITE-PAIR-ID__ + put: + tags: + - Network + summary: create or update an existing site-pair + description: | + Create or update an existing site-pair. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id in: path - description: String that identifies the interface + description: Unique id of site pair set. required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id + in: path + description: Unique id of routing instance + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id + in: path + description: unique identifier of probe + required: true type: string - put: + example: __SITE-PAIR-ID__ + - name: body + in: body + description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) + required: true + schema: + $ref: "#/definitions/site-pair" + patch: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: update an existing site-pair + description: | + Update an existing site-pair + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair consumes: - application/json - application/xml @@ -18392,37 +20396,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name that identifies the physical interface + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name given to the interface + description: Unique id of routing instance required: true type: string - - name: vlan-interface + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: String that identifies the interface + description: unique identifier of probe required: true type: string + example: __SITE-PAIR-ID__ - name: body in: body - description: vlan object that needs to be created or updated + description: site-pair object that needs to be updated. required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/patchDefinitions/site-pair" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing site-pair + description: delete an existing site-pair + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair consumes: - application/json - application/xml @@ -18433,37 +20436,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name that identifies the physical interface + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name given to the interface + description: Unique id of routing instance required: true type: string - - name: vlan-interface + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: path - description: String that identifies the interface + description: unique identifier of probe required: true type: string + example: __SITE-PAIR-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans + summary: returns site-pairs + description: returns site-pairs + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs produces: - application/json - application/xml @@ -18471,55 +20473,33 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/site-pairs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name that identifies the physical interface + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name given to the interface + description: Unique id of routing instance required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + example: __ROUTING-INSTANCE-ID__ + - name: site-pair-id in: query - description: Name of the network + description: required: false type: string - /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: + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship consumes: - application/json - application/xml @@ -18530,28 +20510,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: pci-id + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of routing instance required: true type: string + example: __ROUTING-INSTANCE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) required: true schema: $ref: "#/definitions/relationship" @@ -18560,7 +20533,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship consumes: - application/json - application/xml @@ -18571,32 +20544,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: pci-id + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of routing instance required: true type: string - /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}: + example: __ROUTING-INSTANCE-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}: get: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: returns routing-instance + description: returns routing-instance + operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance produces: - application/json - application/xml @@ -18604,80 +20570,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/routing-instance" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: pci-id + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of routing instance required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string + example: __ROUTING-INSTANCE-ID__ put: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: create or update an existing routing-instance + description: | + Create or update an existing routing-instance. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance consumes: - application/json - application/xml @@ -18688,37 +20605,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: site-pair-set-id in: path + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: Name that identifies the physical interface + description: Unique id of routing instance required: true type: string - - name: interface-name + example: __ROUTING-INSTANCE-ID__ + - name: body + in: body + description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) + required: true + schema: + $ref: "#/definitions/routing-instance" + patch: + tags: + - Network + summary: update an existing routing-instance + description: | + Update an existing routing-instance + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: pci-id + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of routing instance required: true type: string + example: __ROUTING-INSTANCE-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: routing-instance object that needs to be updated. required: true schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/patchDefinitions/routing-instance" delete: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing routing-instance + description: delete an existing routing-instance + operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance consumes: - application/json - application/xml @@ -18729,37 +20684,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: pci-id + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of routing instance required: true type: string + example: __ROUTING-INSTANCE-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + summary: returns routing-instances + description: returns routing-instances + operationId: getNetworkSitePairSetsSitePairSetRoutingInstances produces: - application/json - application/xml @@ -18767,55 +20715,27 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/routing-instances" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + example: __SITE-PAIR-SET-ID__ + - name: routing-instance-id in: query - description: Name of the network + description: required: false type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship consumes: - application/json - application/xml @@ -18826,23 +20746,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json) required: true schema: $ref: "#/definitions/relationship" @@ -18851,7 +20763,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship consumes: - application/json - application/xml @@ -18862,26 +20774,45 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name that identifies the physical interface + description: Unique id of site pair set. required: true type: string - - name: interface-name + example: __SITE-PAIR-SET-ID__ + /network/site-pair-sets/site-pair-set/{site-pair-set-id}: + get: + tags: + - Network + summary: returns site-pair-set + description: returns site-pair-set + operationId: getNetworkSitePairSetsSitePairSet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/site-pair-set" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - /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: + example: __SITE-PAIR-SET-ID__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: create or update an existing site-pair-set + description: | + Create or update an existing site-pair-set. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkSitePairSetsSitePairSet consumes: - application/json - application/xml @@ -18892,37 +20823,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name that identifies the physical interface + description: Unique id of site pair set. required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json) required: true - type: string - - name: l3-interface-ipv4-address + schema: + $ref: "#/definitions/site-pair-set" + patch: + tags: + - Network + summary: update an existing site-pair-set + description: | + Update an existing site-pair-set + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkSitePairSetsSitePairSet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: site-pair-set-id in: path - description: IP address + description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: site-pair-set object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/site-pair-set" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: delete an existing site-pair-set + description: delete an existing site-pair-set + operationId: deleteNetworkSitePairSetsSitePairSet consumes: - application/json - application/xml @@ -18933,32 +20890,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: site-pair-set-id in: path - description: Name given to the interface + description: Unique id of site pair set. required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address + example: __SITE-PAIR-SET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /network/site-pair-sets: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: returns site-pair-sets + description: returns site-pair-sets + operationId: getNetworkSitePairSets produces: - application/json - application/xml @@ -18966,76 +20915,21 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + - name: site-pair-set-id + in: query + description: + required: false type: string + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship consumes: - application/json - application/xml @@ -19046,37 +20940,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name + example: __VPN-ID__ + - name: global-route-target in: path - description: Name given to the interface + description: Number used to identify an RT, globally unique in the network required: true type: string - - name: l3-interface-ipv4-address + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role in: path - description: IP address + description: Role assigned to this route target required: true type: string + example: __ROUTE-TARGET-ROLE__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship consumes: - application/json - application/xml @@ -19087,77 +20980,69 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name + example: __VPN-ID__ + - name: global-route-target in: path - description: Name given to the interface + description: Number used to identify an RT, globally unique in the network required: true type: string - - name: l3-interface-ipv4-address + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Role assigned to this route target required: true type: string - /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: - put: + example: __ROUTE-TARGET-ROLE__ + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns route-target + description: returns route-target + operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-target" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name + example: __VPN-ID__ + - name: global-route-target in: path - description: Name given to the interface + description: Number used to identify an RT, globally unique in the network required: true type: string - - name: l3-interface-ipv6-address + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role in: path - description: IP address + description: Role assigned to this route target required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + example: __ROUTE-TARGET-ROLE__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: create or update an existing route-target + description: | + Create or update an existing route-target. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget consumes: - application/json - application/xml @@ -19168,109 +21053,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: vpn-id in: path + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name + example: __VPN-ID__ + - name: global-route-target in: path - description: Name that identifies the physical interface + description: Number used to identify an RT, globally unique in the network required: true type: string - - name: interface-name + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role in: path - description: Name given to the interface + description: Role assigned to this route target required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + example: __ROUTE-TARGET-ROLE__ + - name: body + in: body + description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) required: true - type: string - /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}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: + $ref: "#/definitions/route-target" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: update an existing route-target + description: | + Update an existing route-target + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget consumes: - application/json - application/xml @@ -19281,37 +21104,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name + example: __VPN-ID__ + - name: global-route-target in: path - description: Name given to the interface + description: Number used to identify an RT, globally unique in the network required: true type: string - - name: l3-interface-ipv6-address + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role in: path - description: IP address + description: Role assigned to this route target required: true type: string + example: __ROUTE-TARGET-ROLE__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: route-target object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/route-target" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing route-target + description: delete an existing route-target + operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget consumes: - application/json - application/xml @@ -19322,37 +21144,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name + example: __VPN-ID__ + - name: global-route-target in: path - description: Name given to the interface + description: Number used to identify an RT, globally unique in the network required: true type: string - - name: l3-interface-ipv6-address + example: __GLOBAL-ROUTE-TARGET__ + - name: route-target-role in: path - description: IP address + description: Role assigned to this route target required: true type: string + example: __ROUTE-TARGET-ROLE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets: get: tags: - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + summary: returns route-targets + description: returns route-targets + operationId: getNetworkVpnBindingsVpnBindingRouteTargets produces: - application/json - application/xml @@ -19360,55 +21181,22 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/route-targets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name given to the interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string + example: __VPN-ID__ + /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship consumes: - application/json - application/xml @@ -19419,32 +21207,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name given to the interface + description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-ID__ - name: body in: body - description: l-interface object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json) required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship consumes: - application/json - application/xml @@ -19455,32 +21235,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name given to the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: VPN ID, globally unique within A&AI required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: + example: __VPN-ID__ + /network/vpn-bindings/vpn-binding/{vpn-id}: get: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces + summary: returns vpn-binding + description: returns vpn-binding + operationId: getNetworkVpnBindingsVpnBinding produces: - application/json - application/xml @@ -19488,72 +21255,64 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/vpn-binding" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: - get: + example: __VPN-ID__ + put: tags: - Network - summary: returns p-interface - description: returns p-interface - operationId: getNetworkVplsPesVplsPePInterfacesPInterface + summary: create or update an existing vpn-binding + description: | + Create or update an existing vpn-binding. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVpnBindingsVpnBinding + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name + - name: vpn-id in: path + description: VPN ID, globally unique within A&AI required: true type: string - - name: interface-name - in: path - description: Name that identifies the physical interface + example: __VPN-ID__ + - name: body + in: body + description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json) required: true - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - put: + schema: + $ref: "#/definitions/vpn-binding" + patch: tags: - Network - summary: create or update an existing p-interface - description: create or update an existing p-interface - operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface + summary: update an existing vpn-binding + description: | + Update an existing vpn-binding + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVpnBindingsVpnBinding consumes: - application/json - application/xml @@ -19564,27 +21323,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-ID__ - name: body in: body - description: p-interface object that needs to be created or updated + description: vpn-binding object that needs to be updated. required: true schema: - $ref: "#/definitions/p-interface" + $ref: "#/patchDefinitions/vpn-binding" delete: tags: - Network - summary: delete an existing p-interface - description: delete an existing p-interface - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface + summary: delete an existing vpn-binding + description: delete an existing vpn-binding + operationId: deleteNetworkVpnBindingsVpnBinding consumes: - application/json - application/xml @@ -19595,27 +21351,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true - type: string - - name: interface-name + - name: vpn-id in: path - description: Name that identifies the physical interface + description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces: + /network/vpn-bindings: get: tags: - Network - summary: returns p-interfaces - description: returns p-interfaces - operationId: getNetworkVplsPesVplsPePInterfaces + summary: returns vpn-bindings + description: returns vpn-bindings + operationId: getNetworkVpnBindings produces: - application/json - application/xml @@ -19623,25 +21376,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interfaces" + $ref: "#/getDefinitions/vpn-bindings" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: equipment-name - in: path - required: true + - name: vpn-id + in: query + description: + required: false type: string - - name: prov-status + - name: vpn-name in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + - name: vpn-type + in: query + description: + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship consumes: - application/json - application/xml @@ -19656,14 +21415,10 @@ paths: in: path required: true type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string + example: __EQUIPMENT-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json) required: true schema: $ref: "#/definitions/relationship" @@ -19672,7 +21427,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship consumes: - application/json - application/xml @@ -19687,17 +21442,13 @@ paths: in: path required: true type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - /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: + example: __EQUIPMENT-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -19712,24 +21463,16 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -19738,7 +21481,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -19753,27 +21496,19 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface + description: Name that identifies the physical interface required: true type: string - /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: + example: __INTERFACE-NAME__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship consumes: - application/json - application/xml @@ -19788,29 +21523,22 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface + description: Name that identifies the physical interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: IP address + description: Identifier for the sriov-pf required: true type: string + example: __PF-PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) required: true schema: $ref: "#/definitions/relationship" @@ -19819,7 +21547,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship consumes: - application/json - application/xml @@ -19834,33 +21562,26 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface + description: Name that identifies the physical interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: IP address + description: Identifier for the sriov-pf required: true type: string - /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}: + example: __PF-PCI-ID__ + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns sriov-pf + description: returns sriov-pf + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf produces: - application/json - application/xml @@ -19868,7 +21589,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/sriov-pf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -19876,89 +21597,189 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + put: + tags: + - Network + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the physical interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: String that identifies the interface + description: Identifier for the sriov-pf required: true type: string - - name: l3-interface-ipv4-address + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - Network + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name in: path - description: IP address required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-pf" + delete: + tags: + - Network + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string - - name: network-name + example: __PF-PCI-ID__ + - name: resource-version in: query - description: Name of the network - required: false + description: resource-version for concurrency + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + get: + tags: + - Network + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: neutron-subnet-id + example: __INTERFACE-NAME__ + - name: pf-pci-id in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /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: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -19973,38 +21794,37 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -20019,37 +21839,31 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /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: + example: __VLAN-INTERFACE__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -20064,29 +21878,34 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -20095,7 +21914,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -20110,33 +21929,38 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -20144,7 +21968,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20152,89 +21976,40 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -20249,38 +22024,54 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -20295,46 +22086,50 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. required: true - type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: - get: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20342,68 +22137,42 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + description: resource-version for concurrency + required: true type: string + /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: put: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -20418,33 +22187,43 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: vlan object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -20459,33 +22238,38 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -20493,7 +22277,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20501,52 +22285,102 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - /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: - put: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -20561,33 +22395,43 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -20602,28 +22446,43 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - /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}: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: returns vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -20631,7 +22490,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20639,77 +22498,90 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -20724,33 +22596,37 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: vlan object that needs to be updated. required: true schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/patchDefinitions/vlan" delete: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -20765,33 +22641,37 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + summary: returns vlans + description: returns vlans + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -20799,7 +22679,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20807,52 +22687,41 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -20867,19 +22736,28 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -20888,7 +22766,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -20903,22 +22781,75 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - /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: + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /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}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -20933,33 +22864,48 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/sriov-vf" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -20974,36 +22920,44 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string - /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}: - get: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21011,73 +22965,96 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: IP address + description: PCI ID used to identify the sriov-vf required: true type: string - - name: prov-status + example: __PCI-ID__ + - name: resource-version in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + description: resource-version for concurrency + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: interface-id + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-filter in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vf-mac-filter in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner + - name: vf-vlan-strip in: query - description: Inner VLAN tag + description: required: false - type: integer - format: int64 + type: boolean - name: neutron-network-id in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -21092,33 +23069,31 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -21133,32 +23108,25 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /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: + example: __INTERFACE-NAME__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -21173,24 +23141,28 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -21199,7 +23171,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -21214,28 +23186,32 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -21243,7 +23219,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21251,73 +23227,34 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -21332,33 +23269,48 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -21373,41 +23325,44 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. required: true - type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: - get: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21415,52 +23370,36 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: network-name + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: Name of the network - required: false + description: resource-version for concurrency + required: true type: string + /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: put: tags: - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -21475,28 +23414,37 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l-interface object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -21511,28 +23459,32 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -21540,7 +23492,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21548,41 +23500,41 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: - get: + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: tags: - Network - summary: returns lag-interface - description: returns lag-interface - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface - produces: - - application/json + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21590,32 +23542,48 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing lag-interface - description: create or update an existing lag-interface - operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -21630,23 +23598,37 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: lag-interface object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/lag-interface" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing lag-interface - description: delete an existing lag-interface - operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -21661,23 +23643,37 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces: + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network - summary: returns lag-interfaces - description: returns lag-interfaces - operationId: getNetworkVplsPesVplsPeLagInterfaces + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface produces: - application/json - application/xml @@ -21685,7 +23681,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21693,26 +23689,35 @@ paths: in: path required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - /network/vpls-pes/vpls-pe/{equipment-name}: - get: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + put: tags: - Network - summary: returns vpls-pe - description: returns vpls-pe - operationId: getNetworkVplsPesVplsPe + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vpls-pe" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21720,17 +23725,42 @@ paths: in: path required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - put: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: tags: - Network - summary: create or update an existing vpls-pe - description: create or update an existing vpls-pe - operationId: createOrUpdateNetworkVplsPesVplsPe + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -21745,18 +23775,31 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: vpls-pe object that needs to be created or updated + description: l-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/vpls-pe" + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network - summary: delete an existing vpls-pe - description: delete an existing vpls-pe - operationId: deleteNetworkVplsPesVplsPe + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -21771,18 +23814,31 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vpls-pes: + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: get: tags: - Network - summary: returns vpls-pes - description: returns vpls-pes - operationId: getNetworkVplsPes + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces produces: - application/json - application/xml @@ -21790,42 +23846,79 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpls-pes" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: - put: + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns p-interface + description: returns p-interface + operationId: getNetworkVplsPesVplsPePInterfacesPInterface produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: multicast-configuration-id + - name: equipment-name in: path - description: Unique id of multicast configuration. required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __INTERFACE-NAME__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface consumes: - application/json - application/xml @@ -21836,40 +23929,40 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: multicast-configuration-id + - name: equipment-name in: path - description: Unique id of multicast configuration. required: true type: string - /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}: - get: - tags: - - Network - summary: returns multicast-configuration - description: returns multicast-configuration - operationId: getNetworkMulticastConfigurationsMulticastConfiguration - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/multicast-configuration" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: multicast-configuration-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique id of multicast configuration. + description: Name that identifies the physical interface required: true type: string - put: + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: tags: - Network - summary: create or update an existing multicast-configuration - description: create or update an existing multicast-configuration - operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface consumes: - application/json - application/xml @@ -21880,23 +23973,29 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: multicast-configuration-id + - name: equipment-name in: path - description: Unique id of multicast configuration. required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: multicast-configuration object that needs to be created or updated + description: p-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/multicast-configuration" + $ref: "#/patchDefinitions/p-interface" delete: tags: - Network - summary: delete an existing multicast-configuration - description: delete an existing multicast-configuration - operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface consumes: - application/json - application/xml @@ -21907,23 +24006,29 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: multicast-configuration-id + - name: equipment-name in: path - description: Unique id of multicast configuration. required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/multicast-configurations: + /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces: get: tags: - Network - summary: returns multicast-configurations - description: returns multicast-configurations - operationId: getNetworkMulticastConfigurations + summary: returns p-interfaces + description: returns p-interfaces + operationId: getNetworkVplsPesVplsPePInterfaces produces: - application/json - application/xml @@ -21931,15 +24036,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/multicast-configurations" + $ref: "#/getDefinitions/p-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship: + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -21950,25 +24071,20 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: cvlan-tag - in: path - description: See mis-na-virtualization-platform.yang - required: true - type: integer - format: int64 + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -21977,7 +24093,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -21988,117 +24104,107 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: cvlan-tag - in: path - description: See mis-na-virtualization-platform.yang - required: true - type: integer - format: int64 - /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}: - get: + example: __INTERFACE-NAME__ + /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: + put: tags: - Network - summary: returns cvlan-tag-entry - description: returns cvlan-tag-entry - operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/cvlan-tag-entry" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: cvlan-tag + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: See mis-na-virtualization-platform.yang + description: Name given to the interface required: true - type: integer - format: int64 - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ + /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: put: tags: - Network - summary: create or update an existing cvlan-tag-entry - description: create or update an existing cvlan-tag-entry - operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -22109,34 +24215,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: cvlan-tag + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: See mis-na-virtualization-platform.yang + description: Name given to the interface required: true - type: integer - format: int64 + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: cvlan-tag-entry object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/cvlan-tag-entry" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing cvlan-tag-entry - description: delete an existing cvlan-tag-entry - operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -22147,34 +24266,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: cvlan-tag + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: See mis-na-virtualization-platform.yang + description: Name given to the interface required: true - type: integer - format: int64 - - name: resource-version - in: query - description: resource-version for concurrency + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true type: string - /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network - summary: returns cvlan-tags - description: returns cvlan-tags - operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -22182,81 +24309,48 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/cvlan-tags" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false - type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -22267,28 +24361,58 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -22299,105 +24423,97 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}: - get: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns port-group - description: returns port-group - operationId: getNetworkVcesVcePortGroupsPortGroup + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/port-group" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: port-group-id - in: query - description: Unique ID for port group in vmware - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: switch-name - in: query - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: heat-stack-id + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + description: resource-version for concurrency + required: true type: string + /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: put: tags: - Network - summary: create or update an existing port-group - description: create or update an existing port-group - operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -22408,28 +24524,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: port-group object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/port-group" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing port-group - description: delete an existing port-group - operationId: deleteNetworkVcesVcePortGroupsPortGroup + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -22440,28 +24575,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID of the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string - /network/vces/vce/{vnf-id}/port-groups: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns port-groups - description: returns port-groups - operationId: getNetworkVcesVcePortGroups + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -22469,61 +24618,110 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/port-groups" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vnf-type - in: query - 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. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: - put: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -22534,33 +24732,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of a license resource. + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -22571,28 +24783,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of a license resource. + description: Name given to the interface required: true type: string - /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network - summary: returns license - description: returns license - operationId: getNetworkVcesVceLicensesLicense + summary: returns vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -22600,71 +24831,42 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/license" + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of a license resource. + description: Name given to the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network - summary: create or update an existing license - description: create or update an existing license - operationId: createOrUpdateNetworkVcesVceLicensesLicense + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -22675,33 +24877,52 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of a license resource. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: license object that needs to be created or updated + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/license" - delete: + $ref: "#/definitions/vlan" + patch: tags: - Network - summary: delete an existing license - description: delete an existing license - operationId: deleteNetworkVcesVceLicensesLicense + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -22712,95 +24933,136 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of a license resource. + description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true type: string - /network/vces/vce/{vnf-id}/licenses: - get: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: tags: - Network - summary: returns licenses - description: returns licenses - operationId: getNetworkVcesVceLicenses + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/licenses" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vnf-type - in: query - 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. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: service-id + example: __VLAN-INTERFACE__ + - name: resource-version in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false + description: resource-version for concurrency + required: true type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: prov-status + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vlan-id-inner in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false - type: string - - name: vpe-id + type: integer + format: int64 + - name: vpn-key in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string - /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -22811,24 +25073,32 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of an entitlement resource. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -22837,7 +25107,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -22848,28 +25118,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of an entitlement resource. + description: Name given to the interface required: true type: string - /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /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}: get: tags: - Network - summary: returns entitlement - description: returns entitlement - operationId: getNetworkVcesVceEntitlementsEntitlement + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -22877,71 +25155,98 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlement" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of an entitlement resource. + description: Name given to the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false + example: __PCI-ID__ + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - put: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: tags: - Network - summary: create or update an existing entitlement - description: create or update an existing entitlement - operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -22952,33 +25257,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of an entitlement resource. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: entitlement object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/entitlement" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network - summary: delete an existing entitlement - description: delete an existing entitlement - operationId: deleteNetworkVcesVceEntitlementsEntitlement + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -22989,33 +25302,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name that identifies the link aggregate interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Unique ID of an entitlement resource. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/vces/vce/{vnf-id}/entitlements: + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network - summary: returns entitlements - description: returns entitlements - operationId: getNetworkVcesVceEntitlements + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -23023,61 +25344,58 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlements" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vnf-type - in: query - 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. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: service-id + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + description: required: false type: string - - name: regional-resource-zone + - name: vf-vlan-filter in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-mac-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-vlan-strip in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false - type: string - - name: vpe-id + type: boolean + - name: neutron-network-id in: query - description: Unique ID of VPE connected to this VCE. + description: required: false type: string - /network/vces/vce/{vnf-id}/relationship-list/relationship: + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -23088,14 +25406,26 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -23104,7 +25434,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkVcesVceRelationshipListRelationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -23115,80 +25445,29 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - /network/vces/vce/{vnf-id}: - get: - tags: - - Network - summary: returns vce - description: returns vce - operationId: getNetworkVcesVce - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vce" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: vnf-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Unique id of VNF. This is unique across the graph. + description: Name that identifies the link aggregate interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: vpe-id - in: query - description: Unique ID of VPE connected to this VCE. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string + example: __INTERFACE-NAME__ + /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: put: tags: - Network - summary: create or update an existing vce - description: create or update an existing vce - operationId: createOrUpdateNetworkVcesVce + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -23199,23 +25478,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: vce object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/vce" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vce - description: delete an existing vce - operationId: deleteNetworkVcesVce + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -23226,23 +25523,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: equipment-name in: path - description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string - /network/vces: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network - summary: returns vces - description: returns vces - operationId: getNetworkVces + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -23250,15 +25560,42 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vces" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: + parameters: + - name: equipment-name + in: path + required: true + type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -23269,23 +25606,52 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnfc-name + - name: equipment-name in: path - description: Unique ID of vnfc. required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -23296,83 +25662,85 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnfc-name + - name: equipment-name in: path - description: Unique ID of vnfc. required: true type: string - /network/vnfcs/vnfc/{vnfc-name}: - get: + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns vnfc - description: returns vnfc - operationId: getNetworkVnfcsVnfc + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vnfc" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnfc-name + - name: equipment-name in: path - description: Unique ID of vnfc. required: true type: string - - name: nfc-naming-code - in: query - description: Short code that is used in naming instances of the item being modeled - required: false - type: string - - name: nfc-function - in: query - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - required: false - type: string - - name: prov-status - in: query - description: prov status of this vnfc - required: false - type: string - - name: ipaddress-v4-oam-vip - in: query - description: Oam V4 vip address of this vnfc - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: group-notation - in: query - description: Group notation of VNFC - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: model-version-id + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: the ASDC model version for this resource or service model. - required: false + description: resource-version for concurrency + required: true type: string + /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: put: tags: - Network - summary: create or update an existing vnfc - description: create or update an existing vnfc - operationId: createOrUpdateNetworkVnfcsVnfc + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -23383,23 +25751,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnfc-name + - name: equipment-name in: path - description: Unique ID of vnfc. required: true type: string + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: vnfc object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/vnfc" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vnfc - description: delete an existing vnfc - operationId: deleteNetworkVnfcsVnfc + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -23410,23 +25796,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnfc-name + - name: equipment-name in: path - description: Unique ID of vnfc. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string - /network/vnfcs: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns vnfcs - description: returns vnfcs - operationId: getNetworkVnfcs + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -23434,47 +25833,42 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnfcs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: subnet-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Subnet ID, should be UUID. + description: Name that identifies the link aggregate interface required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -23485,100 +25879,52 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: subnet-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Subnet ID, should be UUID. + description: Name that identifies the link aggregate interface required: true type: string - /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}: - get: - tags: - - Network - summary: returns subnet - description: returns subnet - operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/subnet" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: network-id + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Network ID, should be uuid. Unique across A&AI. + description: Name given to the interface required: true type: string - - name: subnet-id + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Subnet ID, should be UUID. + description: IP address required: true type: string - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: subnet-name - in: query - description: Name associated with the subnet. - required: false - type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing subnet - description: create or update an existing subnet - operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -23589,28 +25935,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: subnet-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Subnet ID, should be UUID. + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: subnet object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/subnet" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing subnet - description: delete an existing subnet - operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -23621,28 +25980,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: subnet-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: Subnet ID, should be UUID. + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/l3-networks/l3-network/{network-id}/subnets: + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network - summary: returns subnets - description: returns subnets - operationId: getNetworkL3NetworksL3NetworkSubnets + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface produces: - application/json - application/xml @@ -23650,66 +26022,86 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/subnets" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false + example: __INTERFACE-NAME__ + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: - put: + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -23720,29 +26112,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: id. + description: Name that identifies the link aggregate interface required: true - type: integer - format: int64 + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: l-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -23753,24 +26151,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: id. + description: Name that identifies the link aggregate interface required: true - type: integer - format: int64 - /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}: + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - Network - summary: returns ctag-assignment - description: returns ctag-assignment - operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces produces: - application/json - application/xml @@ -23778,72 +26187,79 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ctag-assignment" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: id. + description: Name that identifies the link aggregate interface required: true - type: integer - format: int64 - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false type: string - - name: heat-stack-id + example: __INTERFACE-NAME__ + - name: interface-name in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: contrail-network-fqdn + - name: interface-id in: query - description: Contrail FQDN for the network + description: required: false type: string - - name: model-invariant-id + - name: macaddr in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - - name: model-version-id + - name: network-name in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string + example: __INTERFACE-NAME__ put: tags: - Network - summary: create or update an existing ctag-assignment - description: create or update an existing ctag-assignment - operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface consumes: - application/json - application/xml @@ -23854,29 +26270,40 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: id. + description: Name that identifies the link aggregate interface required: true - type: integer - format: int64 + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: ctag-assignment object that needs to be created or updated + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) required: true schema: - $ref: "#/definitions/ctag-assignment" - delete: + $ref: "#/definitions/lag-interface" + patch: tags: - Network - summary: delete an existing ctag-assignment - description: delete an existing ctag-assignment - operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface consumes: - application/json - application/xml @@ -23887,128 +26314,125 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner + example: __EQUIPMENT-NAME__ + - name: interface-name in: path - description: id. - required: true - type: integer - format: int64 - - name: resource-version - in: query - description: resource-version for concurrency + description: Name that identifies the link aggregate interface required: true type: string - /network/l3-networks/l3-network/{network-id}/ctag-assignments: - get: + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: tags: - Network - summary: returns ctag-assignments - description: returns ctag-assignments - operationId: getNetworkL3NetworksL3NetworkCtagAssignments + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/ctag-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __EQUIPMENT-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: contrail-network-fqdn + example: __INTERFACE-NAME__ + - name: resource-version in: query - description: Contrail FQDN for the network - required: false + description: resource-version for concurrency + required: true type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false + /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkVplsPesVplsPeLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: equipment-name + in: path + required: true type: string - - name: model-version-id + example: __EQUIPMENT-NAME__ + - name: interface-name in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - - name: widget-model-id + - name: interface-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: interface-role in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship: - put: + /network/vpls-pes/vpls-pe/{equipment-name}: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns vpls-pe + description: returns vpls-pe + operationId: getNetworkVplsPesVplsPe produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vpls-pe" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id - in: path - description: Network ID, should be uuid. Unique across A&AI. - required: true - type: string - - name: segmentation-id + - name: equipment-name in: path - description: Route Table Reference id, UUID assigned to this instance. required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + example: __EQUIPMENT-NAME__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship + summary: create or update an existing vpls-pe + description: | + Create or update an existing vpls-pe. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVplsPesVplsPe consumes: - application/json - application/xml @@ -24019,95 +26443,34 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: equipment-name in: path - description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: segmentation-id - in: path - description: Route Table Reference id, UUID assigned to this instance. + example: __EQUIPMENT-NAME__ + - name: body + in: body + description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json) required: true - type: string - /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}: - get: - tags: - - Network - summary: returns segmentation-assignment - description: returns segmentation-assignment - operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation schema: - $ref: "#/definitions/segmentation-assignment" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: network-id - in: path - description: Network ID, should be uuid. Unique across A&AI. - required: true - type: string - - name: segmentation-id - in: path - description: Route Table Reference id, UUID assigned to this instance. - required: true - type: string - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - put: + $ref: "#/definitions/vpls-pe" + patch: tags: - Network - summary: create or update an existing segmentation-assignment - description: create or update an existing segmentation-assignment - operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + summary: update an existing vpls-pe + description: | + Update an existing vpls-pe + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVplsPesVplsPe consumes: - application/json - application/xml @@ -24118,28 +26481,23 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id - in: path - description: Network ID, should be uuid. Unique across A&AI. - required: true - type: string - - name: segmentation-id + - name: equipment-name in: path - description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __EQUIPMENT-NAME__ - name: body in: body - description: segmentation-assignment object that needs to be created or updated + description: vpls-pe object that needs to be updated. required: true schema: - $ref: "#/definitions/segmentation-assignment" + $ref: "#/patchDefinitions/vpls-pe" delete: tags: - Network - summary: delete an existing segmentation-assignment - description: delete an existing segmentation-assignment - operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + summary: delete an existing vpls-pe + description: delete an existing vpls-pe + operationId: deleteNetworkVplsPesVplsPe consumes: - application/json - application/xml @@ -24150,28 +26508,23 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id - in: path - description: Network ID, should be uuid. Unique across A&AI. - required: true - type: string - - name: segmentation-id + - name: equipment-name in: path - description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __EQUIPMENT-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/l3-networks/l3-network/{network-id}/segmentation-assignments: + /network/vpls-pes: get: tags: - Network - summary: returns segmentation-assignments - description: returns segmentation-assignments - operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments + summary: returns vpls-pes + description: returns vpls-pes + operationId: getNetworkVplsPes produces: - application/json - application/xml @@ -24179,66 +26532,26 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/segmentation-assignments" + $ref: "#/getDefinitions/vpls-pes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id - in: path - description: Network ID, should be uuid. Unique across A&AI. - required: true - type: string - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id + - name: equipment-name in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - - name: widget-model-version + - name: prov-status in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: + /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship + operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship consumes: - application/json - application/xml @@ -24249,14 +26562,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: multicast-configuration-id in: path - description: Network ID, should be uuid. Unique across A&AI. + description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json) required: true schema: $ref: "#/definitions/relationship" @@ -24265,7 +26579,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship + operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship consumes: - application/json - application/xml @@ -24276,18 +26590,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: multicast-configuration-id in: path - description: Network ID, should be uuid. Unique across A&AI. + description: Unique id of multicast configuration. required: true type: string - /network/l3-networks/l3-network/{network-id}: + example: __MULTICAST-CONFIGURATION-ID__ + /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}: get: tags: - Network - summary: returns l3-network - description: returns l3-network - operationId: getNetworkL3NetworksL3Network + summary: returns multicast-configuration + description: returns multicast-configuration + operationId: getNetworkMulticastConfigurationsMulticastConfiguration produces: - application/json - application/xml @@ -24295,66 +26610,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-network" + $ref: "#/getDefinitions/multicast-configuration" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: multicast-configuration-id in: path - description: Network ID, should be uuid. Unique across A&AI. + description: Unique id of multicast configuration. required: true type: string - - name: network-name - in: query - description: Name of the network, governed by some naming convention.. - required: false - type: string - - name: network-role - in: query - description: Role the network plans - who defines these values? - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: contrail-network-fqdn - in: query - description: Contrail FQDN for the network - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string + example: __MULTICAST-CONFIGURATION-ID__ put: tags: - Network - summary: create or update an existing l3-network - description: create or update an existing l3-network - operationId: createOrUpdateNetworkL3NetworksL3Network + summary: create or update an existing multicast-configuration + description: | + Create or update an existing multicast-configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration consumes: - application/json - application/xml @@ -24365,66 +26639,35 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-id + - name: multicast-configuration-id in: path - description: Network ID, should be uuid. Unique across A&AI. + description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ - name: body in: body - description: l3-network object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-network" - delete: - tags: - - Network - summary: delete an existing l3-network - description: delete an existing l3-network - operationId: deleteNetworkL3NetworksL3Network - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: network-id - in: path - description: Network ID, should be uuid. Unique across A&AI. + description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json) required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/l3-networks: - get: - tags: - - Network - summary: returns l3-networks - description: returns l3-networks - operationId: getNetworkL3Networks - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation schema: - $ref: "#/definitions/l3-networks" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: - put: + $ref: "#/definitions/multicast-configuration" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship + summary: update an existing multicast-configuration + description: | + Update an existing multicast-configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration consumes: - application/json - application/xml @@ -24435,23 +26678,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-policy-id + - name: multicast-configuration-id in: path - description: UUID representing unique key to this instance + description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: multicast-configuration object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/multicast-configuration" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship + summary: delete an existing multicast-configuration + description: delete an existing multicast-configuration + operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration consumes: - application/json - application/xml @@ -24462,18 +26706,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-policy-id + - name: multicast-configuration-id in: path - description: UUID representing unique key to this instance + description: Unique id of multicast configuration. required: true type: string - /network/network-policies/network-policy/{network-policy-id}: + example: __MULTICAST-CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/multicast-configurations: get: tags: - Network - summary: returns network-policy - description: returns network-policy - operationId: getNetworkNetworkPoliciesNetworkPolicy + summary: returns multicast-configurations + description: returns multicast-configurations + operationId: getNetworkMulticastConfigurations produces: - application/json - application/xml @@ -24481,26 +26731,21 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-policy" + $ref: "#/getDefinitions/multicast-configurations" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-policy-id - in: path - description: UUID representing unique key to this instance - required: true - type: string - - name: network-policy-fqdn + - name: multicast-configuration-id in: query - description: Contrail FQDN for the policy + description: required: false type: string + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing network-policy - description: create or update an existing network-policy - operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship consumes: - application/json - application/xml @@ -24511,23 +26756,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-policy-id + - name: vnf-id in: path - description: UUID representing unique key to this instance + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface required: true type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ - name: body in: body - description: network-policy object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) required: true schema: - $ref: "#/definitions/network-policy" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing network-policy - description: delete an existing network-policy - operationId: deleteNetworkNetworkPoliciesNetworkPolicy + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship consumes: - application/json - application/xml @@ -24538,23 +26797,32 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: network-policy-id + - name: vnf-id in: path - description: UUID representing unique key to this instance + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface required: true type: string - /network/network-policies: + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}: get: tags: - Network - summary: returns network-policies - description: returns network-policies - operationId: getNetworkNetworkPolicies + summary: returns cvlan-tag-entry + description: returns cvlan-tag-entry + operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry produces: - application/json - application/xml @@ -24562,22 +26830,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-policies" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + $ref: "#/getDefinitions/cvlan-tag-entry" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -24586,18 +26839,29 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship + summary: create or update an existing cvlan-tag-entry + description: | + Create or update an existing cvlan-tag-entry. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry consumes: - application/json - application/xml @@ -24613,12 +26877,43 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: - put: + example: __VNF-ID__ + - name: interface-id + in: path + description: Unique ID of the interface + required: true + type: string + example: __INTERFACE-ID__ + - name: cvlan-tag + in: path + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: body + in: body + description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) + required: true + schema: + $ref: "#/definitions/cvlan-tag-entry" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: update an existing cvlan-tag-entry + description: | + Update an existing cvlan-tag-entry + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry consumes: - application/json - application/xml @@ -24634,28 +26929,32 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: interface-id in: path - description: Name given to the interface + description: Unique ID of the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-ID__ + - name: cvlan-tag in: path - description: String that identifies the interface + description: See mis-na-virtualization-platform.yang required: true - type: string + type: integer + format: int64 + example: __CVLAN-TAG__ - name: body in: body - description: relationship object that needs to be created or updated + description: cvlan-tag-entry object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/cvlan-tag-entry" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: delete an existing cvlan-tag-entry + description: delete an existing cvlan-tag-entry + operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry consumes: - application/json - application/xml @@ -24671,29 +26970,40 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: interface-id in: path - description: Name given to the interface + description: Unique ID of the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-ID__ + - name: cvlan-tag in: path - description: String that identifies the interface + description: See mis-na-virtualization-platform.yang + required: true + type: integer + format: int64 + example: __CVLAN-TAG__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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: - put: + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns cvlan-tags + description: returns cvlan-tags + operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/cvlan-tags" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -24702,24 +27012,50 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: interface-id in: path - description: Name given to the interface + description: Unique ID of the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-ID__ + - name: cvlan-tag + in: query + description: + required: false + type: integer + format: int64 + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: l3-interface-ipv4-address + example: __VNF-ID__ + - name: interface-id in: path - description: IP address + description: Unique ID of the interface required: true type: string + example: __INTERFACE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json) required: true schema: $ref: "#/definitions/relationship" @@ -24728,7 +27064,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship consumes: - application/json - application/xml @@ -24744,28 +27080,20 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address + example: __VNF-ID__ + - name: interface-id in: path - description: IP address + description: Unique ID of the interface required: true type: string - /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}: + example: __INTERFACE-ID__ + /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns port-group + description: returns port-group + operationId: getNetworkVcesVcePortGroupsPortGroup produces: - application/json - application/xml @@ -24773,7 +27101,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/port-group" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -24782,152 +27110,22 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address + example: __VNF-ID__ + - name: interface-id in: path - description: IP address + description: Unique ID of the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __INTERFACE-ID__ put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: create or update an existing port-group + description: | + Create or update an existing port-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup consumes: - application/json - application/xml @@ -24943,33 +27141,70 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: interface-id in: path - description: Name given to the interface + description: Unique ID of the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-ID__ + - name: body + in: body + description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json) + required: true + schema: + $ref: "#/definitions/port-group" + patch: + tags: + - Network + summary: update an existing port-group + description: | + Update an existing port-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVcePortGroupsPortGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: l3-interface-ipv4-address + example: __VNF-ID__ + - name: interface-id in: path - description: IP address + description: Unique ID of the interface required: true type: string + example: __INTERFACE-ID__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: port-group object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/port-group" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing port-group + description: delete an existing port-group + operationId: deleteNetworkVcesVcePortGroupsPortGroup consumes: - application/json - application/xml @@ -24985,32 +27220,68 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: interface-id in: path - description: Name given to the interface + description: Unique ID of the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface + example: __INTERFACE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - - name: l3-interface-ipv4-address + /network/vces/vce/{vnf-id}/port-groups: + get: + tags: + - Network + summary: returns port-groups + description: returns port-groups + operationId: getNetworkVcesVcePortGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/port-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: IP address + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: resource-version + example: __VNF-ID__ + - name: interface-id in: query - description: resource-version for concurrency - required: true + description: + required: false type: string - /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: + - name: port-group-id + in: query + description: + required: false + type: string + - name: switch-name + in: query + description: + required: false + type: string + - name: heat-stack-id + in: query + description: + required: false + type: string + /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship consumes: - application/json - application/xml @@ -25026,24 +27297,22 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: l3-interface-ipv6-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of a license resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json) required: true schema: $ref: "#/definitions/relationship" @@ -25052,7 +27321,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship consumes: - application/json - application/xml @@ -25068,28 +27337,26 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: l3-interface-ipv6-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of a license resource. required: true type: string - /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}: + example: __RESOURCE-UUID__ + /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns license + description: returns license + operationId: getNetworkVcesVceLicensesLicense produces: - application/json - application/xml @@ -25097,7 +27364,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/license" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -25106,152 +27373,79 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: vlan-interface + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: String that identifies the interface + description: Unique ID of a license resource. required: true type: string - - name: l3-interface-ipv6-address + example: __RESOURCE-UUID__ + put: + tags: + - Network + summary: create or update an existing license + description: | + Create or update an existing license. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVceLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: IP address + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true type: string - put: + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/license" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: update an existing license + description: | + Update an existing license + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVceLicensesLicense consumes: - application/json - application/xml @@ -25267,33 +27461,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: l3-interface-ipv6-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of a license resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: license object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/license" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkVcesVceLicensesLicense consumes: - application/json - application/xml @@ -25309,33 +27501,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: l3-interface-ipv6-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of a license resource. required: true type: string + example: __RESOURCE-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + /network/vces/vce/{vnf-id}/licenses: get: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + summary: returns licenses + description: returns licenses + operationId: getNetworkVcesVceLicenses produces: - application/json - application/xml @@ -25343,7 +27533,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/licenses" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -25352,131 +27542,23 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + example: __VNF-ID__ + - name: group-uuid in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key + - name: resource-uuid in: query - description: This indicates the customers VPN ID associated with this vlan + description: required: false type: string + /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship consumes: - application/json - application/xml @@ -25492,28 +27574,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: vlan-interface + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: String that identifies the interface + description: Unique ID of an entitlement resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: vlan object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json) required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship consumes: - application/json - application/xml @@ -25529,28 +27614,26 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: vlan-interface + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: String that identifies the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Unique ID of an entitlement resource. required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: + example: __RESOURCE-UUID__ + /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans + summary: returns entitlement + description: returns entitlement + operationId: getNetworkVcesVceEntitlementsEntitlement produces: - application/json - application/xml @@ -25558,7 +27641,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/entitlement" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -25567,115 +27650,28 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. + required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + example: __RESOURCE-UUID__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: create or update an existing entitlement + description: | + Create or update an existing entitlement. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement consumes: - application/json - application/xml @@ -25691,28 +27687,42 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: pci-id + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: PCI ID used to identify the sriov-vf + description: Unique ID of an entitlement resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/entitlement" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: update an existing entitlement + description: | + Update an existing entitlement + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVceEntitlementsEntitlement consumes: - application/json - application/xml @@ -25728,31 +27738,38 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: pci-id + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: PCI ID used to identify the sriov-vf + description: Unique ID of an entitlement resource. required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" + delete: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkVcesVceEntitlementsEntitlement + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -25761,140 +27778,64 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name given to the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: pci-id + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: PCI ID used to identify the sriov-vf + description: Unique ID of an entitlement resource. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + example: __RESOURCE-UUID__ + - name: resource-version in: query - description: Name of the network - required: false + description: resource-version for concurrency + required: true type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false + /network/vces/vce/{vnf-id}/entitlements: + get: + tags: + - Network + summary: returns entitlements + description: returns entitlements + operationId: getNetworkVcesVceEntitlements + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlements" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: vf-mac-filter + example: __VNF-ID__ + - name: group-uuid in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + description: required: false type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id + - name: resource-uuid in: query - description: Neutron network id of the interface + description: required: false type: string + /network/vces/vce/{vnf-id}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship consumes: - application/json - application/xml @@ -25910,28 +27851,107 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkVcesVceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: Name given to the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: pci-id + example: __VNF-ID__ + /network/vces/vce/{vnf-id}: + get: + tags: + - Network + summary: returns vce + description: returns vce + operationId: getNetworkVcesVce + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vce" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + put: + tags: + - Network + summary: create or update an existing vce + description: | + Create or update an existing vce. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json) required: true schema: - $ref: "#/definitions/sriov-vf" - delete: + $ref: "#/definitions/vce" + patch: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + summary: update an existing vce + description: | + Update an existing vce + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVcesVce consumes: - application/json - application/xml @@ -25947,28 +27967,47 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __VNF-ID__ + - name: body + in: body + description: vce object that needs to be updated. required: true - type: string - - name: pci-id + schema: + $ref: "#/patchDefinitions/vce" + delete: + tags: + - Network + summary: delete an existing vce + description: delete an existing vce + operationId: deleteNetworkVcesVce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/vces: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs + summary: returns vces + description: returns vces + operationId: getNetworkVces produces: - application/json - application/xml @@ -25976,124 +28015,61 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/vces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true + in: query + description: + required: false type: string - name: vnf-name in: query - description: Name of VNF. + description: required: false type: string - name: vnf-name2 in: query - description: Alternate name of VNF. + description: required: false type: string - name: vnf-type in: query - 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. + description: required: false type: string - name: service-id in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + description: required: false type: string - name: regional-resource-zone in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - name: prov-status in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: vpe-id in: query - description: Name of the network + description: required: false type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship consumes: - application/json - application/xml @@ -26104,19 +28080,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json) required: true schema: $ref: "#/definitions/relationship" @@ -26125,7 +28097,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship consumes: - application/json - application/xml @@ -26136,22 +28108,18 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string - /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: + example: __VNFC-NAME__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -26162,24 +28130,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -26188,7 +28153,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -26199,28 +28164,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: get: tags: - Network summary: returns l3-interface-ipv4-address-list description: returns l3-interface-ipv4-address-list - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -26228,145 +28190,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -26377,33 +28225,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: vnfc-name in: path - description: Unique id of VNF. This is unique across the graph. + description: Unique ID of vnfc. required: true type: string - - name: interface-name + example: __VNFC-NAME__ + - name: l3-interface-ipv4-address in: path - description: Name given to the interface + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv4-address-list description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -26414,32 +28304,29 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -26450,24 +28337,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -26476,7 +28360,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -26487,28 +28371,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: - Network summary: returns l3-interface-ipv6-address-list description: returns l3-interface-ipv6-address-list - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -26516,145 +28397,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -26665,33 +28432,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: vnfc-name in: path - description: Unique id of VNF. This is unique across the graph. + description: Unique ID of vnfc. required: true type: string - - name: interface-name + example: __VNFC-NAME__ + - name: l3-interface-ipv6-address in: path - description: Name given to the interface + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name + in: path + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv6-address-list description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -26702,33 +28511,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}: + /network/vnfcs/vnfc/{vnfc-name}: get: tags: - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface + summary: returns vnfc + description: returns vnfc + operationId: getNetworkVnfcsVnfc produces: - application/json - application/xml @@ -26736,124 +28542,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/vnfc" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string + example: __VNFC-NAME__ put: tags: - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface + summary: create or update an existing vnfc + description: | + Create or update an existing vnfc. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkVnfcsVnfc consumes: - application/json - application/xml @@ -26864,28 +28571,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: vnfc-name in: path - description: Unique id of VNF. This is unique across the graph. + description: Unique ID of vnfc. required: true type: string - - name: interface-name + example: __VNFC-NAME__ + - name: body + in: body + description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json) + required: true + schema: + $ref: "#/definitions/vnfc" + patch: + tags: + - Network + summary: update an existing vnfc + description: | + Update an existing vnfc + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkVnfcsVnfc + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated + description: vnfc object that needs to be updated. required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/patchDefinitions/vnfc" delete: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface + summary: delete an existing vnfc + description: delete an existing vnfc + operationId: deleteNetworkVnfcsVnfc consumes: - application/json - application/xml @@ -26896,28 +28638,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: vnfc-name in: path - description: Name given to the interface + description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces: + /network/vnfcs: get: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkGenericVnfsGenericVnfLInterfaces + summary: returns vnfcs + description: returns vnfcs + operationId: getNetworkVnfcs produces: - application/json - application/xml @@ -26925,104 +28663,66 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/vnfcs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type + - name: vnfc-name in: query - 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. + description: required: false type: string - - name: service-id + - name: nfc-naming-code in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + description: required: false type: string - - name: regional-resource-zone + - name: nfc-function in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - name: prov-status in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: ipaddress-v4-oam-vip in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - name: in-maint in: query + description: required: false type: boolean - name: is-closed-loop-disabled in: query + description: required: false type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function + - name: group-notation in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - - name: nf-role + - name: model-invariant-id in: query - description: role in the network that this model will be providing + description: required: false type: string - - name: nf-naming-code + - name: model-version-id in: query - description: string assigned to this model used for naming purposes + description: required: false type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship consumes: - application/json - application/xml @@ -27033,19 +28733,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name that identifies the link aggregate interface + description: Subnet ID, should be UUID. + required: true + type: string + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id required: true type: string + example: __HOST-ROUTE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) required: true schema: $ref: "#/definitions/relationship" @@ -27054,7 +28762,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship consumes: - application/json - application/xml @@ -27065,64 +28773,69 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name that identifies the link aggregate interface + description: Subnet ID, should be UUID. required: true type: string - /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: - put: + example: __SUBNET-ID__ + - name: host-route-id + in: path + description: host-route id + required: true + type: string + example: __HOST-ROUTE-ID__ + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns host-route + description: returns host-route + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/host-route" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name that identifies the link aggregate interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name given to the interface + description: Subnet ID, should be UUID. required: true type: string - - name: vlan-interface + example: __SUBNET-ID__ + - name: host-route-id in: path - description: String that identifies the interface + description: host-route id required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + example: __HOST-ROUTE-ID__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: create or update an existing host-route + description: | + Create or update an existing host-route. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute consumes: - application/json - application/xml @@ -27133,32 +28846,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name that identifies the link aggregate interface + description: Subnet ID, should be UUID. required: true type: string - - name: interface-name + example: __SUBNET-ID__ + - name: host-route-id in: path - description: Name given to the interface + description: host-route id required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface + example: __HOST-ROUTE-ID__ + - name: body + in: body + description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) required: true - type: string - /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: - put: + schema: + $ref: "#/definitions/host-route" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: update an existing host-route + description: | + Update an existing host-route + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute consumes: - application/json - application/xml @@ -27169,43 +28897,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-interface + example: __NETWORK-ID__ + - name: subnet-id in: path - description: String that identifies the interface + description: Subnet ID, should be UUID. required: true type: string - - name: l3-interface-ipv4-address + example: __SUBNET-ID__ + - name: host-route-id in: path - description: IP address + description: host-route id required: true type: string + example: __HOST-ROUTE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: host-route object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/host-route" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: delete an existing host-route + description: delete an existing host-route + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute consumes: - application/json - application/xml @@ -27216,38 +28937,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name that identifies the link aggregate interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name given to the interface + description: Subnet ID, should be UUID. required: true type: string - - name: vlan-interface + example: __SUBNET-ID__ + - name: host-route-id in: path - description: String that identifies the interface + description: host-route id required: true type: string - - name: l3-interface-ipv4-address - in: path - description: IP address + example: __HOST-ROUTE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns host-routes + description: returns host-routes + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes produces: - application/json - application/xml @@ -27255,176 +28974,33 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/host-routes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: network-id in: path - description: String that identifies the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: l3-interface-ipv4-address + example: __NETWORK-ID__ + - name: subnet-id in: path - description: IP address + description: Subnet ID, should be UUID. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id + example: __SUBNET-ID__ + - name: host-route-id in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship consumes: - application/json - application/xml @@ -27435,43 +29011,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: network-id in: path - description: String that identifies the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: l3-interface-ipv4-address + example: __NETWORK-ID__ + - name: subnet-id in: path - description: IP address + description: Subnet ID, should be UUID. required: true type: string + example: __SUBNET-ID__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship consumes: - application/json - application/xml @@ -27482,42 +29045,57 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name that identifies the link aggregate interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name given to the interface + description: Subnet ID, should be UUID. required: true type: string - - name: vlan-interface + example: __SUBNET-ID__ + /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}: + get: + tags: + - Network + summary: returns subnet + description: returns subnet + operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/subnet" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: String that identifies the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: l3-interface-ipv4-address + example: __NETWORK-ID__ + - name: subnet-id in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Subnet ID, should be UUID. required: true type: string - /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: + example: __SUBNET-ID__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: create or update an existing subnet + description: | + Create or update an existing subnet. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet consumes: - application/json - application/xml @@ -27528,43 +29106,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: subnet-id in: path - description: Name that identifies the link aggregate interface + description: Subnet ID, should be UUID. required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __SUBNET-ID__ + - name: body + in: body + description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json) required: true - type: string - - name: vlan-interface + schema: + $ref: "#/definitions/subnet" + patch: + tags: + - Network + summary: update an existing subnet + description: | + Update an existing subnet + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: String that identifies the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: l3-interface-ipv6-address + example: __NETWORK-ID__ + - name: subnet-id in: path - description: IP address + description: Subnet ID, should be UUID. required: true type: string + example: __SUBNET-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: subnet object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/subnet" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing subnet + description: delete an existing subnet + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet consumes: - application/json - application/xml @@ -27575,38 +29185,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-interface + example: __NETWORK-ID__ + - name: subnet-id in: path - description: String that identifies the interface + description: Subnet ID, should be UUID. required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + example: __SUBNET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /network/l3-networks/l3-network/{network-id}/subnets: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns subnets + description: returns subnets + operationId: getNetworkL3NetworksL3NetworkSubnets produces: - application/json - application/xml @@ -27614,176 +29216,67 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/subnets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address + - name: network-id in: path - description: IP address + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr + example: __NETWORK-ID__ + - name: subnet-id in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: subnet-name in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id + in: path + description: Network ID, should be uuid. Unique across A&AI. + required: true type: string + example: __NETWORK-ID__ - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false + in: path + description: id. + required: true type: integer format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: + example: __VLAN-ID-INNER__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -27794,43 +29287,105 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: vlan-id-inner in: path - description: Name that identifies the link aggregate interface + description: id. required: true - type: string - - name: interface-name + type: integer + format: int64 + example: __VLAN-ID-INNER__ + /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}: + get: + tags: + - Network + summary: returns ctag-assignment + description: returns ctag-assignment + operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ctag-assignment" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-interface + example: __NETWORK-ID__ + - name: vlan-id-inner in: path - description: String that identifies the interface + description: id. required: true - type: string - - name: l3-interface-ipv6-address + type: integer + format: int64 + example: __VLAN-ID-INNER__ + put: + tags: + - Network + summary: create or update an existing ctag-assignment + description: | + Create or update an existing ctag-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: IP address + description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ + - name: vlan-id-inner + in: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + $ref: "#/definitions/ctag-assignment" + patch: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: update an existing ctag-assignment + description: | + Update an existing ctag-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment consumes: - application/json - application/xml @@ -27841,43 +29396,66 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: vlan-id-inner in: path - description: Name that identifies the link aggregate interface + description: id. required: true - type: string - - name: interface-name - in: path - description: Name given to the interface + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: ctag-assignment object that needs to be updated. required: true - type: string - - name: vlan-interface + schema: + $ref: "#/patchDefinitions/ctag-assignment" + delete: + tags: + - Network + summary: delete an existing ctag-assignment + description: delete an existing ctag-assignment + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: String that identifies the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: l3-interface-ipv6-address + example: __NETWORK-ID__ + - name: vlan-id-inner in: path - description: IP address + description: id. required: true - type: string + type: integer + format: int64 + example: __VLAN-ID-INNER__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + /network/l3-networks/l3-network/{network-id}/ctag-assignments: get: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: returns ctag-assignments + description: returns ctag-assignments + operationId: getNetworkL3NetworksL3NetworkCtagAssignments produces: - application/json - application/xml @@ -27885,155 +29463,28 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/ctag-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: network-id in: path - description: String that identifies the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string + example: __NETWORK-ID__ - name: vlan-id-inner in: query - description: Inner VLAN tag + description: required: false type: integer format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string + /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -28044,38 +29495,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-interface + example: __NETWORK-ID__ + - name: segmentation-id in: path - description: String that identifies the interface + description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __SEGMENTATION-ID__ - name: body in: body - description: vlan object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -28086,38 +29529,25 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-interface + example: __NETWORK-ID__ + - name: segmentation-id in: path - description: String that identifies the interface - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Route Table Reference id, UUID assigned to this instance. required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + example: __SEGMENTATION-ID__ + /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + summary: returns segmentation-assignment + description: returns segmentation-assignment + operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment produces: - application/json - application/xml @@ -28125,139 +29555,76 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/segmentation-assignment" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: segmentation-id in: path - description: Name that identifies the link aggregate interface + description: Route Table Reference id, UUID assigned to this instance. required: true type: string - - name: interface-name + example: __SEGMENTATION-ID__ + put: + tags: + - Network + summary: create or update an existing segmentation-assignment + description: | + Create or update an existing segmentation-assignment. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false + example: __NETWORK-ID__ + - name: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - /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: - put: + example: __SEGMENTATION-ID__ + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) + required: true + schema: + $ref: "#/definitions/segmentation-assignment" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: update an existing segmentation-assignment + description: | + Update an existing segmentation-assignment + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment consumes: - application/json - application/xml @@ -28268,38 +29635,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: pci-id + example: __NETWORK-ID__ + - name: segmentation-id in: path - description: PCI ID used to identify the sriov-vf + description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __SEGMENTATION-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: segmentation-assignment object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/segmentation-assignment" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: delete an existing segmentation-assignment + description: delete an existing segmentation-assignment + operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment consumes: - application/json - application/xml @@ -28310,33 +29669,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name that identifies the link aggregate interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: segmentation-id in: path - description: Name given to the interface + description: Route Table Reference id, UUID assigned to this instance. required: true type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf + example: __SEGMENTATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /network/l3-networks/l3-network/{network-id}/segmentation-assignments: get: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: returns segmentation-assignments + description: returns segmentation-assignments + operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments produces: - application/json - application/xml @@ -28344,164 +29700,27 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/segmentation-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id + - name: network-id in: path - description: PCI ID used to identify the sriov-vf + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id + example: __NETWORK-ID__ + - name: segmentation-id in: query - description: Neutron network id of the interface + description: required: false type: string + /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship consumes: - application/json - application/xml @@ -28512,38 +29731,112 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-id in: path - description: Unique id of VNF. This is unique across the graph. + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: Name that identifies the link aggregate interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name + example: __NETWORK-ID__ + /network/l3-networks/l3-network/{network-id}: + get: + tags: + - Network + summary: returns l3-network + description: returns l3-network + operationId: getNetworkL3NetworksL3Network + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-network" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: Name given to the interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: pci-id + example: __NETWORK-ID__ + put: + tags: + - Network + summary: create or update an existing l3-network + description: | + Create or update an existing l3-network. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: PCI ID used to identify the sriov-vf + description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json) required: true schema: - $ref: "#/definitions/sriov-vf" - delete: + $ref: "#/definitions/l3-network" + patch: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: update an existing l3-network + description: | + Update an existing l3-network + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkL3NetworksL3Network consumes: - application/json - application/xml @@ -28554,38 +29847,52 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: network-id in: path - description: Name that identifies the link aggregate interface + description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __NETWORK-ID__ + - name: body + in: body + description: l3-network object that needs to be updated. required: true - type: string - - name: pci-id + schema: + $ref: "#/patchDefinitions/l3-network" + delete: + tags: + - Network + summary: delete an existing l3-network + description: delete an existing l3-network + operationId: deleteNetworkL3NetworksL3Network + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-id in: path - description: PCI ID used to identify the sriov-vf + description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/l3-networks: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + summary: returns l3-networks + description: returns l3-networks + operationId: getNetworkL3Networks produces: - application/json - application/xml @@ -28593,139 +29900,66 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/l3-networks" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vnf-name + - name: network-id in: query - description: Name of VNF. + description: required: false type: string - - name: vnf-name2 + - name: network-name in: query - description: Alternate name of VNF. + description: required: false type: string - - name: vnf-type + - name: network-role in: query - 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. + description: required: false type: string - name: service-id in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - name: heat-stack-id in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: contrail-network-fqdn in: query + description: required: false - type: boolean + type: string - name: model-invariant-id in: query - description: the ASDC model id for this resource or service model. + description: required: false type: string - name: model-version-id in: query - description: the ASDC model version for this resource or service model. + description: required: false type: string - name: widget-model-id in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + description: required: false type: string - name: widget-model-version in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network + description: required: false type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship consumes: - application/json - application/xml @@ -28736,24 +29970,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name + - name: network-policy-id in: path - description: Name given to the interface + description: UUID representing unique key to this instance required: true type: string + example: __NETWORK-POLICY-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json) required: true schema: $ref: "#/definitions/relationship" @@ -28762,7 +29987,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship consumes: - application/json - application/xml @@ -28773,27 +29998,45 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id - in: path - description: Unique id of VNF. This is unique across the graph. - required: true - type: string - - name: interface-name + - name: network-policy-id in: path - description: Name that identifies the link aggregate interface + description: UUID representing unique key to this instance required: true type: string - - name: interface-name + example: __NETWORK-POLICY-ID__ + /network/network-policies/network-policy/{network-policy-id}: + get: + tags: + - Network + summary: returns network-policy + description: returns network-policy + operationId: getNetworkNetworkPoliciesNetworkPolicy + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-policy" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id in: path - description: Name given to the interface + description: UUID representing unique key to this instance required: true type: string - /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: + example: __NETWORK-POLICY-ID__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + summary: create or update an existing network-policy + description: | + Create or update an existing network-policy. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy consumes: - application/json - application/xml @@ -28804,29 +30047,137 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id + - name: network-policy-id in: path - description: Unique id of VNF. This is unique across the graph. + description: UUID representing unique key to this instance required: true type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json) + required: true + schema: + $ref: "#/definitions/network-policy" + patch: + tags: + - Network + summary: update an existing network-policy + description: | + Update an existing network-policy + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: path + description: UUID representing unique key to this instance required: true type: string - - name: interface-name + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/network-policy" + delete: + tags: + - Network + summary: delete an existing network-policy + description: delete an existing network-policy + operationId: deleteNetworkNetworkPoliciesNetworkPolicy + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id in: path - description: Name given to the interface + description: UUID representing unique key to this instance required: true type: string - - name: l3-interface-ipv4-address + example: __NETWORK-POLICY-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/network-policies: + get: + tags: + - Network + summary: returns network-policies + description: returns network-policies + operationId: getNetworkNetworkPolicies + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/network-policies" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: network-policy-id + in: query + description: + required: false + type: string + - name: network-policy-fqdn + in: query + description: + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: IP address + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json) required: true schema: $ref: "#/definitions/relationship" @@ -28835,7 +30186,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship consumes: - application/json - application/xml @@ -28851,36 +30202,60 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - /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}: - get: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -28889,151 +30264,25 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string + example: __VNF-ID__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __VLAN-INTERFACE__ + /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: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -29049,33 +30298,37 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -29091,32 +30344,76 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. required: true type: string - /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: + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -29132,33 +30429,48 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -29174,36 +30486,44 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /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}: - get: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29212,151 +30532,36 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv6-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: Neutron id of subnet that address belongs to - required: false + description: resource-version for concurrency + required: true type: string + /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: put: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -29372,33 +30577,37 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -29414,33 +30623,32 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -29448,7 +30656,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29457,130 +30665,91 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -29596,28 +30765,37 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l-interface object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -29633,28 +30811,37 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces + summary: returns vlan + description: returns vlan + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -29662,7 +30849,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29671,119 +30858,35 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: - get: + example: __VLAN-INTERFACE__ + put: tags: - Network - summary: returns lag-interface - description: returns lag-interface - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29792,110 +30895,42 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: tags: - Network - summary: create or update an existing lag-interface - description: create or update an existing lag-interface - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -29911,23 +30946,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: lag-interface object that needs to be created or updated + description: vlan object that needs to be updated. required: true schema: - $ref: "#/definitions/lag-interface" + $ref: "#/patchDefinitions/vlan" delete: tags: - Network - summary: delete an existing lag-interface - description: delete an existing lag-interface - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -29943,23 +30986,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces: + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network - summary: returns lag-interfaces - description: returns lag-interfaces - operationId: getNetworkGenericVnfsGenericVnfLagInterfaces + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -29967,7 +31018,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29976,95 +31027,35 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: nf-function + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: English description of Network function that the specific VNF deployment is providing + description: required: false type: string - - name: nf-role + - name: vlan-id-inner in: query - description: role in the network that this model will be providing + description: required: false - type: string - - name: nf-naming-code + type: integer + format: int64 + - name: vpn-key in: query - description: string assigned to this model used for naming purposes + description: required: false type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -30080,14 +31071,22 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vf-module-id + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID of vf-module. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -30096,7 +31095,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -30112,18 +31111,26 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vf-module-id + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID of vf-module. + description: Name given to the interface required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - Network - summary: returns vf-module - description: returns vf-module - operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -30131,7 +31138,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vf-module" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -30140,135 +31147,79 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vf-module-id + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID of vf-module. + description: Name given to the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string - - name: vf-module-name - in: query - description: Name of vf-module - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance. - required: false - type: string - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false + example: __PCI-ID__ + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: contrail-service-instance-fqdn - in: query - description: the Contrail unique ID for a service-instance - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - put: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: tags: - Network - summary: create or update an existing vf-module - description: create or update an existing vf-module - operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -30284,23 +31235,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vf-module-id + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID of vf-module. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: vf-module object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/vf-module" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network - summary: delete an existing vf-module - description: delete an existing vf-module - operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -30316,23 +31275,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vf-module-id + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID of vf-module. + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network - summary: returns vf-modules - description: returns vf-modules - operationId: getNetworkGenericVnfsGenericVnfVfModules + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -30340,7 +31307,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vf-modules" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -30349,95 +31316,106 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: regional-resource-zone + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: Regional way of organizing pservers, source of truth should define values + description: required: false type: string - - name: prov-status + - name: vf-vlan-filter in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-mac-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled + - name: vf-vlan-strip in: query + description: required: false type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version + - name: neutron-network-id in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + description: required: false type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + example: __INTERFACE-NAME__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -30453,19 +31431,22 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: Unique ID of a license resource. + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -30474,7 +31455,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -30490,23 +31471,26 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: Unique ID of a license resource. + description: IP address required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: get: tags: - Network - summary: returns license - description: returns license - operationId: getNetworkGenericVnfsGenericVnfLicensesLicense + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -30514,7 +31498,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/license" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -30523,105 +31507,28 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: Unique ID of a license resource. + description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: create or update an existing license - description: create or update an existing license - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -30637,28 +31544,42 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: Unique ID of a license resource. + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: license object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/license" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing license - description: delete an existing license - operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -30674,36 +31595,38 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: Unique ID of a license resource. + description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. required: true - type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/licenses: - get: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns licenses - description: returns licenses - operationId: getNetworkGenericVnfsGenericVnfLicenses + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/licenses" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -30712,95 +31635,30 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: nf-naming-code + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: string assigned to this model used for naming purposes - required: false + description: resource-version for concurrency + required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -30816,19 +31674,22 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Unique ID of an entitlement resource. + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -30837,7 +31698,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -30853,23 +31714,26 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Unique ID of an entitlement resource. + description: IP address required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: - Network - summary: returns entitlement - description: returns entitlement - operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -30877,7 +31741,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlement" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -30886,105 +31750,28 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Unique ID of an entitlement resource. + description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false - type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network - summary: create or update an existing entitlement - description: create or update an existing entitlement - operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -31000,28 +31787,42 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Unique ID of an entitlement resource. + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: entitlement object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/entitlement" - delete: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: delete an existing entitlement - description: delete an existing entitlement - operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -31037,36 +31838,38 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: interface-name in: path - description: Unique ID for the entitlement group the resource comes from, should be uuid. + description: Name given to the interface required: true type: string - - name: resource-uuid + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Unique ID of an entitlement resource. + description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. required: true - type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements: - get: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - Network - summary: returns entitlements - description: returns entitlements - operationId: getNetworkGenericVnfsGenericVnfEntitlements + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/entitlements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -31075,96 +31878,31 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - - name: nf-naming-code + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version in: query - description: string assigned to this model used for naming purposes - required: false + description: resource-version for concurrency + required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}: + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}: get: tags: - Network - summary: returns generic-vnf - description: returns generic-vnf - operationId: getNetworkGenericVnfsGenericVnf + summary: returns l-interface + description: returns l-interface + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface produces: - application/json - application/xml @@ -31172,7 +31910,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/generic-vnf" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -31181,95 +31919,22 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: service-id - in: query - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - required: false - type: string - - name: regional-resource-zone - in: query - description: Regional way of organizing pservers, source of truth should define values - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: in-maint - in: query - required: false - type: boolean - - name: is-closed-loop-disabled - in: query - required: false - type: boolean - - name: model-invariant-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: model-version-id - in: query - description: the ASDC model version for this resource or service model. - required: false - type: string - - name: widget-model-id - in: query - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - required: false - type: string - - name: widget-model-version - in: query - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - required: false - type: string - - name: nf-type - in: query - description: Generic description of the type of NF - required: false - type: string - - name: nf-function - in: query - description: English description of Network function that the specific VNF deployment is providing - required: false - type: string - - name: nf-role - in: query - description: role in the network that this model will be providing - required: false - type: string - - name: nf-naming-code - in: query - description: string assigned to this model used for naming purposes - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string + example: __INTERFACE-NAME__ put: tags: - Network - summary: create or update an existing generic-vnf - description: create or update an existing generic-vnf - operationId: createOrUpdateNetworkGenericVnfsGenericVnf + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface consumes: - application/json - application/xml @@ -31285,18 +31950,36 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: body in: body - description: generic-vnf object that needs to be created or updated + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/generic-vnf" - delete: + $ref: "#/definitions/l-interface" + patch: tags: - Network - summary: delete an existing generic-vnf - description: delete an existing generic-vnf - operationId: deleteNetworkGenericVnfsGenericVnf + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface consumes: - application/json - application/xml @@ -31312,105 +31995,25 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/generic-vnfs: - get: - tags: - - Network - summary: returns generic-vnfs - description: returns generic-vnfs - operationId: getNetworkGenericVnfs - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/generic-vnfs" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - /network/lag-links/lag-link/{link-name}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name + example: __VNF-ID__ + - name: interface-name in: path - description: Alphabetical concatenation of lag-interface names + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: l-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name - in: path - description: Alphabetical concatenation of lag-interface names - required: true - type: string - /network/lag-links/lag-link/{link-name}: - get: - tags: - - Network - summary: returns lag-link - description: returns lag-link - operationId: getNetworkLagLinksLagLink - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/lag-link" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name - in: path - description: Alphabetical concatenation of lag-interface names - required: true - type: string - put: - tags: - - Network - summary: create or update an existing lag-link - description: create or update an existing lag-link - operationId: createOrUpdateNetworkLagLinksLagLink + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface consumes: - application/json - application/xml @@ -31421,50 +32024,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: vnf-id in: path - description: Alphabetical concatenation of lag-interface names + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: body - in: body - description: lag-link object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/lag-link" - delete: - tags: - - Network - summary: delete an existing lag-link - description: delete an existing lag-link - operationId: deleteNetworkLagLinksLagLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name + example: __VNF-ID__ + - name: interface-name in: path - description: Alphabetical concatenation of lag-interface names + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/lag-links: + /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces: get: tags: - Network - summary: returns lag-links - description: returns lag-links - operationId: getNetworkLagLinks + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkGenericVnfsGenericVnfLInterfaces produces: - application/json - application/xml @@ -31472,15 +32055,42 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-links" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -31491,14 +32101,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -31507,7 +32124,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -31518,17 +32135,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -31539,24 +32163,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -31565,7 +32198,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -31576,27 +32209,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - /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: + example: __VLAN-INTERFACE__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -31607,29 +32249,39 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -31638,7 +32290,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -31649,33 +32301,43 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network summary: returns l3-interface-ipv4-address-list description: returns l3-interface-ipv4-address-list - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -31683,103 +32345,112 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -31790,38 +32461,48 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv4-address-list description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -31832,37 +32513,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -31873,29 +32564,39 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -31904,7 +32605,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -31915,33 +32616,43 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network summary: returns l3-interface-ipv6-address-list description: returns l3-interface-ipv6-address-list - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -31949,103 +32660,112 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -32056,38 +32776,48 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv6-address-list description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -32098,38 +32828,48 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network summary: returns vlan description: returns vlan - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -32137,82 +32877,100 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VLAN-INTERFACE__ + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -32223,33 +32981,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: vlan object that needs to be created or updated + description: vlan object that needs to be updated. required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/patchDefinitions/vlan" delete: tags: - Network summary: delete an existing vlan description: delete an existing vlan - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -32260,33 +33027,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network summary: returns vlans description: returns vlans - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -32294,66 +33070,50 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: interface-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -32364,24 +33124,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -32390,7 +33159,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -32401,28 +33170,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + example: __PCI-ID__ + /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}: get: tags: - Network summary: returns sriov-vf description: returns sriov-vf - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -32430,91 +33208,100 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false + example: __PCI-ID__ + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vnf-type - in: query - 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. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - put: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -32525,33 +33312,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network summary: delete an existing sriov-vf description: delete an existing sriov-vf - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -32562,33 +33358,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network summary: returns sriov-vfs description: returns sriov-vfs - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -32596,66 +33401,59 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: prov-status + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: vf-vlan-filter in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - - name: interface-id + - name: vf-mac-filter in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vf-vlan-strip in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: boolean + - name: neutron-network-id in: query - description: Name of the network + description: required: false type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -32666,19 +33464,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -32687,7 +33493,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -32698,22 +33504,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: + example: __INTERFACE-NAME__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -32724,24 +33538,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -32750,7 +33573,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -32761,28 +33584,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network summary: returns l3-interface-ipv4-address-list description: returns l3-interface-ipv4-address-list - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -32790,87 +33622,100 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -32881,33 +33726,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv4-address-list description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -32918,32 +33772,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -32954,24 +33817,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -32980,7 +33852,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -32991,28 +33863,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network summary: returns l3-interface-ipv6-address-list description: returns l3-interface-ipv6-address-list - operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -33020,87 +33901,100 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -33111,33 +34005,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv6-address-list description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -33148,33 +34051,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network summary: returns l-interface description: returns l-interface - operationId: getNetworkNewvcesNewvceLInterfacesLInterface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface produces: - application/json - application/xml @@ -33182,66 +34094,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the link aggregate interface required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false - type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string + example: __INTERFACE-NAME__ put: tags: - Network summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -33252,28 +34135,87 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l-interface object that needs to be created or updated + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network summary: delete an existing l-interface description: delete an existing l-interface - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -33284,28 +34226,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - Network summary: returns l-interfaces description: returns l-interfaces - operationId: getNetworkNewvcesNewvceLInterfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces produces: - application/json - application/xml @@ -33313,47 +34263,49 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: vnf-name2 + example: __INTERFACE-NAME__ + - name: interface-name in: query - description: Alternate name of VNF. + description: required: false type: string - - name: vnf-type + - name: interface-id in: query - 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. + description: required: false type: string - - name: prov-status + - name: macaddr in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: required: false type: string - - name: heat-stack-id + - name: network-name in: query - description: Heat stack id corresponding to this instance, managed by MSO + description: required: false type: string - /network/newvces/newvce/{vnf-id2}: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: get: tags: - Network - summary: returns newvce - description: returns newvce - operationId: getNetworkNewvcesNewvce + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface produces: - application/json - application/xml @@ -33361,46 +34313,76 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/newvce" + $ref: "#/getDefinitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vnf-name - in: query - description: Name of VNF. - required: false - type: string - - name: vnf-name2 - in: query - description: Alternate name of VNF. - required: false - type: string - - name: vnf-type - in: query - 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. - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true type: string - - name: heat-stack-id - in: query - description: Heat stack id corresponding to this instance, managed by MSO - required: false + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true type: string - put: + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: tags: - Network - summary: create or update an existing newvce - description: create or update an existing newvce - operationId: createOrUpdateNetworkNewvcesNewvce + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface consumes: - application/json - application/xml @@ -33411,23 +34393,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: newvce object that needs to be created or updated + description: lag-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/newvce" + $ref: "#/patchDefinitions/lag-interface" delete: tags: - Network - summary: delete an existing newvce - description: delete an existing newvce - operationId: deleteNetworkNewvcesNewvce + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface consumes: - application/json - application/xml @@ -33438,23 +34427,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: vnf-id2 + - name: vnf-id in: path - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/newvces: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces: get: tags: - Network - summary: returns newvces - description: returns newvces - operationId: getNetworkNewvces + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfaces produces: - application/json - application/xml @@ -33462,15 +34458,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/newvces" + $ref: "#/getDefinitions/lag-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: + parameters: + - name: vnf-id + in: path + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: interface-role + in: query + description: + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship consumes: - application/json - application/xml @@ -33481,14 +34499,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. required: true type: string + example: __VF-MODULE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) required: true schema: $ref: "#/definitions/relationship" @@ -33497,7 +34522,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship consumes: - application/json - application/xml @@ -33508,49 +34533,57 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: - put: + example: __VNF-ID__ + - name: vf-module-id + in: path + description: Unique ID of vf-module. + required: true + type: string + example: __VF-MODULE-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns vf-module + description: returns vf-module + operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vf-module" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: vf-module-id in: path - description: Name that identifies the physical interface + description: Unique ID of vf-module. required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/relationship" - delete: + example: __VF-MODULE-ID__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship + summary: create or update an existing vf-module + description: | + Create or update an existing vf-module. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule consumes: - application/json - application/xml @@ -33561,22 +34594,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: vf-module-id in: path - description: Name that identifies the physical interface + description: Unique ID of vf-module. required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: - put: + example: __VF-MODULE-ID__ + - name: body + in: body + description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) + required: true + schema: + $ref: "#/definitions/vf-module" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + summary: update an existing vf-module + description: | + Update an existing vf-module + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule consumes: - application/json - application/xml @@ -33587,33 +34639,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id in: path - description: Name that identifies the physical interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: pf-pci-id + example: __VNF-ID__ + - name: vf-module-id in: path - description: Identifier for the sriov-pf + description: Unique ID of vf-module. required: true type: string + example: __VF-MODULE-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: vf-module object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/vf-module" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + summary: delete an existing vf-module + description: delete an existing vf-module + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule consumes: - application/json - application/xml @@ -33624,28 +34673,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: vf-module-id in: path - description: Name that identifies the physical interface + description: Unique ID of vf-module. required: true type: string - - name: pf-pci-id - in: path - description: Identifier for the sriov-pf + example: __VF-MODULE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: get: tags: - Network - summary: returns sriov-pf - description: returns sriov-pf - operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + summary: returns vf-modules + description: returns vf-modules + operationId: getNetworkGenericVnfsGenericVnfVfModules produces: - application/json - application/xml @@ -33653,41 +34704,62 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-pf" + $ref: "#/getDefinitions/vf-modules" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true + example: __VNF-ID__ + - name: vf-module-id + in: query + description: + required: false type: string - - name: pf-pci-id - in: path - description: Identifier for the sriov-pf - required: true + - name: vf-module-name + in: query + description: + required: false type: string - - name: inv-status + - name: heat-stack-id in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: prov-status + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string + - name: widget-model-id + in: query + description: + required: false + type: string + - name: widget-model-version + in: query + description: + required: false + type: string + - name: contrail-service-instance-fqdn in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing sriov-pf - description: create or update an existing sriov-pf - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship consumes: - application/json - application/xml @@ -33698,33 +34770,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name that identifies the physical interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: pf-pci-id + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: Identifier for the sriov-pf + description: Unique ID of a license resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: sriov-pf object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json) required: true schema: - $ref: "#/definitions/sriov-pf" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing sriov-pf - description: delete an existing sriov-pf - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship consumes: - application/json - application/xml @@ -33735,33 +34810,31 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name that identifies the physical interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: pf-pci-id + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: Identifier for the sriov-pf - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Unique ID of a license resource. required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: + example: __RESOURCE-UUID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: get: tags: - Network - summary: returns sriov-pfs - description: returns sriov-pfs - operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs + summary: returns license + description: returns license + operationId: getNetworkGenericVnfsGenericVnfLicensesLicense produces: - application/json - application/xml @@ -33769,36 +34842,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-pfs" + $ref: "#/getDefinitions/license" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name that identifies the physical interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. + required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + example: __RESOURCE-UUID__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: create or update an existing license + description: | + Create or update an existing license. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense consumes: - application/json - application/xml @@ -33809,38 +34883,87 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name that identifies the physical interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: interface-name + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: Name given to the interface + description: Unique ID of a license resource. required: true type: string - - name: vlan-interface + example: __RESOURCE-UUID__ + - name: body + in: body + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json) + required: true + schema: + $ref: "#/definitions/license" + patch: + tags: + - Network + summary: update an existing license + description: | + Update an existing license + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. + required: true + type: string + example: __VNF-ID__ + - name: group-uuid + in: path + description: Unique ID for the license group the resource belongs to, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of a license resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: license object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/license" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense consumes: - application/json - application/xml @@ -33851,32 +34974,69 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name that identifies the physical interface + description: Unique ID for the license group the resource belongs to, should be uuid. required: true type: string - - name: interface-name + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: Name given to the interface + description: Unique ID of a license resource. required: true type: string - - name: vlan-interface + example: __RESOURCE-UUID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses: + get: + tags: + - Network + summary: returns licenses + description: returns licenses + operationId: getNetworkGenericVnfsGenericVnfLicenses + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/licenses" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - /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: + example: __VNF-ID__ + - name: group-uuid + in: query + description: + required: false + type: string + - name: resource-uuid + in: query + description: + required: false + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship consumes: - application/json - application/xml @@ -33887,34 +35047,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vnf-id in: path - description: Name given to the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: l3-interface-ipv4-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of an entitlement resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) required: true schema: $ref: "#/definitions/relationship" @@ -33923,7 +35076,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship consumes: - application/json - application/xml @@ -33934,38 +35087,31 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vnf-id in: path - description: Name given to the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: l3-interface-ipv4-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of an entitlement resource. required: true type: string - /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}: + example: __RESOURCE-UUID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: returns entitlement + description: returns entitlement + operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement produces: - application/json - application/xml @@ -33973,93 +35119,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/entitlement" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vnf-id in: path - description: Name given to the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: l3-interface-ipv4-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of an entitlement resource. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __RESOURCE-UUID__ put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: create or update an existing entitlement + description: | + Create or update an existing entitlement. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement consumes: - application/json - application/xml @@ -34070,43 +35160,87 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name + example: __VNF-ID__ + - name: group-uuid in: path - description: Name that identifies the physical interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: interface-name + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: Name given to the interface + description: Unique ID of an entitlement resource. required: true type: string - - name: vlan-interface + example: __RESOURCE-UUID__ + - name: body + in: body + description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) + required: true + schema: + $ref: "#/definitions/entitlement" + patch: + tags: + - Network + summary: update an existing entitlement + description: | + Update an existing entitlement + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: l3-interface-ipv4-address + example: __VNF-ID__ + - name: group-uuid in: path - description: IP address + description: Unique ID for the entitlement group the resource comes from, should be uuid. + required: true + type: string + example: __GROUP-UUID__ + - name: resource-uuid + in: path + description: Unique ID of an entitlement resource. required: true type: string + example: __RESOURCE-UUID__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: entitlement object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/entitlement" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing entitlement + description: delete an existing entitlement + operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement consumes: - application/json - application/xml @@ -34117,89 +35251,135 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name + - name: vnf-id in: path - description: Name given to the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vlan-interface + example: __VNF-ID__ + - name: group-uuid in: path - description: String that identifies the interface + description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true type: string - - name: l3-interface-ipv4-address + example: __GROUP-UUID__ + - name: resource-uuid in: path - description: IP address + description: Unique ID of an entitlement resource. required: true type: string + example: __RESOURCE-UUID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: - put: + /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns entitlements + description: returns entitlements + operationId: getNetworkGenericVnfsGenericVnfEntitlements produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/entitlements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id in: path - description: unique name of Physical Network Function. + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true + example: __VNF-ID__ + - name: group-uuid + in: query + description: + required: false type: string - - name: interface-name - in: path - description: Name given to the interface - required: true + - name: resource-uuid + in: query + description: + required: false type: string - - name: vlan-interface + /network/generic-vnfs/generic-vnf/{vnf-id}: + get: + tags: + - Network + summary: returns generic-vnf + description: returns generic-vnf + operationId: getNetworkGenericVnfsGenericVnf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/generic-vnf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: l3-interface-ipv6-address + example: __VNF-ID__ + put: + tags: + - Network + summary: create or update an existing generic-vnf + description: | + Create or update an existing generic-vnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: IP address + description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/generic-vnf" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: update an existing generic-vnf + description: | + Update an existing generic-vnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkGenericVnfsGenericVnf consumes: - application/json - application/xml @@ -34210,38 +35390,52 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id in: path - description: Name that identifies the physical interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __VNF-ID__ + - name: body + in: body + description: generic-vnf object that needs to be updated. required: true - type: string - - name: vlan-interface + schema: + $ref: "#/patchDefinitions/generic-vnf" + delete: + tags: + - Network + summary: delete an existing generic-vnf + description: delete an existing generic-vnf + operationId: deleteNetworkGenericVnfsGenericVnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id in: path - description: String that identifies the interface + description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: l3-interface-ipv6-address - in: path - description: IP address + example: __VNF-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /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}: + /network/generic-vnfs: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns generic-vnfs + description: returns generic-vnfs + operationId: getNetworkGenericVnfs produces: - application/json - application/xml @@ -34249,93 +35443,106 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/generic-vnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true + - name: vnf-id + in: query + description: + required: false type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true + - name: vnf-name + in: query + description: + required: false type: string - - name: interface-name - in: path - description: Name given to the interface - required: true + - name: vnf-name2 + in: query + description: + required: false type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true + - name: vnf-type + in: query + description: + required: false type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true + - name: service-id + in: query + description: + required: false type: string - - name: inv-status + - name: regional-resource-zone in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - name: prov-status in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: required: false type: string - - name: interface-id + - name: heat-stack-id in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: in-maint + in: query + description: + required: false + type: boolean + - name: is-closed-loop-disabled + in: query + description: + required: false + type: boolean + - name: model-invariant-id in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: model-version-id in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner + - name: widget-model-id in: query - description: Inner VLAN tag + description: required: false - type: integer - format: int64 - - name: vpn-key + type: string + - name: widget-model-version in: query - description: This indicates the customers VPN ID associated with this vlan + description: required: false type: string - - name: vlan-id-inner + - name: nf-type in: query - description: Inner VLAN tag + description: required: false - type: integer - format: int64 - - name: neutron-network-id + type: string + - name: nf-function + in: query + description: + required: false + type: string + - name: nf-role in: query - description: Neutron network id of the interface that address belongs to + description: required: false type: string - - name: neutron-subnet-id + - name: nf-naming-code in: query - description: Neutron id of subnet that address belongs to + description: required: false type: string + /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship consumes: - application/json - application/xml @@ -34346,43 +35553,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address + - name: link-name in: path - description: IP address + description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship consumes: - application/json - application/xml @@ -34393,43 +35581,19 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address + - name: link-name in: path - description: IP address - required: true - type: string - - name: resource-version - in: query - description: resource-version for concurrency + description: Alphabetical concatenation of lag-interface names required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + example: __LINK-NAME__ + /network/lag-links/lag-link/{link-name}: get: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: returns lag-link + description: returns lag-link + operationId: getNetworkLagLinksLagLink produces: - application/json - application/xml @@ -34437,72 +35601,25 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/lag-link" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: link-name in: path - description: String that identifies the interface + description: Alphabetical concatenation of lag-interface names required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string + example: __LINK-NAME__ put: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: create or update an existing lag-link + description: | + Create or update an existing lag-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkLagLinksLagLink consumes: - application/json - application/xml @@ -34513,38 +35630,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: link-name in: path - description: Name that identifies the physical interface + description: Alphabetical concatenation of lag-interface names required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __LINK-NAME__ + - name: body + in: body + description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json) required: true - type: string - - name: vlan-interface + schema: + $ref: "#/definitions/lag-link" + patch: + tags: + - Network + summary: update an existing lag-link + description: | + Update an existing lag-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkLagLinksLagLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name in: path - description: String that identifies the interface + description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ - name: body in: body - description: vlan object that needs to be created or updated + description: lag-link object that needs to be updated. required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/patchDefinitions/lag-link" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing lag-link + description: delete an existing lag-link + operationId: deleteNetworkLagLinksLagLink consumes: - application/json - application/xml @@ -34555,38 +35697,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: link-name in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface + description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + /network/lag-links: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans + summary: returns lag-links + description: returns lag-links + operationId: getNetworkLagLinks produces: - application/json - application/xml @@ -34594,56 +35722,21 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/lag-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + - name: link-name in: query - description: Name of the network + description: required: false type: string - /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: + /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship consumes: - application/json - application/xml @@ -34654,29 +35747,15 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the physical interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id + - name: vnf-id2 in: path - description: PCI ID used to identify the sriov-vf + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json) required: true schema: $ref: "#/definitions/relationship" @@ -34685,7 +35764,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship consumes: - application/json - application/xml @@ -34696,115 +35775,92 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string - - name: interface-name + example: __VNF-ID2__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false - type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false - type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false - type: string + example: __VLAN-INTERFACE__ + /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: put: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -34815,38 +35871,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: pci-id + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address in: path - description: PCI ID used to identify the sriov-vf + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -34857,38 +35917,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: PCI ID used to identify the sriov-vf + description: String that identifies the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -34896,56 +35955,100 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -34956,33 +36059,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -34993,27 +36105,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - /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: + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -35024,29 +36150,33 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -35055,7 +36185,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -35066,33 +36196,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -35100,77 +36234,43 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -35181,38 +36281,53 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -35223,37 +36338,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string - - name: l3-interface-ipv4-address + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. required: true - type: string - /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: - put: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -35264,153 +36384,131 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name given to the interface + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns vlan + description: returns vlan + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - /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}: - get: + example: __VLAN-INTERFACE__ + put: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string - put: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -35421,38 +36519,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: vlan object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/vlan" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -35463,38 +36559,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: l3-interface-ipv6-address + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: IP address + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + summary: returns vlans + description: returns vlans + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -35502,56 +36596,44 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false - type: string - - name: interface-id + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: vlan-id-inner in: query - description: MAC address for the interface + description: required: false - type: string - - name: network-name + type: integer + format: int64 + - name: vpn-key in: query - description: Name of the network + description: required: false type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -35562,33 +36644,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: pci-id in: path - description: Name given to the interface + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: l-interface object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: - $ref: "#/definitions/l-interface" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -35599,33 +36684,31 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the physical interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: + example: __PCI-ID__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -35633,74 +36716,88 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interfaces" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: - get: + example: __PCI-ID__ + put: tags: - Network - summary: returns p-interface - description: returns p-interface - operationId: getNetworkPnfsPnfPInterfacesPInterface + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: prov-status - in: query - description: Trigger for operational monitoring of this resource by Service Assurance systems. - required: false + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true type: string - put: + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: tags: - Network - summary: create or update an existing p-interface - description: create or update an existing p-interface - operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -35711,28 +36808,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: p-interface object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/p-interface" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network - summary: delete an existing p-interface - description: delete an existing p-interface - operationId: deleteNetworkPnfsPnfPInterfacesPInterface + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -35743,28 +36848,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the physical interface + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/p-interfaces: + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network - summary: returns p-interfaces - description: returns p-interfaces - operationId: getNetworkPnfsPnfPInterfaces + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -35772,26 +36885,53 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interfaces" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string - - name: inv-status + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: + - name: vf-vlan-filter + in: query + description: + required: false + type: string + - name: vf-mac-filter + in: query + description: + required: false + type: string + - name: vf-vlan-strip + in: query + description: + required: false + type: boolean + - name: neutron-network-id + in: query + description: + required: false + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -35802,19 +36942,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -35823,7 +36965,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -35834,22 +36976,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: + example: __INTERFACE-NAME__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -35860,29 +37004,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: String that identifies the interface + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -35891,7 +37033,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -35902,32 +37044,69 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: String that identifies the interface + description: IP address required: true type: string - /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: + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -35938,43 +37117,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -35985,137 +37168,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /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}: - get: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: returns l3-interface-ipv4-address-list - description: returns l3-interface-ipv4-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version in: query - description: Neutron id of subnet that address belongs to - required: false + description: resource-version for concurrency + required: true type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -36126,43 +37247,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv4-address + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -36173,42 +37287,69 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Name given to the interface + description: IP address required: true type: string - - name: vlan-interface + example: __L3-INTERFACE-IPV6-ADDRESS__ + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 in: path - description: String that identifies the interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string - - name: l3-interface-ipv4-address + example: __VNF-ID2__ + - name: interface-name in: path - description: IP address + description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string - /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: + example: __L3-INTERFACE-IPV6-ADDRESS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -36219,43 +37360,87 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name + - name: vnf-id2 in: path - description: unique name of Physical Network Function. + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name given to the interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address in: path - description: Name given to the interface + description: IP address required: true type: string - - name: vlan-interface + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 in: path - description: String that identifies the interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -36266,38 +37451,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}: get: tags: - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: returns l-interface + description: returns l-interface + operationId: getNetworkNewvcesNewvceLInterfacesLInterface produces: - application/json - application/xml @@ -36305,98 +37488,31 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false - type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false - type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false - type: string + example: __INTERFACE-NAME__ put: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface consumes: - application/json - application/xml @@ -36407,43 +37523,75 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 in: path - description: String that identifies the interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string - - name: l3-interface-ipv6-address + example: __VNF-ID2__ + - name: interface-name in: path - description: IP address + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network - summary: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface consumes: - application/json - application/xml @@ -36454,43 +37602,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: l3-interface-ipv6-address - in: path - description: IP address - required: true - type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + /network/newvces/newvce/{vnf-id2}/l-interfaces: get: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkNewvcesNewvceLInterfaces produces: - application/json - application/xml @@ -36498,77 +37633,69 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface - in: path - description: String that identifies the interface - required: true - type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - name: interface-id in: query - description: ID of interface + description: required: false type: string - name: macaddr in: query - description: MAC address for the interface + description: required: false type: string - name: network-name in: query - description: Name of the network + description: required: false type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: vpn-key - in: query - description: This indicates the customers VPN ID associated with this vlan - required: false + /network/newvces/newvce/{vnf-id2}: + get: + tags: + - Network + summary: returns newvce + description: returns newvce + operationId: getNetworkNewvcesNewvce + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/newvce" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 + in: path + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + required: true type: string + example: __VNF-ID2__ put: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: create or update an existing newvce + description: | + Create or update an existing newvce. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkNewvcesNewvce consumes: - application/json - application/xml @@ -36579,38 +37706,63 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name + - name: vnf-id2 in: path - description: Name that identifies the link aggregate interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __VNF-ID2__ + - name: body + in: body + description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json) required: true - type: string - - name: vlan-interface + schema: + $ref: "#/definitions/newvce" + patch: + tags: + - Network + summary: update an existing newvce + description: | + Update an existing newvce + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkNewvcesNewvce + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vnf-id2 in: path - description: String that identifies the interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: body in: body - description: vlan object that needs to be created or updated + description: newvce object that needs to be updated. required: true schema: - $ref: "#/definitions/vlan" + $ref: "#/patchDefinitions/newvce" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing newvce + description: delete an existing newvce + operationId: deleteNetworkNewvcesNewvce consumes: - application/json - application/xml @@ -36621,38 +37773,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: vlan-interface + - name: vnf-id2 in: path - description: String that identifies the interface + description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true type: string + example: __VNF-ID2__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + /network/newvces: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + summary: returns newvces + description: returns newvces + operationId: getNetworkNewvces produces: - application/json - application/xml @@ -36660,61 +37798,46 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/newvces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: pnf-name - in: path - description: unique name of Physical Network Function. - required: true - type: string - - name: interface-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: inv-status + - name: vnf-id2 in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: interface-id + - name: vnf-name in: query - description: ID of interface + description: required: false type: string - - name: interface-role + - name: vnf-name2 in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string - - name: interface-id + - name: vnf-type in: query - description: ID of interface + description: required: false type: string - - name: macaddr + - name: prov-status in: query - description: MAC address for the interface + description: required: false type: string - - name: network-name + - name: heat-stack-id in: query - description: Name of the network + description: required: false type: string - /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: + /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship consumes: - application/json - application/xml @@ -36730,24 +37853,66 @@ paths: description: unique name of Physical Network Function. required: true type: string - - name: interface-name + example: __PNF-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name in: path - description: Name that identifies the link aggregate interface + description: unique name of Physical Network Function. required: true type: string - - name: interface-name + example: __PNF-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name in: path - description: Name given to the interface + description: unique name of Physical Network Function. required: true type: string - - name: pci-id + example: __PNF-NAME__ + - name: interface-name in: path - description: PCI ID used to identify the sriov-vf + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -36756,7 +37921,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -36772,36 +37937,26 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface - required: true - type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf + description: Name that identifies the physical interface required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: - get: + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship: + put: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36810,77 +37965,104 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: interface-name + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: Name given to the interface + description: Identifier for the sriov-pf required: true type: string - - name: pci-id + example: __PF-PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name in: path - description: PCI ID used to identify the sriov-vf + description: unique name of Physical Network Function. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string - - name: vf-vlan-filter - in: query - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - required: false + example: __PF-PCI-ID__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: + get: + tags: + - Network + summary: returns sriov-pf + description: returns sriov-pf + operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-pf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: vf-mac-filter - in: query - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: vf-vlan-strip - in: query - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - required: false - type: boolean - - name: neutron-network-id - in: query - description: Neutron network id of the interface - required: false + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true type: string + example: __PF-PCI-ID__ put: tags: - Network - summary: create or update an existing sriov-vf - description: create or update an existing sriov-vf - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: create or update an existing sriov-pf + description: | + Create or update an existing sriov-pf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf consumes: - application/json - application/xml @@ -36896,33 +38078,82 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pf-pci-id + in: path + description: Identifier for the sriov-pf + required: true + type: string + example: __PF-PCI-ID__ + - name: body + in: body + description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) + required: true + schema: + $ref: "#/definitions/sriov-pf" + patch: + tags: + - Network + summary: update an existing sriov-pf + description: | + Update an existing sriov-pf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name given to the interface + description: Name that identifies the physical interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: PCI ID used to identify the sriov-vf + description: Identifier for the sriov-pf required: true type: string + example: __PF-PCI-ID__ - name: body in: body - description: sriov-vf object that needs to be created or updated + description: sriov-pf object that needs to be updated. required: true schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/patchDefinitions/sriov-pf" delete: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing sriov-pf + description: delete an existing sriov-pf + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf consumes: - application/json - application/xml @@ -36938,33 +38169,31 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface + description: Name that identifies the physical interface required: true type: string - - name: pci-id + example: __INTERFACE-NAME__ + - name: pf-pci-id in: path - description: PCI ID used to identify the sriov-vf + description: Identifier for the sriov-pf required: true type: string + example: __PF-PCI-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + summary: returns sriov-pfs + description: returns sriov-pfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs produces: - application/json - application/xml @@ -36972,7 +38201,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/sriov-pfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36981,52 +38210,24 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: interface-name - in: path - description: Name given to the interface + description: Name that identifies the physical interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name + example: __INTERFACE-NAME__ + - name: pf-pci-id in: query - description: Name of the network + description: required: false type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -37042,19 +38243,28 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -37063,7 +38273,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -37079,22 +38289,31 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - /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: + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -37110,24 +38329,34 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -37136,7 +38365,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -37152,28 +38381,38 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network summary: returns l3-interface-ipv4-address-list description: returns l3-interface-ipv4-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -37181,7 +38420,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37190,73 +38429,103 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv4-address-list - description: create or update an existing l3-interface-ipv4-address-list - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -37272,33 +38541,43 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: l3-interface-ipv4-address-list object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv4-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv4-address-list description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -37314,32 +38593,42 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /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: + /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: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -37355,24 +38644,34 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -37381,7 +38680,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -37397,28 +38696,38 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - /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}: + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network summary: returns l3-interface-ipv6-address-list description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -37426,7 +38735,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37435,73 +38744,103 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: vlan-id-inner - in: query - description: Inner VLAN tag - required: false - type: integer - format: int64 - - name: neutron-network-id - in: query - description: Neutron network id of the interface that address belongs to - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: neutron-subnet-id - in: query - description: Neutron id of subnet that address belongs to - required: false + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true type: string - put: + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -37517,33 +38856,43 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network summary: delete an existing l3-interface-ipv6-address-list description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -37559,33 +38908,43 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -37593,7 +38952,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37602,52 +38961,34 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: interface-role - in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false - type: string - - name: interface-id - in: query - description: ID of interface - required: false - type: string - - name: macaddr - in: query - description: MAC address for the interface - required: false - type: string - - name: network-name - in: query - description: Name of the network - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string + example: __VLAN-INTERFACE__ put: tags: - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -37663,28 +39004,48 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: l-interface object that needs to be created or updated + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/l-interface" - delete: + $ref: "#/definitions/vlan" + patch: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -37700,36 +39061,44 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: - get: + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37738,33 +39107,37 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: interface-id - in: query - description: ID of interface - required: false + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true type: string - - name: interface-role + example: __VLAN-INTERFACE__ + - name: resource-version in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - required: false + description: resource-version for concurrency + required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network - summary: returns lag-interface - description: returns lag-interface - operationId: getNetworkPnfsPnfLagInterfacesLagInterface + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -37772,7 +39145,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interface" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37781,32 +39154,41 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: inv-status + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: required: false type: string - - name: interface-id + - name: vlan-id-inner in: query - description: ID of interface + description: required: false - type: string - - name: interface-role + type: integer + format: int64 + - name: vpn-key in: query - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + description: required: false type: string + /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: put: tags: - Network - summary: create or update an existing lag-interface - description: create or update an existing lag-interface - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -37822,23 +39204,37 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: body in: body - description: lag-interface object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: - $ref: "#/definitions/lag-interface" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing lag-interface - description: delete an existing lag-interface - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -37854,23 +39250,32 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: interface-name in: path - description: Name that identifies the link aggregate interface + description: Name that identifies the physical interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string - /network/pnfs/pnf/{pnf-name}/lag-interfaces: + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - Network - summary: returns lag-interfaces - description: returns lag-interfaces - operationId: getNetworkPnfsPnfLagInterfaces + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -37878,7 +39283,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37887,26 +39292,41 @@ paths: description: unique name of Physical Network Function. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - /network/pnfs/pnf/{pnf-name}: - get: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + put: tags: - Network - summary: returns pnf - description: returns pnf - operationId: getNetworkPnfsPnf + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/pnf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -37915,17 +39335,48 @@ paths: description: unique name of Physical Network Function. required: true type: string - - name: inv-status - in: query - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - required: false + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true type: string - put: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: tags: - Network - summary: create or update an existing pnf - description: create or update an existing pnf - operationId: createOrUpdateNetworkPnfsPnf + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -37941,18 +39392,37 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ - name: body in: body - description: pnf object that needs to be created or updated + description: sriov-vf object that needs to be updated. required: true schema: - $ref: "#/definitions/pnf" + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network - summary: delete an existing pnf - description: delete an existing pnf - operationId: deleteNetworkPnfsPnf + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf consumes: - application/json - application/xml @@ -37968,18 +39438,37 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/pnfs: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network - summary: returns pnfs - description: returns pnfs - operationId: getNetworkPnfs + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs produces: - application/json - application/xml @@ -37987,15 +39476,59 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/pnfs" + $ref: "#/getDefinitions/sriov-vfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/physical-links/physical-link/{link-name}/relationship-list/relationship: + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: query + description: + required: false + type: string + - name: vf-vlan-filter + in: query + description: + required: false + type: string + - name: vf-mac-filter + in: query + description: + required: false + type: string + - name: vf-vlan-strip + in: query + description: + required: false + type: boolean + - name: neutron-network-id + in: query + description: + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -38006,14 +39539,27 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: pnf-name in: path - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -38022,7 +39568,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -38033,45 +39579,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: pnf-name in: path - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + description: unique name of Physical Network Function. required: true type: string - /network/physical-links/physical-link/{link-name}: - get: - tags: - - Network - summary: returns physical-link - description: returns physical-link - operationId: getNetworkPhysicalLinksPhysicalLink - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/physical-link" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: link-name + example: __PNF-NAME__ + - name: interface-name in: path - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + description: Name that identifies the physical interface required: true type: string - - name: circuit-id - in: query - description: Circuit it - required: false + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string + example: __INTERFACE-NAME__ + /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: put: tags: - Network - summary: create or update an existing physical-link - description: create or update an existing physical-link - operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -38082,23 +39613,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: pnf-name in: path - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: physical-link object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/physical-link" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing physical-link - description: delete an existing physical-link - operationId: deleteNetworkPhysicalLinksPhysicalLink + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -38109,23 +39659,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: link-name + - name: pnf-name in: path - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + description: unique name of Physical Network Function. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface required: true type: string - /network/physical-links: + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: get: tags: - Network - summary: returns physical-links - description: returns physical-links - operationId: getNetworkPhysicalLinks + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList produces: - application/json - application/xml @@ -38133,15 +39697,43 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/physical-links" + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -38152,23 +39744,53 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -38179,49 +39801,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. required: true type: string - /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship: - put: - tags: - - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: ipsec-configuration-id + example: __PNF-NAME__ + - name: interface-name in: path - description: UUID of this configuration + description: Name that identifies the physical interface required: true type: string - - name: vig-address-type + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: indicates whether the VIG is for AVPN or INTERNET + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: body in: body - description: relationship object that needs to be created or updated + description: l3-interface-ipv4-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -38232,50 +39847,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. required: true type: string - - name: vig-address-type + example: __PNF-NAME__ + - name: interface-name in: path - description: indicates whether the VIG is for AVPN or INTERNET + description: Name that identifies the physical interface required: true type: string - /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}: - get: - tags: - - Network - summary: returns vig-server - description: returns vig-server - operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/vig-server" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: ipsec-configuration-id + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: UUID of this configuration + description: Name given to the interface required: true type: string - - name: vig-address-type + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address in: path - description: indicates whether the VIG is for AVPN or INTERNET + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string + /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: put: tags: - Network - summary: create or update an existing vig-server - description: create or update an existing vig-server - operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -38286,28 +39892,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. required: true type: string - - name: vig-address-type + example: __PNF-NAME__ + - name: interface-name in: path - description: indicates whether the VIG is for AVPN or INTERNET + description: Name that identifies the physical interface required: true type: string - - name: body - in: body - description: vig-server object that needs to be created or updated + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/vig-server" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vig-server - description: delete an existing vig-server - operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -38318,28 +39938,37 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. required: true type: string - - name: vig-address-type + example: __PNF-NAME__ + - name: interface-name in: path - description: indicates whether the VIG is for AVPN or INTERNET + description: Name that identifies the physical interface required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string - /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers: + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns vig-servers - description: returns vig-servers - operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -38347,44 +39976,100 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vig-servers" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. required: true type: string - /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: - get: + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: tags: - Network - summary: returns ipsec-configuration - description: returns ipsec-configuration - operationId: getNetworkIpsecConfigurationsIpsecConfiguration + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/ipsec-configuration" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. required: true type: string - put: + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: create or update an existing ipsec-configuration - description: create or update an existing ipsec-configuration - operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -38395,23 +40080,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: body in: body - description: ipsec-configuration object that needs to be created or updated + description: l3-interface-ipv6-address-list object that needs to be updated. required: true schema: - $ref: "#/definitions/ipsec-configuration" + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing ipsec-configuration - description: delete an existing ipsec-configuration - operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -38422,23 +40126,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: ipsec-configuration-id + - name: pnf-name in: path - description: UUID of this configuration + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/ipsec-configurations: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network - summary: returns ipsec-configurations - description: returns ipsec-configurations - operationId: getNetworkIpsecConfigurations + summary: returns l-interface + description: returns l-interface + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface produces: - application/json - application/xml @@ -38446,15 +40169,37 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ipsec-configurations" + $ref: "#/getDefinitions/l-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -38465,23 +40210,47 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: route-table-reference-id + - name: pnf-name in: path - description: Route Table Reference id, UUID assigned to this instance. + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: - $ref: "#/definitions/relationship" - delete: + $ref: "#/definitions/l-interface" + patch: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -38492,72 +40261,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: route-table-reference-id + - name: pnf-name in: path - description: Route Table Reference id, UUID assigned to this instance. + description: unique name of Physical Network Function. required: true type: string - /network/route-table-references/route-table-reference/{route-table-reference-id}: - get: - tags: - - Network - summary: returns route-table-reference - description: returns route-table-reference - operationId: getNetworkRouteTableReferencesRouteTableReference - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/route-table-reference" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: route-table-reference-id + example: __PNF-NAME__ + - name: interface-name in: path - description: Route Table Reference id, UUID assigned to this instance. + description: Name that identifies the physical interface required: true type: string - - name: route-table-reference-fqdn - in: query - description: FQDN entry in the route table. - required: false - type: string - put: - tags: - - Network - summary: create or update an existing route-table-reference - description: create or update an existing route-table-reference - operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: route-table-reference-id + example: __INTERFACE-NAME__ + - name: interface-name in: path - description: Route Table Reference id, UUID assigned to this instance. + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: route-table-reference object that needs to be created or updated + description: l-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/route-table-reference" + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network - summary: delete an existing route-table-reference - description: delete an existing route-table-reference - operationId: deleteNetworkRouteTableReferencesRouteTableReference + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface consumes: - application/json - application/xml @@ -38568,23 +40301,36 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: route-table-reference-id + - name: pnf-name in: path - description: Route Table Reference id, UUID assigned to this instance. + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/route-table-references: + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: get: tags: - Network - summary: returns route-table-references - description: returns route-table-references - operationId: getNetworkRouteTableReferences + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces produces: - application/json - application/xml @@ -38592,42 +40338,81 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/route-table-references" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/instance-groups/instance-group/{id}/relationship-list/relationship: - put: + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: + get: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship - consumes: - - application/json - - application/xml + summary: returns p-interface + description: returns p-interface + operationId: getNetworkPnfsPnfPInterfacesPInterface produces: - application/json - application/xml responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: id + - name: pnf-name in: path - description: Instance Group ID, UUID assigned to this instance. + description: unique name of Physical Network Function. required: true type: string - - name: body - in: body - description: relationship object that needs to be created or updated + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface required: true - schema: - $ref: "#/definitions/relationship" - delete: + type: string + example: __INTERFACE-NAME__ + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + summary: create or update an existing p-interface + description: | + Create or update an existing p-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface consumes: - application/json - application/xml @@ -38638,55 +40423,41 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: id + - name: pnf-name in: path - description: Instance Group ID, UUID assigned to this instance. + description: unique name of Physical Network Function. required: true type: string - /network/instance-groups/instance-group/{id}: - get: - tags: - - Network - summary: returns instance-group - description: returns instance-group - operationId: getNetworkInstanceGroupsInstanceGroup - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/instance-group" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: id + example: __PNF-NAME__ + - name: interface-name in: path - description: Instance Group ID, UUID assigned to this instance. + description: Name that identifies the physical interface required: true type: string - - name: description - in: query - description: Descriptive text to help identify the usage of this instance-group - required: false - type: string - - name: type - in: query - description: Only valid value today is lower case ha for high availability - required: false - type: string - - name: sub-type - in: query - description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] - required: false - type: string - put: + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json) + required: true + schema: + $ref: "#/definitions/p-interface" + patch: tags: - Network - summary: create or update an existing instance-group - description: create or update an existing instance-group - operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup + summary: update an existing p-interface + description: | + Update an existing p-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfPInterfacesPInterface consumes: - application/json - application/xml @@ -38697,23 +40468,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: id + - name: pnf-name in: path - description: Instance Group ID, UUID assigned to this instance. + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: instance-group object that needs to be created or updated + description: p-interface object that needs to be updated. required: true schema: - $ref: "#/definitions/instance-group" + $ref: "#/patchDefinitions/p-interface" delete: tags: - Network - summary: delete an existing instance-group - description: delete an existing instance-group - operationId: deleteNetworkInstanceGroupsInstanceGroup + summary: delete an existing p-interface + description: delete an existing p-interface + operationId: deleteNetworkPnfsPnfPInterfacesPInterface consumes: - application/json - application/xml @@ -38724,23 +40502,30 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: id + - name: pnf-name in: path - description: Instance Group ID, UUID assigned to this instance. + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the physical interface required: true type: string + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/instance-groups: + /network/pnfs/pnf/{pnf-name}/p-interfaces: get: tags: - Network - summary: returns instance-groups - description: returns instance-groups - operationId: getNetworkInstanceGroups + summary: returns p-interfaces + description: returns p-interfaces + operationId: getNetworkPnfsPnfPInterfaces produces: - application/json - application/xml @@ -38748,15 +40533,32 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/instance-groups" + $ref: "#/getDefinitions/p-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). - /network/zones/zone/{zone-id}/relationship-list/relationship: + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: query + description: + required: false + type: string + - name: prov-status + in: query + description: + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: see node definition for valid relationships - operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -38767,14 +40569,21 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: zone-id + - name: pnf-name in: path - description: Code assigned by AIC to the zone + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface required: true type: string + example: __INTERFACE-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -38783,7 +40592,7 @@ paths: - Network summary: delete an existing relationship description: delete an existing relationship - operationId: deleteNetworkZonesZoneRelationshipListRelationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship consumes: - application/json - application/xml @@ -38794,50 +40603,24 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: zone-id + - name: pnf-name in: path - description: Code assigned by AIC to the zone + description: unique name of Physical Network Function. required: true type: string - /network/zones/zone/{zone-id}: - get: - tags: - - Network - summary: returns zone - description: returns zone - operationId: getNetworkZonesZone - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/zone" - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: zone-id + example: __PNF-NAME__ + - name: interface-name in: path - description: Code assigned by AIC to the zone + description: Name that identifies the link aggregate interface required: true type: string - - name: design-type - in: query - description: Design of zone [Medium/Large?] - required: false - type: string - - name: zone-context - in: query - description: Context of zone [production/test] - required: false - type: string + example: __INTERFACE-NAME__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: - Network - summary: create or update an existing zone - description: create or update an existing zone - operationId: createOrUpdateNetworkZonesZone + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -38848,23 +40631,42 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: zone-id + - name: pnf-name in: path - description: Code assigned by AIC to the zone + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: body in: body - description: zone object that needs to be created or updated + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/zone" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing zone - description: delete an existing zone - operationId: deleteNetworkZonesZone + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship consumes: - application/json - application/xml @@ -38875,23 +40677,450 @@ paths: "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: - - name: zone-id + - name: pnf-name in: path - description: Code assigned by AIC to the zone + description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + /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: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: resource-version in: query description: resource-version for concurrency required: true type: string - /network/zones: + /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: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: get: tags: - Network - summary: returns zones - description: returns zones - operationId: getNetworkZones + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -38899,133 +41128,14038 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/zones" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). -definitions: - search: + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: + get: + tags: + - Network + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlan" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + put: + tags: + - Network + summary: create or update an existing vlan + description: | + Create or update an existing vlan. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) + required: true + schema: + $ref: "#/definitions/vlan" + patch: + tags: + - Network + summary: update an existing vlan + description: | + Update an existing vlan + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: body + in: body + description: vlan object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: + get: + tags: + - Network + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vlans" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: vlan-interface + in: query + description: + required: false + type: string + - name: vlan-id-inner + in: query + description: + required: false + type: integer + format: int64 + - name: vpn-key + in: query + description: + required: false + type: string + /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: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + get: + tags: + - Network + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + put: + tags: + - Network + summary: create or update an existing sriov-vf + description: | + Create or update an existing sriov-vf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/sriov-vf" + patch: + tags: + - Network + summary: update an existing sriov-vf + description: | + Update an existing sriov-vf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: body + in: body + description: sriov-vf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/sriov-vfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: pci-id + in: query + description: + required: false + type: string + - name: vf-vlan-filter + in: query + description: + required: false + type: string + - name: vf-mac-filter + in: query + description: + required: false + type: string + - name: vf-vlan-strip + in: query + description: + required: false + type: boolean + - name: neutron-network-id + in: query + description: + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + /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: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + /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}: + get: + tags: + - Network + summary: returns l3-interface-ipv4-address-list + description: returns l3-interface-ipv4-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv4-address-list + description: | + Create or update an existing l3-interface-ipv4-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv4-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv4-address-list + description: | + Update an existing l3-interface-ipv4-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv4-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv4-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /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: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + /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}: + get: + tags: + - Network + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + put: + tags: + - Network + summary: create or update an existing l3-interface-ipv6-address-list + description: | + Create or update an existing l3-interface-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - Network + summary: update an existing l3-interface-ipv6-address-list + description: | + Update an existing l3-interface-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - Network + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: l3-interface-ipv6-address + in: path + description: IP address + required: true + type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + put: + tags: + - Network + summary: create or update an existing l-interface + description: | + Create or update an existing l-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) + required: true + schema: + $ref: "#/definitions/l-interface" + patch: + tags: + - Network + summary: update an existing l-interface + description: | + Update an existing l-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: l-interface object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: path + description: Name given to the interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: + get: + tags: + - Network + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/l-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: macaddr + in: query + description: + required: false + type: string + - name: network-name + in: query + description: + required: false + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: + get: + tags: + - Network + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkPnfsPnfLagInterfacesLagInterface + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interface" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + put: + tags: + - Network + summary: create or update an existing lag-interface + description: | + Create or update an existing lag-interface. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json) + required: true + schema: + $ref: "#/definitions/lag-interface" + patch: + tags: + - Network + summary: update an existing lag-interface + description: | + Update an existing lag-interface + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: lag-interface object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" + delete: + tags: + - Network + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: path + description: Name that identifies the link aggregate interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs/pnf/{pnf-name}/lag-interfaces: + get: + tags: + - Network + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkPnfsPnfLagInterfaces + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/lag-interfaces" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: interface-name + in: query + description: + required: false + type: string + - name: interface-id + in: query + description: + required: false + type: string + - name: interface-role + in: query + description: + required: false + type: string + /network/pnfs/pnf/{pnf-name}: + get: + tags: + - Network + summary: returns pnf + description: returns pnf + operationId: getNetworkPnfsPnf + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pnf" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + put: + tags: + - Network + summary: create or update an existing pnf + description: | + Create or update an existing pnf. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json) + required: true + schema: + $ref: "#/definitions/pnf" + patch: + tags: + - Network + summary: update an existing pnf + description: | + Update an existing pnf + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: body + in: body + description: pnf object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/pnf" + delete: + tags: + - Network + summary: delete an existing pnf + description: delete an existing pnf + operationId: deleteNetworkPnfsPnf + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: path + description: unique name of Physical Network Function. + required: true + type: string + example: __PNF-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/pnfs: + get: + tags: + - Network + summary: returns pnfs + description: returns pnfs + operationId: getNetworkPnfs + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/pnfs" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: pnf-name + in: query + description: + required: false + type: string + - name: inv-status + in: query + description: + required: false + type: string + /network/physical-links/physical-link/{link-name}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + /network/physical-links/physical-link/{link-name}: + get: + tags: + - Network + summary: returns physical-link + description: returns physical-link + operationId: getNetworkPhysicalLinksPhysicalLink + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/physical-link" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + put: + tags: + - Network + summary: create or update an existing physical-link + description: | + Create or update an existing physical-link. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json) + required: true + schema: + $ref: "#/definitions/physical-link" + patch: + tags: + - Network + summary: update an existing physical-link + description: | + Update an existing physical-link + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: physical-link object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/physical-link" + delete: + tags: + - Network + summary: delete an existing physical-link + description: delete an existing physical-link + operationId: deleteNetworkPhysicalLinksPhysicalLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: path + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/physical-links: + get: + tags: + - Network + summary: returns physical-links + description: returns physical-links + operationId: getNetworkPhysicalLinks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/physical-links" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: link-name + in: query + description: + required: false + type: string + - name: circuit-id + in: query + description: + required: false + type: string + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}: + get: + tags: + - Network + summary: returns vig-server + description: returns vig-server + operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vig-server" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + put: + tags: + - Network + summary: create or update an existing vig-server + description: | + Create or update an existing vig-server. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) + required: true + schema: + $ref: "#/definitions/vig-server" + patch: + tags: + - Network + summary: update an existing vig-server + description: | + Update an existing vig-server + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: body + in: body + description: vig-server object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/vig-server" + delete: + tags: + - Network + summary: delete an existing vig-server + description: delete an existing vig-server + operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: path + description: indicates whether the VIG is for AVPN or INTERNET + required: true + type: string + example: __VIG-ADDRESS-TYPE__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers: + get: + tags: + - Network + summary: returns vig-servers + description: returns vig-servers + operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vig-servers" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: vig-address-type + in: query + description: + required: false + type: string + /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: + get: + tags: + - Network + summary: returns ipsec-configuration + description: returns ipsec-configuration + operationId: getNetworkIpsecConfigurationsIpsecConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ipsec-configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + put: + tags: + - Network + summary: create or update an existing ipsec-configuration + description: | + Create or update an existing ipsec-configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json) + required: true + schema: + $ref: "#/definitions/ipsec-configuration" + patch: + tags: + - Network + summary: update an existing ipsec-configuration + description: | + Update an existing ipsec-configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: body + in: body + description: ipsec-configuration object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/ipsec-configuration" + delete: + tags: + - Network + summary: delete an existing ipsec-configuration + description: delete an existing ipsec-configuration + operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: path + description: UUID of this configuration + required: true + type: string + example: __IPSEC-CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/ipsec-configurations: + get: + tags: + - Network + summary: returns ipsec-configurations + description: returns ipsec-configurations + operationId: getNetworkIpsecConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/ipsec-configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: ipsec-configuration-id + in: query + description: + required: false + type: string + /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + /network/route-table-references/route-table-reference/{route-table-reference-id}: + get: + tags: + - Network + summary: returns route-table-reference + description: returns route-table-reference + operationId: getNetworkRouteTableReferencesRouteTableReference + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-table-reference" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + put: + tags: + - Network + summary: create or update an existing route-table-reference + description: | + Create or update an existing route-table-reference. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json) + required: true + schema: + $ref: "#/definitions/route-table-reference" + patch: + tags: + - Network + summary: update an existing route-table-reference + description: | + Update an existing route-table-reference + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: body + in: body + description: route-table-reference object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/route-table-reference" + delete: + tags: + - Network + summary: delete an existing route-table-reference + description: delete an existing route-table-reference + operationId: deleteNetworkRouteTableReferencesRouteTableReference + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __ROUTE-TABLE-REFERENCE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/route-table-references: + get: + tags: + - Network + summary: returns route-table-references + description: returns route-table-references + operationId: getNetworkRouteTableReferences + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/route-table-references" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: route-table-reference-id + in: query + description: + required: false + type: string + - name: route-table-reference-fqdn + in: query + description: + required: false + type: string + /network/instance-groups/instance-group/{id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + /network/instance-groups/instance-group/{id}: + get: + tags: + - Network + summary: returns instance-group + description: returns instance-group + operationId: getNetworkInstanceGroupsInstanceGroup + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/instance-group" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + put: + tags: + - Network + summary: create or update an existing instance-group + description: | + Create or update an existing instance-group. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json) + required: true + schema: + $ref: "#/definitions/instance-group" + patch: + tags: + - Network + summary: update an existing instance-group + description: | + Update an existing instance-group + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: instance-group object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/instance-group" + delete: + tags: + - Network + summary: delete an existing instance-group + description: delete an existing instance-group + operationId: deleteNetworkInstanceGroupsInstanceGroup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: path + description: Instance Group ID, UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/instance-groups: + get: + tags: + - Network + summary: returns instance-groups + description: returns instance-groups + operationId: getNetworkInstanceGroups + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/instance-groups" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: id + in: query + description: + required: false + type: string + - name: description + in: query + description: + required: false + type: string + - name: type + in: query + description: + required: false + type: string + - name: sub-type + in: query + description: + required: false + type: string + /network/zones/zone/{zone-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkZonesZoneRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + /network/zones/zone/{zone-id}: + get: + tags: + - Network + summary: returns zone + description: returns zone + operationId: getNetworkZonesZone + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/zone" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + put: + tags: + - Network + summary: create or update an existing zone + description: | + Create or update an existing zone. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json) + required: true + schema: + $ref: "#/definitions/zone" + patch: + tags: + - Network + summary: update an existing zone + description: | + Update an existing zone + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: body + in: body + description: zone object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/zone" + delete: + tags: + - Network + summary: delete an existing zone + description: delete an existing zone + operationId: deleteNetworkZonesZone + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: path + description: Code assigned by AIC to the zone + required: true + type: string + example: __ZONE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/zones: + get: + tags: + - Network + summary: returns zones + description: returns zones + operationId: getNetworkZones + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/zones" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: zone-id + in: query + description: + required: false + type: string + - name: design-type + in: query + description: + required: false + type: string + - name: zone-context + in: query + description: + required: false + type: string + /network/configurations/configuration/{configuration-id}/relationship-list/relationship: + put: + tags: + - Network + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}: + get: + tags: + - Network + summary: returns metadatum + description: returns metadatum + operationId: getNetworkConfigurationsConfigurationMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + put: + tags: + - Network + summary: create or update an existing metadatum + description: | + Create or update an existing metadatum. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json) + required: true + schema: + $ref: "#/definitions/metadatum" + patch: + tags: + - Network + summary: update an existing metadatum + description: | + Update an existing metadatum + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" + delete: + tags: + - Network + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations/configuration/{configuration-id}/metadata: + get: + tags: + - Network + summary: returns metadata + description: returns metadata + operationId: getNetworkConfigurationsConfigurationMetadata + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadata" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: metaname + in: query + description: + required: false + type: string + /network/configurations/configuration/{configuration-id}: + get: + tags: + - Network + summary: returns configuration + description: returns configuration + operationId: getNetworkConfigurationsConfiguration + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/configuration" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + put: + tags: + - Network + summary: create or update an existing configuration + description: | + Create or update an existing configuration. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json) + required: true + schema: + $ref: "#/definitions/configuration" + patch: + tags: + - Network + summary: update an existing configuration + description: | + Update an existing configuration + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: body + in: body + description: configuration object that needs to be updated. + required: true + schema: + $ref: "#/patchDefinitions/configuration" + delete: + tags: + - Network + summary: delete an existing configuration + description: delete an existing configuration + operationId: deleteNetworkConfigurationsConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: path + description: UUID assigned to configuration. + required: true + type: string + example: __CONFIGURATION-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/configurations: + get: + tags: + - Network + summary: returns configurations + description: returns configurations + operationId: getNetworkConfigurations + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/configurations" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: configuration-id + in: query + description: + required: false + type: string + - name: model-invariant-id + in: query + description: + required: false + type: string + - name: model-version-id + in: query + description: + required: false + type: string +definitions: + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/definitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/definitions/update" + notify: + type: object + $ref: "#/definitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Concurrency value + orchestration-status: + type: string + description: Orchestration status + operational-status: + type: string + description: Indicator for whether the resource is considered operational + type: + type: string + description: Generic description of the type of allotted resource. + role: + type: string + description: role in the network that this resource will be providing. + tunnel-xconnects: + type: array + items: + $ref: "#/definitions/tunnel-xconnect" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/definitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/definitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/definitions/dvs-switches" + availability-zone: + type: object + $ref: "#/definitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/definitions/connector" + customers: + type: array + items: + $ref: "#/definitions/customer" + lines-of-business: + type: array + items: + $ref: "#/definitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/definitions/owning-entity" + platforms: + type: array + items: + $ref: "#/definitions/platform" + projects: + type: array + items: + $ref: "#/definitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/definitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/definitions/complex" + cloud-regions: + type: array + items: + $ref: "#/definitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/definitions/network-profile" + pservers: + type: array + items: + $ref: "#/definitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/definitions/virtual-data-center" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. + ###### Related Nodes + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volume-groups: + type: array + items: + $ref: "#/definitions/volume-group" + tenants: + type: array + items: + $ref: "#/definitions/tenant" + flavors: + type: array + items: + $ref: "#/definitions/flavor" + group-assignments: + type: array + items: + $ref: "#/definitions/group-assignment" + snapshots: + type: array + items: + $ref: "#/definitions/snapshot" + images: + type: array + items: + $ref: "#/definitions/image" + dvs-switches: + type: array + items: + $ref: "#/definitions/dvs-switch" + oam-networks: + type: array + items: + $ref: "#/definitions/oam-network" + availability-zones: + type: array + items: + $ref: "#/definitions/availability-zone" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + esr-system-info-list: + type: array + items: + $ref: "#/definitions/esr-system-info" + vip-ipv4-address-list: + type: array + items: + $ref: "#/definitions/vip-ipv4-address-list" + vip-ipv6-address-list: + type: array + items: + $ref: "#/definitions/vip-ipv6-address-list" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/definitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + physical-location-type: + type: string + description: Type, e.g., central office, data center. + street1: + type: string + street2: + type: string + city: + type: string + state: + type: string + postal-code: + type: string + country: + type: string + region: + type: string + latitude: + type: string + longitude: + type: string + elevation: + type: string + lata: + type: string + ctag-pools: + type: array + items: + $ref: "#/definitions/ctag-pool" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/definitions/complex" + configuration: + description: | + Port Mirror Configuration. + ###### Related Nodes + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also + required: + - configuration-id + - configuration-type + - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/definitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/definitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + resource-version: + type: string + element-choice-sets: + type: array + items: + $ref: "#/definitions/element-choice-set" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/definitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/definitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/definitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-subscriptions: + type: array + items: + $ref: "#/definitions/service-subscription" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/definitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/definitions/cvlan-tag-entry" + dvs-switch: + description: | + 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. + ###### Related Nodes + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/definitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/definitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/definitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/definitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + resource-version: + type: string + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/definitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/definitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1) + + -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/definitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4) + - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) + - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) + - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/definitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY) + - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1) + + -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/definitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) + + -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/definitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/definitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + evcs: + properties: + evc: + type: array + items: + $ref: "#/definitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/definitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/definitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/definitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/definitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/definitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/definitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/definitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: the self link for this FP + forwarders: + type: array + items: + $ref: "#/definitions/forwarder" + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/definitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also + required: + - vnf-id + - vnf-name + - vnf-type + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + 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 + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + is-closed-loop-disabled: + type: boolean + description: used to indicate whether closed loop function is enabled on this node + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + summary-status: + type: string + description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether generic-vnf access uses SSH + entitlement-assignment-group-uuid: + type: string + description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. + entitlement-resource-uuid: + type: string + description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. + license-assignment-group-uuid: + type: string + description: UUID of the license assignment group. OBSOLETE - See child relationships. + license-key-uuid: + type: string + description: UUID of the actual license resource. OBSOLETE - See child relationships. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + as-number: + type: string + description: as-number of the VNF + regional-resource-subzone: + type: string + description: represents sub zone of the rr plane + nf-type: + type: string + description: Generic description of the type of NF + nf-function: + type: string + description: English description of Network function that the specific VNF deployment is providing + nf-role: + type: string + description: role in the network that this model will be providing + nf-naming-code: + type: string + description: string assigned to this model used for naming purposes + selflink: + type: string + description: Path to the controller object. + ipv4-oam-gateway-address: + type: string + description: Gateway address + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for S-TAG to get to VCE + nm-profile-name: + type: string + description: Network Management profile of this VNF + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + vf-modules: + type: array + items: + $ref: "#/definitions/vf-module" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/definitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/definitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/definitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/definitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + architecture: + type: string + description: Hardware architecture + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + hpa-feature-attributes: + type: array + items: + $ref: "#/definitions/hpa-feature-attributes" + hpa-feature-attributes: + description: | + HPA Capability Feature attributes + ###### Related Nodes + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also + required: + - hpa-attribute-key + properties: + hpa-attribute-key: + type: string + description: name of the specific HPA attribute + hpa-attribute-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/definitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/definitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + + required: + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/definitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/definitions/search" + actions: + type: object + $ref: "#/definitions/actions" + cloud-infrastructure: + type: object + $ref: "#/definitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/definitions/external-system" + business: + type: object + $ref: "#/definitions/business" + service-design-and-creation: + type: object + $ref: "#/definitions/service-design-and-creation" + network: + type: object + $ref: "#/definitions/network" + nodes: + type: object + $ref: "#/definitions/nodes" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/definitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/definitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/definitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/definitions/inventory-response-item" + ipsec-configuration: + description: | + 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 + ###### Related Nodes + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vig-servers: + type: array + items: + $ref: "#/definitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/definitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + description: boolean indicatating whether or not port is a mirrored. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + prov-status: + type: string + description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. + allowed-address-pairs: + type: string + description: Freeform field for storing an ip address, list of ip addresses or a subnet block. + vlans: + type: array + items: + $ref: "#/definitions/vlan" + sriov-vfs: + type: array + items: + $ref: "#/definitions/sriov-vf" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/definitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + description: Set to true if bound to VPN + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + contrail-network-fqdn: + type: string + description: Contrail FQDN for the network + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + physical-network-name: + type: string + description: Name associated with the physical network. + is-provider-network: + type: boolean + description: boolean indicatating whether or not network is a provider network. + is-shared-network: + type: boolean + description: boolean indicatating whether or not network is a shared network. + is-external-network: + type: boolean + description: boolean indicatating whether or not network is an external network. + selflink: + type: string + description: Path to the controller object. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + subnets: + type: array + items: + $ref: "#/definitions/subnet" + ctag-assignments: + type: array + items: + $ref: "#/definitions/ctag-assignment" + segmentation-assignments: + type: array + items: + $ref: "#/definitions/segmentation-assignment" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/definitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + interface-id: + type: string + description: ID of interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/definitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/definitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/definitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/definitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + operational-status: + type: string + description: Indication of operational status of the logical link. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: + type: string + description: Indication of the network use of the logical link. + link-name2: + type: string + description: Alias or alternate name (CLCI or D1 name). + link-id: + type: string + description: UUID of the logical-link, SDNC generates this. + circuit-id: + type: string + description: Circuit id + purpose: + type: string + description: Reason for this entity, role it is playing + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/definitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/definitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: array + items: + $ref: "#/definitions/model-ver" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/definitions/query-parameters" + instance-filters: + type: object + $ref: "#/definitions/instance-filters" + secondary-filts: + type: object + $ref: "#/definitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/definitions/constrained-element-set" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/definitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + description: Defines how other models combine to make up a higher-level model + model-constraints: + type: array + items: + $ref: "#/definitions/model-constraint" + description: Describes new constraints on this model element that are not part of that model's definition + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/definitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-elements: + type: array + items: + $ref: "#/definitions/model-element" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/definitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/definitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/definitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/definitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + resource-version: + type: string + named-query-elements: + type: array + items: + $ref: "#/definitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + resource-version: + type: string + property-limit-desc: + type: string + do-not-output: + type: string + named-query-elements: + type: array + items: + $ref: "#/definitions/named-query-element" + related-lookups: + type: array + items: + $ref: "#/definitions/related-lookup" + property-constraints: + type: array + items: + $ref: "#/definitions/property-constraint" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/definitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/definitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/definitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/definitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/definitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/definitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/definitions/vce" + vnfcs: + type: array + items: + $ref: "#/definitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/definitions/l3-network" + network-policies: + type: array + items: + $ref: "#/definitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/definitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/definitions/lag-link" + newvces: + type: array + items: + $ref: "#/definitions/newvce" + pnfs: + type: array + items: + $ref: "#/definitions/pnf" + physical-links: + type: array + items: + $ref: "#/definitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/definitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/definitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/definitions/instance-group" + zones: + type: array + items: + $ref: "#/definitions/zone" + configurations: + type: array + items: + $ref: "#/definitions/configurations" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/definitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/definitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + 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). + equipment-role: + type: string + description: Client should send valid enumerated value. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO. + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/definitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/definitions/inventory-item-data" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/definitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/definitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/definitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/definitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: + type: object + $ref: "#/definitions/model-vers" + relationship-list: + type: object + $ref: "#/definitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/definitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + inv-status: + type: string + description: inventory status + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-pfs: + type: array + items: + $ref: "#/definitions/sriov-pf" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/definitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/definitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/definitions/platform" + pnf: + description: | + 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. + ###### Related Nodes + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY) + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + nf-role: + type: string + description: Nf Role is the role performed by this instance in the network. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/definitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + port-group-id: + type: string + description: Unique ID for port group in vmware + port-group-name: + type: string + description: Likely to duplicate value of neutron network name + switch-name: + type: string + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + cvlan-tags: + type: array + items: + $ref: "#/definitions/cvlan-tag-entry" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/definitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project Uses service-instance, ONE2MANY) + + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/definitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + resource-version: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/definitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + pserver-name2: + type: string + description: alternative pserver name + purpose: + type: string + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + management-option: + type: string + description: Indicates who owns and or manages the device. + host-profile: + type: string + description: The host profile that defines the configuration of the pserver. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/definitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/definitions/named-query" + overloaded-model: + type: object + $ref: "#/definitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + resource-version: + type: string + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/definitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/definitions/relationship-data" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/definitions/relationship" + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/definitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/definitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/definitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + site-pairs: + type: array + items: + $ref: "#/definitions/site-pair" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/definitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/definitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/definitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/definitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/definitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/definitions/search-results" + sdn-zone-response: + type: object + $ref: "#/definitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/definitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/definitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/definitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-version: + type: string + description: service version + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/definitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + 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. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/definitions/vnf-image" + services: + type: array + items: + $ref: "#/definitions/service" + service-capabilities: + type: array + items: + $ref: "#/definitions/service-capability" + models: + type: array + items: + $ref: "#/definitions/model" + named-queries: + type: array + items: + $ref: "#/definitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also + required: + - service-instance-id + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: Path to the controller object. + orchestration-status: + type: string + description: Orchestration status of this service. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + allotted-resources: + type: array + items: + $ref: "#/definitions/allotted-resource" + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/definitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-instances: + type: array + items: + $ref: "#/definitions/service-instance" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/definitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/definitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + classes-of-service: + type: array + items: + $ref: "#/definitions/class-of-service" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + routing-instances: + type: array + items: + $ref: "#/definitions/routing-instance" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/definitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/definitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/definitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/definitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + 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. + vf-mac-anti-spoof-check: + type: boolean + 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. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/definitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + description: dhcp enabled + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + subnet-sequence: + type: integer + format: int32 + description: sequence of the subnet + host-routes: + type: array + items: + $ref: "#/definitions/host-route" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/definitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/definitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vservers: + type: array + items: + $ref: "#/definitions/vserver" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/definitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also + required: + - id + - bandwidth-up-wan1 + - bandwidth-down-wan1 + - bandwidth-up-wan2 + - bandwidth-down-wan2 + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/definitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/definitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/definitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: Loopback0 address + entitlement-resource-uuid: + type: string + description: OBSOLETE - see child relationships + port-groups: + type: array + items: + $ref: "#/definitions/port-group" + licenses: + type: array + items: + $ref: "#/definitions/license" + entitlements: + type: array + items: + $ref: "#/definitions/entitlement" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/definitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + description: used to indicate whether or not this object is base vf module + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + contrail-service-instance-fqdn: + type: string + description: the Contrail unique ID for a service-instance + module-index: + type: integer + format: int32 + 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 + selflink: + type: string + description: Path to the controller object. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/definitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/definitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + + required: + - vip-ipv6-address + properties: + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/definitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + vlan-description: + type: string + description: Used to describe (the service associated with) the vlan + backdoor-connection: + type: string + description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. + vpn-key: + type: string + description: This indicates the customers VPN ID associated with this vlan + orchestration-status: + type: string + description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + prov-status: + type: string + description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + vlans: + properties: + vlan: + type: array + items: + $ref: "#/definitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/definitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + is-closed-loop-disabled: + type: boolean + description: used to indicate whether closed loop function is enabled on this node + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/definitions/l3-interface-ipv6-address-list" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/definitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + 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. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/definitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/definitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + 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). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/definitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/definitions/lag-interface" + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/definitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + route-targets: + type: array + items: + $ref: "#/definitions/route-target" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/definitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + is-closed-loop-disabled: + type: boolean + description: Used to indicate whether closed loop function is enabled on this node + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volumes: + type: array + items: + $ref: "#/definitions/volume" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/definitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Large?] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/definitions/zone" +patchDefinitions: + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/patchDefinitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string + actions: + description: | + APIs that are more action related than REST (e.g., notify, update). + properties: + update: + type: object + $ref: "#/patchDefinitions/update" + notify: + type: object + $ref: "#/patchDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also + required: + - id + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + description: + type: string + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + allotted-resources: + description: | + This object is used to store slices of services being offered + properties: + allotted-resource: + type: array + items: + $ref: "#/patchDefinitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: + type: string + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: + type: string + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + availability-zones: + description: | + Collection of availability zones + properties: + availability-zone: + type: array + items: + $ref: "#/patchDefinitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/patchDefinitions/dvs-switches" + availability-zone: + type: object + $ref: "#/patchDefinitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/patchDefinitions/connector" + customers: + type: array + items: + $ref: "#/patchDefinitions/customer" + lines-of-business: + type: array + items: + $ref: "#/patchDefinitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/patchDefinitions/owning-entity" + platforms: + type: array + items: + $ref: "#/patchDefinitions/platform" + projects: + type: array + items: + $ref: "#/patchDefinitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: + type: string + description: type of probe + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/patchDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + items: + $ref: "#/patchDefinitions/complex" + cloud-regions: + type: array + items: + $ref: "#/patchDefinitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/patchDefinitions/network-profile" + pservers: + type: array + items: + $ref: "#/patchDefinitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/patchDefinitions/virtual-data-center" + cloud-region: + description: | + cloud-region designates an installation of a cloud cluster or region or instantiation. + ###### Related Nodes + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + + required: + - cloud-owner + - cloud-region-id + - sriov-automation + properties: + cloud-owner: + type: string + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: + type: string + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: + type: string + description: Type of the cloud (e.g., openstack) + owner-defined-type: + type: string + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/patchDefinitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + + required: + - physical-location-id + - physical-location-type + - street1 + - city + - postal-code + - country + - region + properties: + physical-location-id: + type: string + description: Unique identifier for physical location, e.g., CLLI + data-center-code: + type: string + description: Data center code which can be an alternate way to identify a complex + complex-name: + type: string + description: Gamma complex name for LCP instance. + identity-url: + type: string + description: URL of the keystone identity service + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/patchDefinitions/complex" + configuration: + description: | + Port Mirror Configuration. + ###### Related Nodes + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also + required: + - configuration-id + - configuration-type + - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id + properties: + configuration-id: + type: string + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/patchDefinitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/patchDefinitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/patchDefinitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/patchDefinitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/patchDefinitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/patchDefinitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/patchDefinitions/cvlan-tag-entry" + dvs-switch: + description: | + 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. + ###### Related Nodes + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/patchDefinitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/patchDefinitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/patchDefinitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/patchDefinitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/patchDefinitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/patchDefinitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/patchDefinitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1) + + -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/patchDefinitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4) + - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) + - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) + - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: + type: string + description: service IP of ftp server. + port: + type: string + description: service port of ftp server. + cloud-domain: + type: string + description: domain info for authentication. + default-tenant: + type: string + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: + type: string + description: resource or performance data file path. + system-status: + type: string + description: the status of external system. + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/patchDefinitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY) + - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1) + + -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also + required: + - thirdparty-sdnc-id + properties: + thirdparty-sdnc-id: + type: string + description: Unique ID of SDNC. + location: + type: string + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/patchDefinitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) + + -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also + required: + - vnfm-id + properties: + vnfm-id: + type: string + description: Unique ID of VNFM. + vim-id: + type: string + description: indecate the VIM to deploy VNF. + certificate-url: + type: string + description: certificate url of VNFM. + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/patchDefinitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also + required: + - evc-id + properties: + evc-id: + type: string + description: Unique/key field for the evc object + forwarding-path-topology: + type: string + description: Point-to-Point, Multi-Point + cir-value: + type: string + description: Commited Information Rate + cir-units: + type: string + description: CIR units + connection-diversity-group-id: + type: string + description: Diversity Group ID + service-hours: + type: string + description: formerly Performance Group + esp-evc-circuit-id: + type: string + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: + type: string + description: Committed Information Rate (For ESP) + esp-evc-cir-units: + type: string + description: CIR units (For ESP) + esp-itu-code: + type: string + description: Identifies ESP + collector-pop-clli: + type: string + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: + type: string + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: + type: string + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC + evcs: + properties: + evc: + type: array + items: + $ref: "#/patchDefinitions/evc" + external-system: + description: | + Namespace for external system. + properties: + esr-ems-list: + type: object + $ref: "#/patchDefinitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/patchDefinitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: + type: array + items: + $ref: "#/patchDefinitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + + required: + - flavor-id + - flavor-name + - flavor-selflink + properties: + flavor-id: + type: string + description: Flavor id, expected to be unique across cloud-region. + flavor-name: + type: string + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: + type: string + description: amount of swap space allocation + flavor-is-public: + type: boolean + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: + type: string + description: URL to endpoint where AAI can get more details + flavor-disabled: + type: boolean + description: Boolean as to whether this flavor is no longer enabled + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/patchDefinitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also + required: + - sequence + properties: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: + type: string + description: ingress, intermediate, egress + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also + required: + - forwarder-evc-id + properties: + forwarder-evc-id: + type: string + description: Key for forwarder-evc object + circuit-id: + type: string + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: + type: string + description: Internal VLAN. + svlan: + type: string + description: SVLAN value for ingress of egress forwarder. + cvlan: + type: string + description: CVLAN value for ingress of egress forwarder. + forwarder-evcs: + properties: + forwarder-evc: + type: array + items: + $ref: "#/patchDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/patchDefinitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also + required: + - forwarding-path-id + - forwarding-path-name + properties: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + forwarding-paths: + properties: + forwarding-path: + type: array + items: + $ref: "#/patchDefinitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also + required: + - vnf-id + - vnf-name + - vnf-type + - in-maint + - is-closed-loop-disabled + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: + type: string + description: vnf instance id. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + 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 + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + is-closed-loop-disabled: + type: boolean + description: used to indicate whether closed loop function is enabled on this node + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/patchDefinitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + + required: + - group-id + - group-type + - group-name + properties: + group-id: + type: string + description: Group id, expected to be unique across cloud-region. + group-type: + type: string + description: Group type - the type of group this instance refers to + group-name: + type: string + description: Group name - name assigned to the group + group-description: + type: string + description: Group description - description of the group + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/patchDefinitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also + required: + - host-route-id + - route-prefix + - next-hop + properties: + host-route-id: + type: string + description: host-route id + route-prefix: + type: string + description: subnet prefix + next-hop: + type: string + description: Could be ip-address, hostname, or service-instance + next-hop-type: + type: string + description: Should be ip-address, hostname, or service-instance to match next-hop + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/patchDefinitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/patchDefinitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + architecture: + type: string + description: Hardware architecture + hpa-feature-attributes: + description: | + HPA Capability Feature attributes + ###### Related Nodes + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also + required: + - hpa-attribute-key + properties: + hpa-attribute-key: + type: string + description: name of the specific HPA attribute + hpa-attribute-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + + required: + - image-id + - image-name + - image-os-distro + - image-os-version + - image-selflink + properties: + image-id: + type: string + description: Image id, expected to be unique across cloud region + image-name: + type: string + description: Image name + image-architecture: + type: string + description: Operating system architecture. + image-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + image-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + image-selflink: + type: string + description: URL to endpoint where AAI can get more details + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/patchDefinitions/image" + include-node-filter: + properties: + include-node-type: + type: string + instance-filter: + description: | + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query + properties: + instance-filter: + type: array + items: + $ref: "#/patchDefinitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + + required: + - id + - description + - type + properties: + instance-group-role: + type: string + description: role of the instance group. + model-invariant-id: + type: string + description: ASDC model id for this resource or service model. + model-version-id: + type: string + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/patchDefinitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/patchDefinitions/search" + actions: + type: object + $ref: "#/patchDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/patchDefinitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/patchDefinitions/external-system" + business: + type: object + $ref: "#/patchDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/patchDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/patchDefinitions/network" + nodes: + type: object + $ref: "#/patchDefinitions/nodes" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/patchDefinitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: + type: string + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + model-name: + type: string + extra-properties: + type: object + $ref: "#/patchDefinitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/patchDefinitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: + type: array + items: + $ref: "#/patchDefinitions/inventory-response-item" + ipsec-configuration: + description: | + 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 + ###### Related Nodes + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also + required: + - ipsec-configuration-id + properties: + ipsec-configuration-id: + type: string + description: UUID of this configuration + requested-vig-address-type: + type: string + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: + type: string + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: + type: string + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: + type: string + description: Network address of shared DMZ + requested-customer-name: + type: string + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/patchDefinitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: + description: | + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also + required: + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered + properties: + interface-name: + type: string + description: Name given to the interface + interface-role: + type: string + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: + type: string + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: + type: string + description: URL to endpoint where AAI can get more details + interface-id: + type: string + description: ID of interface + macaddr: + type: string + description: MAC address for the interface + network-name: + type: string + description: Name of the network + management-option: + type: string + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: + type: boolean + description: boolean indicatating whether or not port is a mirrored. + l-interfaces: + description: | + Collection of logical interfaces. + properties: + l-interface: + type: array + items: + $ref: "#/patchDefinitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also + required: + - l3-interface-ipv4-address + properties: + l3-interface-ipv4-address: + type: string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also + required: + - l3-interface-ipv6-address + properties: + l3-interface-ipv6-address: + type: string + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also + required: + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network + properties: + network-id: + type: string + description: Network ID, should be uuid. Unique across A&AI. + network-name: + type: string + description: Name of the network, governed by some naming convention.. + network-type: + type: string + description: Type of the network - who defines these values? + network-role: + type: string + description: Role the network plans - who defines these values? + network-technology: + type: string + description: Network technology - who defines these values? + neutron-network-id: + type: string + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + description: Set to true if bound to VPN + service-id: + type: string + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance + l3-networks: + properties: + l3-network: + type: array + items: + $ref: "#/patchDefinitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the link aggregate interface + interface-description: + type: string + description: Human friendly text regarding this interface. + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/patchDefinitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also + required: + - link-name + properties: + link-name: + type: string + description: Alphabetical concatenation of lag-interface names + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/patchDefinitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: + type: string + description: Unique ID of a license resource. + licenses: + description: | + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + properties: + license: + type: array + items: + $ref: "#/patchDefinitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + + required: + - line-of-business-name + properties: + line-of-business-name: + type: string + description: Name of the line-of-business (product) + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/patchDefinitions/line-of-business" + logical-link: + description: | + Logical links generally connect l-interfaces but are used to express logical connectivity between two points + ###### Related Nodes + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also + required: + - link-name + - in-maint + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + link-type: + type: string + description: Type of logical link, e.g., evc + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + ip-version: + type: string + description: v4, v6, or ds for dual stack + routing-protocol: + type: string + description: For example, static or BGP + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/patchDefinitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/patchDefinitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: + type: string + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/patchDefinitions/query-parameters" + instance-filters: + type: object + $ref: "#/patchDefinitions/instance-filters" + secondary-filts: + type: object + $ref: "#/patchDefinitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: + type: array + items: + $ref: "#/patchDefinitions/constrained-element-set" + model-constraints: + properties: + model-constraint: + type: array + items: + $ref: "#/patchDefinitions/model-constraint" + model-element: + description: | + Defines how other models combine to make up a higher-level model. + ###### Related Nodes + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also + required: + - model-element-uuid + - new-data-del-flag + - cardinality + properties: + model-element-uuid: + type: string + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: + type: string + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/patchDefinitions/model-element" + model-ver: + description: | + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models + ###### Related Nodes + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + + required: + - model-version-id + - model-name + - model-version + properties: + model-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-name: + type: string + description: Name of the model, which can change from version to version. + model-version: + type: string + description: Version + model-description: + type: string + description: Description + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/patchDefinitions/model-ver" + models: + description: | + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models + properties: + model: + type: array + items: + $ref: "#/patchDefinitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + + required: + - multicast-configuration-id + - multicast-protocol + - rp-type + properties: + multicast-configuration-id: + type: string + description: Unique id of multicast configuration. + multicast-protocol: + type: string + description: protocol of multicast configuration + rp-type: + type: string + description: rp type of multicast configuration + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/patchDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/patchDefinitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also + required: + - named-query-uuid + - named-query-name + - named-query-version + properties: + named-query-uuid: + type: string + named-query-name: + type: string + named-query-version: + type: string + required-input-param: + type: string + description: + type: string + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also + required: + - named-query-element-uuid + properties: + named-query-element-uuid: + type: string + property-collect-list: + type: string + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/patchDefinitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + logical-links: + type: array + items: + $ref: "#/patchDefinitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/patchDefinitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/patchDefinitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/patchDefinitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/patchDefinitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/patchDefinitions/vce" + vnfcs: + type: array + items: + $ref: "#/patchDefinitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/patchDefinitions/l3-network" + network-policies: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/patchDefinitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/patchDefinitions/lag-link" + newvces: + type: array + items: + $ref: "#/patchDefinitions/newvce" + pnfs: + type: array + items: + $ref: "#/patchDefinitions/pnf" + physical-links: + type: array + items: + $ref: "#/patchDefinitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/patchDefinitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/patchDefinitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/patchDefinitions/instance-group" + zones: + type: array + items: + $ref: "#/patchDefinitions/zone" + configurations: + type: array + items: + $ref: "#/patchDefinitions/configurations" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + + required: + - network-policy-id + properties: + network-policy-id: + type: string + description: UUID representing unique key to this instance + network-policy-fqdn: + type: string + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + + required: + - nm-profile-name + properties: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/patchDefinitions/network-profile" + newvce: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + ###### Related Nodes + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: + type: string + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + 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). + equipment-role: + type: string + description: Client should send valid enumerated value. + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. + properties: + newvce: + type: array + items: + $ref: "#/patchDefinitions/newvce" + nodes: + properties: + inventory-item-data: + type: array + items: + $ref: "#/patchDefinitions/inventory-item-data" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/patchDefinitions/notification-event-header" + notification-event-header: + properties: + id: + type: string + timestamp: + type: string + source-name: + type: string + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id + properties: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: + type: array + items: + $ref: "#/patchDefinitions/key-data" + selflink: + type: string + oam-network: + description: | + OAM network, to be deprecated shortly. Do not use for new purposes. + ###### Related Nodes + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + + required: + - network-uuid + - network-name + - cvlan-tag + properties: + network-uuid: + type: string + description: UUID of the network. Unique across a cloud-region + network-name: + type: string + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + properties: + oam-network: + type: array + items: + $ref: "#/patchDefinitions/oam-network" + operational-environment: + description: | + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. + ###### Related Nodes + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + + required: + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context + properties: + operational-environment-id: + type: string + description: UUID of an operational environment + operational-environment-name: + type: string + description: Operational Environment name + operational-environment-type: + type: string + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: + type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. + properties: + operational-environment: + type: array + items: + $ref: "#/patchDefinitions/operational-environment" + overloaded-model: + description: | + Allows for legacy POST of old-style and new-style models + required: + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version + properties: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: + type: string + description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. + model-name: + type: string + description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version + model-version: + type: string + description: Version + model-description: + type: string + description: Description + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/patchDefinitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + + required: + - owning-entity-id + - owning-entity-name + properties: + owning-entity-id: + type: string + description: UUID of an owning entity + owning-entity-name: + type: string + description: Owning entity name + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also + required: + - interface-name + - in-maint + properties: + interface-name: + type: string + description: Name that identifies the physical interface + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + port-description: + type: string + description: Nature of the services and connectivity on this port. + equipment-identifier: + type: string + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: + type: string + description: MAC Address of the p-interface. + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/patchDefinitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also + required: + - link-name + properties: + link-name: + type: string + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: + type: string + description: Captures the numeric part of the speed + speed-units: + type: string + description: Captures the units corresponding to the speed + circuit-id: + type: string + description: Circuit it + dual-mode: + type: string + description: Dual access mode (e.g., primary, secondary + management-option: + type: string + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: + type: string + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: + type: string + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: + type: string + description: Units for downstream BW value + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/patchDefinitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + + required: + - platform-name + properties: + platform-name: + type: string + description: Name of the platform + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/patchDefinitions/platform" + pnf: + description: | + 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. + ###### Related Nodes + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY) + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also + required: + - pnf-name + - in-maint + properties: + pnf-name: + type: string + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. + in-maint: + type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + frame-id: + type: string + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: + type: string + description: Serial number of the device + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/patchDefinitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also + required: + - interface-id + - orchestration-status + properties: + interface-id: + type: string + description: Unique ID of the interface + neutron-network-id: + type: string + description: Neutron network id of this Interface + neutron-network-name: + type: string + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/patchDefinitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project Uses service-instance, ONE2MANY) + + required: + - project-name + properties: + project-name: + type: string + description: Name of the project deploying a service + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/patchDefinitions/project" + properties: + description: | + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: + type: string + constraint-type: + type: string + property-name: + type: string + property-value: + type: string + property-constraints: + properties: + property-constraint: + type: array + items: + $ref: "#/patchDefinitions/property-constraint" + pserver: + description: | + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. + ###### Related Nodes + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + + required: + - hostname + - in-maint + properties: + hostname: + type: string + description: Value from executing hostname on the compute node. + ptnii-equip-name: + type: string + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/patchDefinitions/pserver" + query-parameters: + description: | + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/patchDefinitions/named-query" + overloaded-model: + type: object + $ref: "#/patchDefinitions/overloaded-model" + related-lookup: + description: | + TBD + ###### Related Nodes + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also + required: + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property + properties: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: + type: string + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/patchDefinitions/related-lookup" + related-to-property: + properties: + property-key: + type: string + description: Key part of a key/value pair + property-value: + type: string + description: Value part of a key/value pair + relationship: + properties: + related-to: + type: string + description: A keyword provided by A&AI to indicate type of node. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: + type: array + items: + $ref: "#/patchDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/patchDefinitions/related-to-property" + relationship-data: + required: + - relationship-key + - relationship-value + properties: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + reserved-prop-names: + description: | + Internal map to define some reserved properties of a vertex + properties: + last-mod-source-of-truth: + type: string + aai-node-type: + type: string + aai-created-ts: + type: integer + format: int64 + aai-unique-key: + type: string + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: + type: string + aai-uri: + type: string + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/patchDefinitions/inventory-response-items" + result-data: + properties: + resource-type: + type: string + description: The specific type of node in the A&AI graph + resource-link: + type: string + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/patchDefinitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also + required: + - global-route-target + - route-target-role + properties: + global-route-target: + type: string + description: Number used to identify an RT, globally unique in the network + route-target-role: + type: string + description: Role assigned to this route target + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/patchDefinitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also + required: + - routing-instance-id + properties: + routing-instance-id: + type: string + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/patchDefinitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/patchDefinitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/patchDefinitions/az-and-dvs-switches" + search: + properties: + edge-tag-query-result: + type: object + $ref: "#/patchDefinitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/patchDefinitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/patchDefinitions/search-results" + sdn-zone-response: + type: object + $ref: "#/patchDefinitions/sdn-zone-response" + search-results: + properties: + result-data: + type: array + items: + $ref: "#/patchDefinitions/result-data" + secondary-filt: + description: | + SecondaryFilt for performing a named-query or model query + secondary-filter: + properties: + property-name: + type: string + filter-type: + type: string + property-value: + type: string + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/patchDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also + required: + - segmentation-id + properties: + segmentation-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/patchDefinitions/segmentation-assignment" + service: + description: | + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. + required: + - service-id + - service-description + properties: + service-id: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: + type: string + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/patchDefinitions/service-capability" + service-capability: + description: | + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. + ###### Related Nodes + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + + required: + - service-type + - vnf-type + properties: + service-type: + type: string + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: + type: string + 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. + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + items: + $ref: "#/patchDefinitions/vnf-image" + services: + type: array + items: + $ref: "#/patchDefinitions/service" + service-capabilities: + type: array + items: + $ref: "#/patchDefinitions/service-capability" + models: + type: array + items: + $ref: "#/patchDefinitions/model" + named-queries: + type: array + items: + $ref: "#/patchDefinitions/named-query" + service-instance: + description: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also + required: + - service-instance-id + properties: + service-instance-id: + type: string + description: Uniquely identifies this instance of a service + service-instance-name: + type: string + description: This field will store a name assigned to the service-instance. + service-type: + type: string + description: String capturing type of service. + service-role: + type: string + description: String capturing the service role. + environment-context: + type: string + description: This field will store the environment context assigned to the service-instance. + workload-context: + type: string + description: This field will store the workload context assigned to the service-instance. + created-at: + type: string + description: create time of Network Service. + updated-at: + type: string + description: last update of Network Service. + description: + type: string + description: short description for service-instance. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: + type: string + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: + type: string + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/patchDefinitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also + required: + - service-type + properties: + service-type: + type: string + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: + type: string + description: This property will be deleted from A&AI in the near future. Only stop gap solution. + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $ref: "#/patchDefinitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/patchDefinitions/service" + site-pair: + description: | + ###### Related Nodes + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also + required: + - site-pair-id + properties: + site-pair-id: + type: string + description: unique identifier of probe + source-ip: + type: string + description: Prefix address + destination-ip: + type: string + description: Prefix address + ip-version: + type: string + description: ip version, v4, v6 + destination-hostname: + type: string + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: + type: string + description: The type of destinatination equipment. Could be Router, UCPE, etc. + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also + required: + - site-pair-set-id + properties: + site-pair-set-id: + type: string + description: Unique id of site pair set. + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/patchDefinitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/patchDefinitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + + required: + - snapshot-id + properties: + snapshot-id: + type: string + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: + type: string + description: Snapshot name + snapshot-architecture: + type: string + description: Operating system architecture + snapshot-os-distro: + type: string + description: The common name of the operating system distribution in lowercase + snapshot-os-version: + type: string + description: The operating system version as specified by the distributor. + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + snapshot-selflink: + type: string + description: URL to endpoint where AAI can get more details + prev-snapshot-id: + type: string + description: This field contains the UUID of the previous snapshot (if any). + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/patchDefinitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also + required: + - pf-pci-id + properties: + pf-pci-id: + type: string + description: Identifier for the sriov-pf + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/patchDefinitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also + required: + - pci-id + properties: + pci-id: + type: string + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: + type: string + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: + type: string + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + 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. + vf-mac-anti-spoof-check: + type: boolean + 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. + vf-mirrors: + type: string + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: + type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/patchDefinitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: + type: string + description: Subnet ID, should be UUID. + subnet-name: + type: string + description: Name associated with the subnet. + neutron-subnet-id: + type: string + description: Neutron id of this subnet + gateway-address: + type: string + description: gateway ip address + network-start-address: + type: string + description: network start address + cidr-mask: + type: string + description: cidr mask + ip-version: + type: string + description: ip version + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + description: dhcp enabled + dhcp-start: + type: string + description: the start address reserved for use by dhcp + dhcp-end: + type: string + description: the last address reserved for use by dhcp + subnet-role: + type: string + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: + type: string + description: ip address assignment direction of the subnet + subnets: + properties: + subnet: + type: array + items: + $ref: "#/patchDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/patchDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/patchDefinitions/tenant" + tunnel-xconnect: + description: | + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also + required: + - id + - bandwidth-up-wan1 + - bandwidth-down-wan1 + - bandwidth-up-wan2 + - bandwidth-down-wan2 + properties: + id: + type: string + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 + tunnel-xconnects: + description: | + This object is used to store the specific tunnel cross connect aspects of an allotted resource + properties: + tunnel-xconnect: + type: array + items: + $ref: "#/patchDefinitions/tunnel-xconnect" + update: + description: | + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/patchDefinitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/patchDefinitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. + ###### Related Nodes + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also + required: + - vnf-id + - vnf-name + - vnf-type + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-name: + type: string + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Network role being played by this VNF + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + vpe-id: + type: string + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: + type: string + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: + type: string + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: + type: array + items: + $ref: "#/patchDefinitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + + required: + - vf-module-id + - is-base-vf-module + properties: + vf-module-id: + type: string + description: Unique ID of vf-module. + vf-module-name: + type: string + description: Name of vf-module + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance. + orchestration-status: + type: string + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + description: used to indicate whether or not this object is base vf module + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs + properties: + vf-module: + type: array + items: + $ref: "#/patchDefinitions/vf-module" + vig-server: + description: | + vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 + ###### Related Nodes + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also + required: + - vig-address-type + properties: + vig-address-type: + type: string + description: indicates whether the VIG is for AVPN or INTERNET + ipaddress-v4-vig: + type: string + description: v4 IP of the vig server + ipaddress-v6-vig: + type: string + description: v6 IP of the vig server + vig-servers: + properties: + vig-server: + type: array + items: + $ref: "#/patchDefinitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + + required: + - vip-ipv4-address + properties: + vip-ipv4-address: + type: string + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + + required: + - vip-ipv6-address properties: - edge-tag-query-result: - type: object - $ref: "#/definitions/edge-tag-query-result" - edge-tag-query-request: - type: object - $ref: "#/definitions/edge-tag-query-request" - search-results: - type: object - $ref: "#/definitions/search-results" - sdn-zone-response: - type: object - $ref: "#/definitions/sdn-zone-response" + vip-ipv6-address: + type: string + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + + required: + - vdc-id + - vdc-name + properties: + vdc-id: + type: string + description: Unique ID of the vdc + vdc-name: + type: string + description: Name of the virtual data center + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context + properties: + virtual-data-center: + type: array + items: + $ref: "#/patchDefinitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also + required: + - vlan-interface + - in-maint + - is-ip-unnumbered + properties: + vlan-interface: + type: string + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + vlans: + properties: + vlan: + type: array + items: + $ref: "#/patchDefinitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id + properties: + vnf-id: + type: string + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + + required: + - vnf-image-uuid + - application + - application-vendor + properties: + vnf-image-uuid: + type: string + description: Unique ID of this asset + application: + type: string + description: The application that the image instantiates. + application-vendor: + type: string + description: The vendor of the application. + application-version: + type: string + description: The version of the application. + selflink: + type: string + description: URL to endpoint where AAI can get more details + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + properties: + vnf-image: + type: array + items: + $ref: "#/patchDefinitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also + required: + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + nfc-naming-code: + type: string + description: Short code that is used in naming instances of the item being modeled + nfc-function: + type: string + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: + type: string + description: prov status of this vnfc + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: + type: string + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + is-closed-loop-disabled: + type: boolean + description: used to indicate whether closed loop function is enabled on this node + group-notation: + type: string + description: Group notation of VNFC + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: + type: array + items: + $ref: "#/patchDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also + required: + - volume-id + - volume-selflink + properties: + volume-id: + type: string + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: + type: string + description: URL to endpoint where AAI can get more details + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: + type: string + description: Unique ID of volume-group. + volume-group-name: + type: string + description: Name of the volume group. + heat-stack-id: + type: string + description: Heat stack id corresponding to this volume-group + vnf-type: + type: string + 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. + orchestration-status: + type: string + description: Orchestration status of this volume-group + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: + type: string + description: helps relate the volume group to the vf-module whose components will require the volume group + volume-groups: + description: | + Collection of persistent block-level storage. + properties: + volume-group: + type: array + items: + $ref: "#/patchDefinitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/patchDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also + required: + - equipment-name + properties: + equipment-name: + type: string + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: + type: string + 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). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for stag to get to VCE + vpls-pes: + description: | + Collection of VPLS Provider Edge routers + properties: + vpls-pe: + type: array + items: + $ref: "#/patchDefinitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + + required: + - vpn-id + - vpn-name + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + vpn-platform: + type: string + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: + type: string + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: + type: string + description: region of customer vpn + customer-vpn-id: + type: string + description: id for this customer vpn + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + vpn-bindings: + properties: + vpn-binding: + type: array + items: + $ref: "#/patchDefinitions/vpn-binding" + vserver: + description: | + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled + properties: + vserver-id: + type: string + description: Unique identifier for this vserver relative to its tenant + vserver-name: + type: string + description: Name of vserver + vserver-name2: + type: string + description: Alternative name of vserver + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + is-closed-loop-disabled: + type: boolean + description: Used to indicate whether closed loop function is enabled on this node + vservers: + description: | + Collection of virtual Servers, aka virtual machines or VMs. + properties: + vserver: + type: array + items: + $ref: "#/patchDefinitions/vserver" + zone: + description: | + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + + required: + - zone-id + - zone-name + - design-type + - zone-context + properties: + zone-id: + type: string + description: Code assigned by AIC to the zone + zone-name: + type: string + description: English name associated with the zone + design-type: + type: string + description: Design of zone [Medium/Large?] + zone-context: + type: string + description: Context of zone [production/test] + status: + type: string + description: Status of a zone. + zones: + description: | + Collection of zones + properties: + zone: + type: array + items: + $ref: "#/patchDefinitions/zone" +getDefinitions: + action: + properties: + action-type: + type: string + action-data: + type: array + items: + $ref: "#/getDefinitions/action-data" + action-data: + properties: + property-name: + type: string + property-value: + type: string actions: description: | APIs that are more action related than REST (e.g., notify, update). properties: update: type: object - $ref: "#/definitions/update" + $ref: "#/getDefinitions/update" notify: type: object - $ref: "#/definitions/notify" - relationship-data: + $ref: "#/getDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) + - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) + - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) + - TO vlan( allotted-resource PartOf vlan, MANY2MANY) + - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4) + - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1) + - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3) + - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY) + - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) + + -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also + -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also + -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also required: - - relationship-key - - relationship-value + - id properties: - relationship-key: + id: type: string - description: A keyword provided by A&AI to indicate an attribute. - relationship-value: + description: Allotted Resource id UUID assigned to this instance. + description: type: string - description: Value of the attribute. - related-to-property: + description: The descriptive information assigned to this allotted resource instance + selflink: + type: string + description: Link back to more information in the controller + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + resource-version: + type: string + description: Concurrency value + orchestration-status: + type: string + description: Orchestration status + operational-status: + type: string + description: Indicator for whether the resource is considered operational + type: + type: string + description: Generic description of the type of allotted resource. + role: + type: string + description: role in the network that this resource will be providing. + tunnel-xconnects: + type: array + items: + $ref: "#/getDefinitions/tunnel-xconnect" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + allotted-resources: + description: | + This object is used to store slices of services being offered properties: - property-key: + allotted-resource: + type: array + items: + $ref: "#/getDefinitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4) + - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY) + - FROM pserver( pserver MemberOf availability-zone, MANY2ONE) + - FROM vce( vce Uses availability-zone, MANY2MANY) + + -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also + -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + + required: + - availability-zone-name + - hypervisor-type + properties: + availability-zone-name: type: string - description: Key part of a key/value pair - property-value: + description: Name of the availability zone. Unique across a cloud region + hypervisor-type: type: string - description: Value part of a key/value pair - relationship: + description: Type of hypervisor. Source of truth should define valid values. + operational-status: + type: string + description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + availability-zones: + description: | + Collection of availability zones properties: - related-to: + availability-zone: + type: array + items: + $ref: "#/getDefinitions/availability-zone" + az-and-dvs-switches: + properties: + dvs-switches: + type: object + $ref: "#/getDefinitions/dvs-switches" + availability-zone: + type: object + $ref: "#/getDefinitions/availability-zone" + business: + description: | + Namespace for business related constructs + properties: + connectors: + type: array + items: + $ref: "#/getDefinitions/connector" + customers: + type: array + items: + $ref: "#/getDefinitions/customer" + lines-of-business: + type: array + items: + $ref: "#/getDefinitions/line-of-business" + owning-entities: + type: array + items: + $ref: "#/getDefinitions/owning-entity" + platforms: + type: array + items: + $ref: "#/getDefinitions/platform" + projects: + type: array + items: + $ref: "#/getDefinitions/project" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also + required: + - cos + properties: + cos: + type: string + description: unique identifier of probe + probe-id: + type: string + description: identifier of probe + probe-type: type: string - description: A keyword provided by A&AI to indicate type of node. - related-link: + description: type of probe + resource-version: type: string - description: URL to the object in A&AI. - relationship-data: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: type: array - items: - $ref: "#/definitions/relationship-data" - related-to-property: + items: + $ref: "#/getDefinitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: type: array items: - $ref: "#/definitions/related-to-property" - relationship-list: + $ref: "#/getDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. properties: - relationship: + complexes: type: array - items: - $ref: "#/definitions/relationship" - ctag-pool: + items: + $ref: "#/getDefinitions/complex" + cloud-regions: + type: array + items: + $ref: "#/getDefinitions/cloud-region" + network-profiles: + type: array + items: + $ref: "#/getDefinitions/network-profile" + pservers: + type: array + items: + $ref: "#/getDefinitions/pserver" + virtual-data-centers: + type: array + items: + $ref: "#/getDefinitions/virtual-data-center" + cloud-region: description: | - A collection of C tags (vlan tags) grouped for a specific purpose. - ###### Default Delete Scope - THIS_NODE_ONLY + cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - - TO availability-zone (Many2Many) - - FROM complex (is composed of ctag-pool) - - FROM vpls-pe - - FROM generic-vnf + - TO complex( cloud-region LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region Uses l3-network, MANY2MANY) + - TO zone( cloud-region LocatedIn zone, MANY2ONE) + - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1) + - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1) + - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM image( image BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE) + + -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also + -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + required: - - target-pe - - availability-zone-name - - ctag-pool-purpose + - cloud-owner + - cloud-region-id + - sriov-automation properties: - target-pe: + cloud-owner: type: string - description: The Target provider edge router - availability-zone-name: + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + cloud-region-id: type: string - description: Name of the availability zone - ctag-pool-purpose: + description: Identifier used by the vendor for the region. Second part of composite key + cloud-type: type: string - description: Describes what the intended purpose of this pool is. - ctag-values: + description: Type of the cloud (e.g., openstack) + owner-defined-type: type: string - description: Comma separated list of ctags + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + cloud-region-version: + type: string + description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. + identity-url: + type: string + description: URL of the keystone identity service + cloud-zone: + type: string + description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + complex-name: + type: string + description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + sriov-automation: + type: boolean + description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. + cloud-extra-info: + type: string + description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. + cloud-epa-caps: + type: string + description: MultiVIM will discover and expose EPA capabilities. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volume-groups: + type: array + items: + $ref: "#/getDefinitions/volume-group" + tenants: + type: array + items: + $ref: "#/getDefinitions/tenant" + flavors: + type: array + items: + $ref: "#/getDefinitions/flavor" + group-assignments: + type: array + items: + $ref: "#/getDefinitions/group-assignment" + snapshots: + type: array + items: + $ref: "#/getDefinitions/snapshot" + images: + type: array + items: + $ref: "#/getDefinitions/image" + dvs-switches: + type: array + items: + $ref: "#/getDefinitions/dvs-switch" + oam-networks: + type: array + items: + $ref: "#/getDefinitions/oam-network" + availability-zones: + type: array + items: + $ref: "#/getDefinitions/availability-zone" relationship-list: type: array items: - $ref: "#/definitions/relationship" - ctag-pools: + $ref: "#/getDefinitions/relationship" + esr-system-info-list: + type: array + items: + $ref: "#/getDefinitions/esr-system-info" + vip-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/vip-ipv4-address-list" + vip-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/vip-ipv6-address-list" + cloud-regions: properties: - ctag-pool: + cloud-region: type: array items: - $ref: "#/definitions/ctag-pool" + $ref: "#/getDefinitions/cloud-region" complex: description: | Collection of physical locations that can house cloud-regions. - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE - ###### Related Nodes - - TO ctag-pool (comprises complex, Many2Many) - - TO l3-network (Many2Many) - - FROM availability-zone - - FROM cloud-region - - FROM oam-network - - FROM pserver - - FROM pnf - - FROM vce - - FROM vpls-pe - - FROM volume-group - - FROM zone - - FROM generic-vnf + ###### Related Nodes + - TO l3-network( complex Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY) + - FROM oam-network( oam-network AppliesTo complex, MANY2MANY) + - FROM pnf( pnf LocatedIn complex, MANY2ONE) + - FROM pserver( pserver LocatedIn complex, MANY2ONE) + - FROM vce( vce LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE) + - FROM zone( zone LocatedIn complex, MANY2ONE) + + -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also + -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + required: - physical-location-id - physical-location-type @@ -39078,11 +55212,11 @@ definitions: ctag-pools: type: array items: - $ref: "#/definitions/ctag-pool" + $ref: "#/getDefinitions/ctag-pool" relationship-list: type: array items: - $ref: "#/definitions/relationship" + $ref: "#/getDefinitions/relationship" complexes: description: | Collection of physical locations that can house cloud-regions. @@ -39090,600 +55224,1152 @@ definitions: complex: type: array items: - $ref: "#/definitions/complex" - volume-group: + $ref: "#/getDefinitions/complex" + configuration: description: | - Persistent block-level storage. - ###### Default Delete Scope - THIS_NODE_ONLY + Port Mirror Configuration. ###### Related Nodes - - TO complex (Many2Many) - - TO tenant (Many2Many) - - FROM cloud-region (is composed of volume-group) - - FROM vf-module - - FROM generic-vnf + - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2) + - TO logical-link( configuration Uses logical-link, ONE2MANY)(2) + - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1) + - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) + - FROM service-instance( service-instance Uses configuration, ONE2MANY) + + -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also + -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also + -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also required: - - volume-group-id - - volume-group-name - - vnf-type + - configuration-id + - configuration-type + - configuration-sub-type + - orchestration-status + - operational-status + - configuration-selflink + - model-customization-id properties: - volume-group-id: + configuration-id: type: string - description: Unique ID of volume-group. - volume-group-name: + description: UUID assigned to configuration. + management-option: + type: string + description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. + configuration-name: + type: string + description: Name of the configuration. + configuration-type: + type: string + description: port-mirroring-configuration. + configuration-sub-type: + type: string + description: vprobe, pprobe. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + orchestration-status: + type: string + description: Orchestration status of the configuration. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + configuration-selflink: + type: string + description: URL to endpoint where AAI can get more details from SDN-GC. + model-customization-id: + type: string + description: id of the configuration used to customize the resource + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + configurations: + description: | + Collection of configurations + properties: + configuration: + type: array + items: + $ref: "#/getDefinitions/configuration" + connector: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + ###### Related Nodes + - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1) + - FROM service-instance( service-instance Uses connector, MANY2MANY) + + -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also + required: + - resource-instance-id + properties: + resource-instance-id: + type: string + description: Unique id of resource instance. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + connectors: + description: | + Collection of resource instances used to connect a variety of disparate inventory widgets + properties: + connector: + type: array + items: + $ref: "#/getDefinitions/connector" + constrained-element-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4) + - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4) + - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1) + + -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also + required: + - constrained-element-set-uuid + - constraint-type + - check-type + properties: + constrained-element-set-uuid: + type: string + constraint-type: + type: string + check-type: + type: string + resource-version: + type: string + element-choice-sets: + type: array + items: + $ref: "#/getDefinitions/element-choice-set" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/getDefinitions/constrained-element-set" + ctag-assignment: + description: | + ###### Related Nodes + - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4) + - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY) + + -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also + required: + - vlan-id-inner + properties: + vlan-id-inner: + type: integer + format: int64 + description: id. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/getDefinitions/ctag-assignment" + ctag-pool: + description: | + A collection of C tags (vlan tags) grouped for a specific purpose. + ###### Related Nodes + - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4) + - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY) + - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY) + + -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also + required: + - target-pe + - availability-zone-name + - ctag-pool-purpose + properties: + target-pe: + type: string + description: The Target provider edge router + availability-zone-name: + type: string + description: Name of the availability zone + ctag-pool-purpose: + type: string + description: Describes what the intended purpose of this pool is. + ctag-values: + type: string + description: Comma separated list of ctags + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + ctag-pools: + properties: + ctag-pool: + type: array + items: + $ref: "#/getDefinitions/ctag-pool" + customer: + description: | + customer identifiers to provide linkage back to BSS information. + ###### Related Nodes + - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1) + + -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: + type: string + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: + type: string + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: + type: string + description: Subscriber type, a way to provide VID with only the INFRA customers. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-subscriptions: + type: array + items: + $ref: "#/getDefinitions/service-subscription" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: + type: array + items: + $ref: "#/getDefinitions/customer" + cvlan-tag-entry: + required: + - cvlan-tag + properties: + cvlan-tag: + type: integer + format: int64 + description: See mis-na-virtualization-platform.yang + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + cvlan-tags: + properties: + cvlan-tag-entry: + type: array + items: + $ref: "#/getDefinitions/cvlan-tag-entry" + dvs-switch: + description: | + 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. + ###### Related Nodes + - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY) + + required: + - switch-name + - vcenter-url + properties: + switch-name: + type: string + description: DVS switch name + vcenter-url: + type: string + description: URL used to reach the vcenter + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + dvs-switches: + description: | + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + properties: + dvs-switch: + type: array + items: + $ref: "#/getDefinitions/dvs-switch" + edge-prop-names: + description: | + Internal map to define the properties of an edge and interpret the map EdgeRules + properties: + edgeLabel: + type: string + direction: + type: string + multiplicityRule: + type: string + contains-other-v: + type: string + delete-other-v: + type: string + SVC-INFRA: + type: string + prevent-delete: + type: string + edge-tag-query-request: + properties: + edge-tag: + type: string + result-detail: + type: string + start-node-type: + type: string + start-node-filter: + type: array + items: + $ref: "#/getDefinitions/start-node-filter" + include-node-filter: + type: array + items: + $ref: "#/getDefinitions/include-node-filter" + secondary-filter: + type: array + items: + $ref: "#/getDefinitions/secondary-filter" + edge-tag-query-result: + properties: + tagged-inventory-item-list: + type: array + items: + $ref: "#/getDefinitions/tagged-inventory-item-list" + element-choice-set: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4) + - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1) + + -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: + type: string + element-choice-set-name: + type: string + cardinality: + type: string + resource-version: + type: string + model-elements: + type: array + items: + $ref: "#/getDefinitions/model-element" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + element-choice-sets: + properties: + element-choice-set: + type: array + items: + $ref: "#/getDefinitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( entitlement BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also + required: + - group-uuid + - resource-uuid + properties: + group-uuid: + type: string + description: Unique ID for the entitlement group the resource comes from, should be uuid. + resource-uuid: + type: string + description: Unique ID of an entitlement resource. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + entitlements: + description: | + Entitlements, keyed by group-uuid and resource-uuid, related to license management + properties: + entitlement: + type: array + items: + $ref: "#/getDefinitions/entitlement" + esr-ems: + description: | + Persist EMS address information used by EMS driver. + ###### Related Nodes + - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1) + + -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also + required: + - ems-id + properties: + ems-id: + type: string + description: Unique ID of EMS. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-ems-list: + properties: + esr-ems: + type: array + items: + $ref: "#/getDefinitions/esr-ems" + esr-system-info: + description: | + Persist common address information of external systems. + ###### Related Nodes + - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4) + - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) + - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) + - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also + required: + - esr-system-info-id + - user-name + - password + - system-type + properties: + esr-system-info-id: + type: string + description: Unique ID of esr system info. + system-name: + type: string + description: name of external system. + type: + type: string + description: type of external systems. + vendor: + type: string + description: vendor of external systems. + version: + type: string + description: version of external systems. + service-url: + type: string + description: url used to access external systems. + user-name: + type: string + description: username used to access external systems. + password: + type: string + description: password used to access external systems. + system-type: + type: string + description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. + protocol: + type: string + description: protocol of third party SDNC, for example netconf/snmp. + ssl-cacert: + type: string + description: ca file content if enabled ssl on auth-url. + ssl-insecure: + type: boolean + description: Whether to verify VIM's certificate. + ip-address: type: string - description: Name of the volume group. - heat-stack-id: + description: service IP of ftp server. + port: type: string - description: Heat stack id corresponding to this volume-group - vnf-type: + description: service port of ftp server. + cloud-domain: type: string - 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. - orchestration-status: + description: domain info for authentication. + default-tenant: type: string - description: Orchestration status of this volume-group - model-customization-id: + description: default tenant of VIM. + passive: + type: boolean + description: ftp passive mode or not. + remote-path: type: string - description: captures the id of all the configuration used to customize the resource for the service. - vf-module-model-customization-id: + description: resource or performance data file path. + system-status: type: string - description: helps relate the volume group to the vf-module whose components will require the volume group + description: the status of external system. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - volume-groups: + $ref: "#/getDefinitions/relationship" + esr-system-info-list: description: | - Collection of persistent block-level storage. + Collection of persistent block-level external system auth info. properties: - volume-group: + esr-system-info: type: array items: - $ref: "#/definitions/volume-group" - volume: + $ref: "#/getDefinitions/esr-system-info" + esr-thirdparty-sdnc: description: | - Ephemeral Block storage volume. - ###### Default Delete Scope - THIS_NODE_ONLY + Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - FROM vserver (is composed of volume) + - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY) + - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1) + + -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also required: - - volume-id - - volume-selflink + - thirdparty-sdnc-id properties: - volume-id: + thirdparty-sdnc-id: type: string - description: Unique ID of block storage volume relative to the vserver. - volume-selflink: + description: Unique ID of SDNC. + location: type: string - description: URL to endpoint where AAI can get more details + description: used for DC type to indicate the location of SDNC, such as Core or Edge. + product-name: + type: string + description: password used to access SDNC server. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - volumes: - description: | - Collection of ephemeral Block storage volumes. + type: object + $ref: "#/getDefinitions/relationship-list" + esr-thirdparty-sdnc-list: properties: - volume: + esr-thirdparty-sdnc: type: array items: - $ref: "#/definitions/volume" - l3-interface-ipv4-address-list: + $ref: "#/getDefinitions/esr-thirdparty-sdnc" + esr-vnfm: description: | - IPv4 Address Range - ###### Default Delete Scope - THIS_NODE_ONLY + Persist VNFM address information used by VF-C. ###### Related Nodes - - TO instance-group (Many2Many) - - TO l3-network (Many2Many) - - TO subnet (Many2Many) - - FROM l-interface (is composed of l3-interface-ipv4-address-list) - - FROM vlan (is composed of l3-interface-ipv4-address-list) + - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) + + -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also required: - - l3-interface-ipv4-address + - vnfm-id properties: - l3-interface-ipv4-address: + vnfm-id: type: string - description: IP address - l3-interface-ipv4-prefix-length: - type: integer - format: int64 - description: Prefix length, 32 for single address - vlan-id-inner: - type: integer - format: int64 - description: Inner VLAN tag - vlan-id-outer: - type: integer - format: int64 - description: Outer VLAN tag - is-floating: - type: boolean - description: Indicator of fixed or floating address - resource-version: + description: Unique ID of VNFM. + vim-id: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - neutron-network-id: + description: indecate the VIM to deploy VNF. + certificate-url: type: string - description: Neutron network id of the interface that address belongs to - neutron-subnet-id: + description: certificate url of VNFM. + resource-version: type: string - description: Neutron id of subnet that address belongs to + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + esr-system-info-list: + type: object + $ref: "#/getDefinitions/esr-system-info-list" relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: type: array - items: - $ref: "#/definitions/relationship" - l3-interface-ipv6-address-list: + items: + $ref: "#/getDefinitions/esr-vnfm" + evc: description: | - IPv6 Address Range - ###### Default Delete Scope - THIS_NODE_ONLY + evc object is an optional child object of the Configuration object. ###### Related Nodes - - TO instance-group (Many2Many) - - TO l3-network (Many2Many) - - TO subnet (Many2Many) - - FROM l-interface (is composed of l3-interface-ipv6-address-list) - - FROM vlan (is composed of l3-interface-ipv6-address-list) + - TO configuration( evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this EVC is DELETED also required: - - l3-interface-ipv6-address + - evc-id properties: - l3-interface-ipv6-address: + evc-id: type: string - description: IP address - l3-interface-ipv6-prefix-length: - type: integer - format: int64 - description: Prefix length, 128 for single address - vlan-id-inner: - type: integer - format: int64 - description: Inner VLAN tag - vlan-id-outer: - type: integer - format: int64 - description: Outer VLAN tag - is-floating: - type: boolean - description: Indicator of fixed or floating address - resource-version: + description: Unique/key field for the evc object + forwarding-path-topology: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - neutron-network-id: + description: Point-to-Point, Multi-Point + cir-value: type: string - description: Neutron network id of the interface that address belongs to - neutron-subnet-id: + description: Commited Information Rate + cir-units: type: string - description: Neutron id of subnet that address belongs to - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - vlan: - description: | - Definition of vlan - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO l3-interface-ipv4-address-list (comprises vlan, Many2Many) - - TO l3-interface-ipv6-address-list (comprises vlan, Many2Many) - - TO multicast-configuration (Many2Many) - - TO logical-link (Many2Many) - - FROM l-interface (is composed of vlan) - - FROM service-instance - - FROM allotted-resource - required: - - vlan-interface - - in-maint - - is-ip-unnumbered - properties: - vlan-interface: + description: CIR units + connection-diversity-group-id: type: string - description: String that identifies the interface - vlan-id-inner: - type: integer - format: int64 - description: Inner VLAN tag - vlan-id-outer: - type: integer - format: int64 - description: Outer VLAN tag - resource-version: + description: Diversity Group ID + service-hours: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - speed-value: + description: formerly Performance Group + esp-evc-circuit-id: type: string - description: Captures the numeric part of the speed - speed-units: + description: EVC Circuit ID of ESP EVC + esp-evc-cir-value: type: string - description: Captures the units corresponding to the speed - vlan-description: + description: Committed Information Rate (For ESP) + esp-evc-cir-units: type: string - description: Used to describe (the service associated with) the vlan - backdoor-connection: + description: CIR units (For ESP) + esp-itu-code: type: string - description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. - vpn-key: + description: Identifies ESP + collector-pop-clli: type: string - description: This indicates the customers VPN ID associated with this vlan - orchestration-status: + description: Collector POP CLLI (from the hostname of the access pnf) + inter-connect-type-ingress: type: string - description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. - in-maint: - type: boolean - prov-status: + description: Interconnect type on ingress side of EVC. + tagmode-access-ingress: type: string - description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. - is-ip-unnumbered: - type: boolean + description: tagode for collector side of EVC + tagmode-access-egress: + type: string + description: tagMode for network side of EVC relationship-list: type: array items: - $ref: "#/definitions/relationship" - l3-interface-ipv4-address-list: - type: array - items: - $ref: "#/definitions/l3-interface-ipv4-address-list" - l3-interface-ipv6-address-list: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + evcs: + properties: + evc: type: array items: - $ref: "#/definitions/l3-interface-ipv6-address-list" - vlans: + $ref: "#/getDefinitions/evc" + external-system: + description: | + Namespace for external system. properties: - vlan: + esr-ems-list: + type: object + $ref: "#/getDefinitions/esr-ems-list" + esr-vnfm-list: + type: object + $ref: "#/getDefinitions/esr-vnfm-list" + esr-thirdparty-sdnc-list: + type: object + $ref: "#/getDefinitions/esr-thirdparty-sdnc-list" + extra-properties: + description: | + Extra properties for inventory item for response list + properties: + extra-property: type: array items: - $ref: "#/definitions/vlan" - sriov-vf: + $ref: "#/getDefinitions/extra-property" + extra-property: + properties: + property-name: + type: string + property-value: + type: string + flavor: description: | - SR-IOV Virtual Function (not to be confused with virtual network function) - ###### Default Delete Scope - THIS_NODE_ONLY + Openstack flavor. ###### Related Nodes - - TO sriov-pf (Many2One) - - FROM l-interface (is composed of sriov-vf) + - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses flavor, MANY2ONE) + + -FLAVOR cannot be deleted if related to VSERVER + required: - - pci-id + - flavor-id + - flavor-name + - flavor-selflink properties: - pci-id: + flavor-id: type: string - description: PCI ID used to identify the sriov-vf - vf-vlan-filter: + description: Flavor id, expected to be unique across cloud-region. + flavor-name: type: string - description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. - vf-mac-filter: + description: Flavor name + flavor-vcpus: + type: integer + format: int32 + description: Number of CPUs + flavor-ram: + type: integer + format: int32 + description: Amount of memory + flavor-disk: + type: integer + format: int32 + description: Disk space + flavor-ephemeral: + type: integer + format: int32 + description: Amount of ephemeral disk space + flavor-swap: type: string - description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. - vf-vlan-strip: - type: boolean - description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. - vf-vlan-anti-spoof-check: - type: boolean - 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. - vf-mac-anti-spoof-check: + description: amount of swap space allocation + flavor-is-public: type: boolean - 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. - vf-mirrors: + description: whether flavor is available to all users or private to the tenant it was created in. + flavor-selflink: type: string - description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. - vf-broadcast-allow: - type: boolean - description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM - vf-unknown-multicast-allow: - type: boolean - description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM - vf-unknown-unicast-allow: - type: boolean - description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM - vf-insert-stag: + description: URL to endpoint where AAI can get more details + flavor-disabled: type: boolean - description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. - vf-link-status: - type: string - description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + description: Boolean as to whether this flavor is no longer enabled resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - neutron-network-id: - type: string - description: Neutron network id of the interface relationship-list: type: array items: - $ref: "#/definitions/relationship" - sriov-vfs: + $ref: "#/getDefinitions/relationship" + flavors: description: | - Collection of SR-IOV Virtual Functions. + Collection of openstack flavors. properties: - sriov-vf: + flavor: type: array items: - $ref: "#/definitions/sriov-vf" - l-interface: + $ref: "#/getDefinitions/flavor" + forwarder: description: | - Logical interfaces, e.g., a vnic. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO instance-group (Many2Many) - - TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many) - - TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many) - - TO l-interface (comprises l-interface, One2Many) - - TO logical-link (Many2Many) - - TO vlan (comprises l-interface, Many2Many) - - TO sriov-vf (comprises l-interface, One2One) - - FROM generic-vnf (is composed of l-interface) - - FROM lag-interface (is composed of l-interface) - - FROM newvce (is composed of l-interface) - - FROM p-interface (is composed of l-interface) - - FROM vserver (is composed of l-interface) - - FROM allotted-resource - - FROM l-interface (is composed of l-interface) + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4) + - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder Uses configuration, ONE2ONE)(2) + - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE) + + -(2) IF this FORWARDER node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDER is DELETED also required: - - interface-name - - is-port-mirrored - - in-maint - - is-ip-unnumbered + - sequence properties: - interface-name: - type: string - description: Name given to the interface - interface-role: - type: string - description: E.g., CUSTOMER, UPLINK, etc. - v6-wan-link-ip: - type: string - description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. - selflink: - type: string - description: URL to endpoint where AAI can get more details - interface-id: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: type: string - description: ID of interface - macaddr: + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: type: string - description: MAC address for the interface - network-name: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evc: + description: | + forwarder object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also + required: + - forwarder-evc-id + properties: + forwarder-evc-id: type: string - description: Name of the network - management-option: + description: Key for forwarder-evc object + circuit-id: type: string - description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER - interface-description: + description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC + ivlan: type: string - description: Human friendly text regarding this interface. - is-port-mirrored: - type: boolean - resource-version: + description: Internal VLAN. + svlan: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - in-maint: - type: boolean - prov-status: + description: SVLAN value for ingress of egress forwarder. + cvlan: type: string - description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. - is-ip-unnumbered: - type: boolean - vlans: - type: array - items: - $ref: "#/definitions/vlan" - sriov-vfs: - type: array - items: - $ref: "#/definitions/sriov-vf" - l-interfaces: - type: array - items: - $ref: "#/definitions/l-interface" + description: CVLAN value for ingress of egress forwarder. relationship-list: type: array items: - $ref: "#/definitions/relationship" - l3-interface-ipv4-address-list: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + forwarder-evcs: + properties: + forwarder-evc: type: array items: - $ref: "#/definitions/l3-interface-ipv4-address-list" - l3-interface-ipv6-address-list: + $ref: "#/getDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: type: array items: - $ref: "#/definitions/l3-interface-ipv6-address-list" - l-interfaces: + $ref: "#/getDefinitions/forwarder" + forwarding-path: description: | - Collection of logical interfaces. + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4) + - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2) + - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1) + + -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also + -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also + required: + - forwarding-path-id + - forwarding-path-name properties: - l-interface: + forwarding-path-id: + type: string + description: Unique ID of this FP + forwarding-path-name: + type: string + description: Name of the FP + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + selflink: + type: string + description: the self link for this FP + forwarders: + type: array + items: + $ref: "#/getDefinitions/forwarder" + forwarding-paths: + properties: + forwarding-path: type: array items: - $ref: "#/definitions/l-interface" - vserver: + $ref: "#/getDefinitions/forwarding-path" + generic-vnf: description: | - Virtual Servers, aka virtual machine or VM. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO flavor (Many2One) - - TO image (Many2One) - - TO l-interface (comprises vserver, Many2Many) - - TO pserver (Many2One) - - TO volume (comprises vserver, Many2Many) - - TO vnfc (Many2Many) - - TO snapshot (One2One) - - TO vf-module (Many2One) - - FROM generic-vnf - - FROM tenant (is composed of vserver) - - FROM vce + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) + - TO complex( generic-vnf LocatedIn complex, MANY2MANY) + - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) + - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) + - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY) + - TO pnf( generic-vnf HostedOn pnf, MANY2MANY) + - TO pserver( generic-vnf HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1) + - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1) + - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1) + - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1) + - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY) + - FROM platform( platform Uses generic-vnf, MANY2MANY) + + -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also + -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also required: - - vserver-id - - vserver-name - - vserver-selflink + - vnf-id + - vnf-name + - vnf-type - in-maint - is-closed-loop-disabled properties: - vserver-id: + vnf-id: type: string - description: Unique identifier for this vserver relative to its tenant - vserver-name: + description: Unique id of VNF. This is unique across the graph. + vnf-instance-id: type: string - description: Name of vserver - vserver-name2: + description: vnf instance id. + vnf-name: type: string - description: Alternative name of vserver + description: Name of VNF. + vnf-name2: + type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + service-id: + type: string + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. - vserver-selflink: + operational-status: type: string - description: URL to endpoint where AAI can get more details + description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + license-key: + type: string + description: OBSOLETE - do not use + equipment-role: + type: string + description: Client should send valid enumerated value + orchestration-status: + type: string + description: Orchestration status of this VNF, used by MSO. + vnf-package-name: + type: string + vnf-discriptor-name: + type: string + description: vnf discriptor name + job-id: + type: string + description: job id corresponding to vnf + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + management-option: + type: string + description: identifier of managed by ATT or customer + ipv4-oam-address: + type: string + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + nm-lan-v6-address: + type: string + description: v6 Loopback address + management-v6-address: + type: string + description: v6 management address + vcpu: + type: integer + format: int64 + description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE + vmemory: + type: integer + format: int64 + 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 + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE + vdisk: + type: integer + format: int64 + description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE + nshd: + type: integer + format: int64 + description: number of associated SHD in vnf. + nvm: + type: integer + format: int64 + description: number of vms in vnf. + nnet: + type: integer + format: int64 + description: number of network in vnf. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. is-closed-loop-disabled: type: boolean + description: used to indicate whether closed loop function is enabled on this node resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - volumes: - type: array - items: - $ref: "#/definitions/volume" + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + summary-status: + type: string + description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. + encrypted-access-flag: + type: boolean + description: indicates whether generic-vnf access uses SSH + entitlement-assignment-group-uuid: + type: string + description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. + entitlement-resource-uuid: + type: string + description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. + license-assignment-group-uuid: + type: string + description: UUID of the license assignment group. OBSOLETE - See child relationships. + license-key-uuid: + type: string + description: UUID of the actual license resource. OBSOLETE - See child relationships. + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + as-number: + type: string + description: as-number of the VNF + regional-resource-subzone: + type: string + description: represents sub zone of the rr plane + nf-type: + type: string + description: Generic description of the type of NF + nf-function: + type: string + description: English description of Network function that the specific VNF deployment is providing + nf-role: + type: string + description: role in the network that this model will be providing + nf-naming-code: + type: string + description: string assigned to this model used for naming purposes + selflink: + type: string + description: Path to the controller object. + ipv4-oam-gateway-address: + type: string + description: Gateway address + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Prefix length for oam-address + vlan-id-outer: + type: integer + format: int64 + description: Temporary location for S-TAG to get to VCE + nm-profile-name: + type: string + description: Network Management profile of this VNF relationship-list: type: array items: - $ref: "#/definitions/relationship" + $ref: "#/getDefinitions/relationship" l-interfaces: type: array items: - $ref: "#/definitions/l-interface" - vservers: - description: | - Collection of virtual Servers, aka virtual machines or VMs. - properties: - vserver: - type: array - items: - $ref: "#/definitions/vserver" - tenant: - description: | - Openstack tenant - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - TO l3-network (Many2Many) - - TO service-subscription (Many2Many) - - TO vserver (comprises tenant, One2Many) - - FROM auth-info-item - - FROM cloud-region (is composed of tenant) - - FROM group-assignment - - FROM volume-group - required: - - tenant-id - - tenant-name - properties: - tenant-id: - type: string - description: Unique id relative to the cloud-region. - tenant-name: - type: string - description: Readable name of tenant - tenant-context: - type: string - description: This field will store the tenant context. - resource-version: - type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - vservers: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: type: array items: - $ref: "#/definitions/vserver" - relationship-list: + $ref: "#/getDefinitions/lag-interface" + vf-modules: type: array items: - $ref: "#/definitions/relationship" - tenants: - description: | - Collection of openstack tenants. - properties: - tenant: + $ref: "#/getDefinitions/vf-module" + licenses: type: array - items: - $ref: "#/definitions/tenant" - flavor: - description: | - Openstack flavor. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES - ###### Related Nodes - - FROM cloud-region (is composed of flavor) - - FROM vserver - required: - - flavor-id - - flavor-name - - flavor-selflink - properties: - flavor-id: - type: string - description: Flavor id, expected to be unique across cloud-region. - flavor-name: - type: string - description: Flavor name - flavor-vcpus: - type: integer - format: int32 - description: Number of CPUs - flavor-ram: - type: integer - format: int32 - description: Amount of memory - flavor-disk: - type: integer - format: int32 - description: Disk space - flavor-ephemeral: - type: integer - format: int32 - description: Amount of ephemeral disk space - flavor-swap: - type: string - description: amount of swap space allocation - flavor-is-public: - type: boolean - description: whether flavor is available to all users or private to the tenant it was created in. - flavor-selflink: - type: string - description: URL to endpoint where AAI can get more details - flavor-disabled: - type: boolean - description: Boolean as to whether this flavor is no longer enabled - resource-version: - type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: + items: + $ref: "#/getDefinitions/license" + entitlements: type: array items: - $ref: "#/definitions/relationship" - flavors: + $ref: "#/getDefinitions/entitlement" + generic-vnfs: description: | - Collection of openstack flavors. + Collection of VNFs properties: - flavor: + generic-vnf: type: array items: - $ref: "#/definitions/flavor" + $ref: "#/getDefinitions/generic-vnf" group-assignment: description: | Openstack group-assignment used to store exclusivity groups (EG). - ###### Default Delete Scope - THIS_NODE_ONLY ###### Related Nodes - - TO tenant (Many2Many) - - TO pserver (One2Many) - - FROM cloud-region (is composed of group-assignment) + - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant MemberOf group-assignment, MANY2MANY) + required: - group-id - group-type @@ -39707,7 +56393,7 @@ definitions: relationship-list: type: array items: - $ref: "#/definitions/relationship" + $ref: "#/getDefinitions/relationship" group-assignments: description: | Collection of openstack group assignments @@ -39715,103 +56401,121 @@ definitions: group-assignment: type: array items: - $ref: "#/definitions/group-assignment" - snapshot: + $ref: "#/getDefinitions/group-assignment" + host-route: description: | - Openstack snapshot - ###### Default Delete Scope - THIS_NODE_ONLY ###### Related Nodes - - FROM cloud-region (is composed of snapshot) - - FROM vserver + - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also required: - - snapshot-id + - host-route-id + - route-prefix + - next-hop properties: - snapshot-id: - type: string - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. - snapshot-name: + host-route-id: type: string - description: Snapshot name - snapshot-architecture: + description: host-route id + route-prefix: type: string - description: Operating system architecture - snapshot-os-distro: + description: subnet prefix + next-hop: type: string - description: The common name of the operating system distribution in lowercase - snapshot-os-version: + description: Could be ip-address, hostname, or service-instance + next-hop-type: type: string - description: The operating system version as specified by the distributor. - application: + description: Should be ip-address, hostname, or service-instance to match next-hop + resource-version: type: string - description: The application that the image instantiates. - application-vendor: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/getDefinitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE) + - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1) + + -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: type: string - description: The vendor of the application. - application-version: + description: UUID to uniquely identify a HPA capability + hpa-feature: type: string - description: The version of the application. - snapshot-selflink: + description: Name of the HPACapability + hpa-version: type: string - description: URL to endpoint where AAI can get more details - prev-snapshot-id: + description: HPA schema version + architecture: type: string - description: This field contains the UUID of the previous snapshot (if any). + description: Hardware architecture resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - snapshots: - description: | - Collection of openstack snapshots - properties: - snapshot: + $ref: "#/getDefinitions/relationship" + hpa-feature-attributes: type: array items: - $ref: "#/definitions/snapshot" - metadatum: + $ref: "#/getDefinitions/hpa-feature-attributes" + hpa-feature-attributes: description: | - Key/value pairs - ###### Default Delete Scope - THIS_NODE_ONLY + HPA Capability Feature attributes ###### Related Nodes - - FROM image (is composed of metadatum) - - FROM model-ver (is composed of metadatum) - - FROM service-instance (is composed of metadatum) - - FROM connector (is composed of metadatum) + - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also required: - - metaname - - metaval + - hpa-attribute-key properties: - metaname: + hpa-attribute-key: type: string - metaval: + description: name of the specific HPA attribute + hpa-attribute-value: type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - metadata: - description: | - Collection of metadatum (key/value pairs) - ###### Default Delete Scope - THIS_NODE_ONLY - properties: - metadatum: + relationship-list: type: array - items: - $ref: "#/definitions/metadatum" + items: + $ref: "#/getDefinitions/relationship" image: description: | Openstack image. - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE ###### Related Nodes - - TO metadatum (comprises image, Many2Many) - - FROM cloud-region (is composed of image) - - FROM vserver + - TO cloud-region( image BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1) + - FROM vserver( vserver Uses image, MANY2ONE) + + -(1) IF this IMAGE node is deleted, this FROM node is DELETED also + -IMAGE cannot be deleted if related to VSERVER + required: - image-id - image-name @@ -39852,11 +56556,11 @@ definitions: relationship-list: type: array items: - $ref: "#/definitions/relationship" + $ref: "#/getDefinitions/relationship" metadata: type: array items: - $ref: "#/definitions/metadatum" + $ref: "#/getDefinitions/metadatum" images: description: | Collectio of Openstack images. @@ -39864,425 +56568,588 @@ definitions: image: type: array items: - $ref: "#/definitions/image" - dvs-switch: - description: | - 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. - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - TO availability-zone (Many2Many) - - FROM cloud-region (is composed of dvs-switch) - required: - - switch-name - - vcenter-url + $ref: "#/getDefinitions/image" + include-node-filter: properties: - switch-name: - type: string - description: DVS switch name - vcenter-url: - type: string - description: URL used to reach the vcenter - resource-version: + include-node-type: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - dvs-switches: + instance-filter: description: | - Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. + InstanceFilter for performing a named-query or model query + instance-filters: + description: | + InstanceFilters for performing a named-query or model query properties: - dvs-switch: + instance-filter: type: array items: - $ref: "#/definitions/dvs-switch" - oam-network: + $ref: "#/getDefinitions/instance-filter" + instance-group: description: | - OAM network, to be deprecated shortly. Do not use for new purposes. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES + General mechanism for grouping instances ###### Related Nodes - - TO complex (Many2Many) - - TO service-capability (Many2Many) - - FROM cloud-region (is composed of oam-network) + - TO model( instance-group Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY) + - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) + required: - - network-uuid - - network-name - - cvlan-tag + - id + - description + - type properties: - network-uuid: + instance-group-role: type: string - description: UUID of the network. Unique across a cloud-region - network-name: + description: role of the instance group. + model-invariant-id: type: string - description: Name of the network. - cvlan-tag: - type: integer - format: int64 - description: cvlan-id - ipv4-oam-gateway-address: + description: ASDC model id for this resource or service model. + model-version-id: type: string - description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network - ipv4-oam-gateway-address-prefix-length: - type: integer - format: int32 - description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + description: ASDC model version uid for this resource model. + id: + type: string + description: Instance Group ID, UUID assigned to this instance. + description: + type: string + description: Descriptive text to help identify the usage of this instance-group + type: + type: string + description: Only valid value today is lower case ha for high availability + sub-type: + type: string + description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + description: Concurrency value relationship-list: type: array items: - $ref: "#/definitions/relationship" - oam-networks: + $ref: "#/getDefinitions/relationship" + instance-groups: description: | - Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. + Collection of openstack route table references properties: - oam-network: + instance-group: type: array items: - $ref: "#/definitions/oam-network" - availability-zone: - description: | - Availability zone, a collection of compute hosts/pservers - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES - ###### Related Nodes - - TO complex (Many2Many) - - TO service-capability (Many2Many) - - FROM cloud-region (is composed of availability-zone) - - FROM ctag-pool - - FROM dvs-switch - - FROM generic-vnf - - FROM pserver - - FROM vce - required: - - availability-zone-name - - hypervisor-type + $ref: "#/getDefinitions/instance-group" + inventory: properties: - availability-zone-name: + search: + type: object + $ref: "#/getDefinitions/search" + actions: + type: object + $ref: "#/getDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/getDefinitions/cloud-infrastructure" + external-system: + type: object + $ref: "#/getDefinitions/external-system" + business: + type: object + $ref: "#/getDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/getDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/getDefinitions/network" + nodes: + type: object + $ref: "#/getDefinitions/nodes" + inventory-item: + properties: + inventory-item-type: type: string - description: Name of the availability zone. Unique across a cloud region - hypervisor-type: + inventory-item-link: type: string - description: Type of hypervisor. Source of truth should define valid values. - operational-status: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" + tagged-inventory-item-list: + type: array + items: + $ref: "#/getDefinitions/tagged-inventory-item-list" + inventory-item-data: + properties: + property-name: type: string - description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. - resource-version: + property-value: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - availability-zones: + inventory-response-item: description: | - Collection of availability zones + Inventory item for response list properties: - availability-zone: + model-name: + type: string + extra-properties: + type: object + $ref: "#/getDefinitions/extra-properties" + inventory-response-items: + type: object + $ref: "#/getDefinitions/inventory-response-items" + inventory-response-items: + description: | + Container for inventory items in response list + properties: + inventory-response-item: type: array items: - $ref: "#/definitions/availability-zone" - auth-info-item: + $ref: "#/getDefinitions/inventory-response-item" + ipsec-configuration: description: | - Persistent auth info. + 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 ###### Related Nodes - - TO tenant (One2One) - - FROM cloud-region (is composed of auth-info-item) + - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1) + + -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also required: - - auth-info-item-id - - cloud-domain - - username - - password - - auth-url - - ssl-cacert - - ssl-insecure + - ipsec-configuration-id properties: - auth-info-item-id: + ipsec-configuration-id: type: string - description: Unique ID of auth-info-item. - cloud-domain: + description: UUID of this configuration + requested-vig-address-type: type: string - description: domain info for authentication. - username: + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: type: string - description: user name of auth infomation to access VIM. - password: + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: type: string - description: password of auth infomation to access VIM. - auth-url: + description: ATT can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: type: string - description: authentication url of the cloud. - ssl-cacert: + description: Network address of shared DMZ + requested-customer-name: type: string - description: ca file content if enabled ssl on auth-url. - ssl-insecure: - type: boolean - description: Whether to verify VIM's certificate. + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: + type: string + description: can be 1 or 2 + ikev1-authentication: + type: string + description: Contains values like md5, sha1, sha256, sha384 + ikev1-encryption: + type: string + description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc + ikev1-dh-group: + type: string + description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 + ikev1-am-group-id: + type: string + description: Group name defined in VIG for clients using aggressive mode + ikev1-am-password: + type: string + description: pre-shared key for the above group name + ikev1-sa-lifetime: + type: string + description: Lifetime for IKEv1 SA + ipsec-authentication: + type: string + description: md5, sha1, sha256, sha384 + ipsec-encryption: + type: string + description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc + ipsec-sa-lifetime: + type: string + description: Life time for IPSec SA + ipsec-pfs: + type: string + description: enable PFS or not + xauth-userid: + type: string + description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName + xauth-user-password: + type: string + description: Encrypted using the Juniper $9$ algorithm + dpd-interval: + type: string + description: The time between DPD probe + dpd-frequency: + type: string + description: Maximum number of DPD before claiming the tunnel is down + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - auth-info-items: - description: | - Collection of persistent auth information to access to VIM. + $ref: "#/getDefinitions/relationship" + vig-servers: + type: array + items: + $ref: "#/getDefinitions/vig-server" + ipsec-configurations: properties: - auth-info-item: + ipsec-configuration: type: array items: - $ref: "#/definitions/auth-info-item" - cloud-region: + $ref: "#/getDefinitions/ipsec-configuration" + key-data: + properties: + key-name: + type: string + key-value: + type: string + l-interface: description: | - cloud-region designates an installation of a cloud cluster or region or instantiation. - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - TO complex (Many2One) - - TO l3-network (Many2Many) - - TO tenant (comprises cloud-region, One2Many) - - TO auth-info-item (comprises cloud-region, One2Many) - - TO image (comprises cloud-region, One2Many) - - TO flavor (comprises cloud-region, One2Many) - - TO availability-zone (comprises cloud-region, One2Many) - - TO oam-network (comprises cloud-region, One2Many) - - TO dvs-switch (comprises cloud-region, One2Many) - - TO volume-group (comprises cloud-region, One2Many) - - TO group-assignment (comprises cloud-region, One2Many) - - TO snapshot (comprises cloud-region, One2Many) - - TO zone (Many2One) - - FROM pserver - - FROM logical-link + Logical interfaces, e.g., a vnic. + ###### Related Nodes + - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4) + - TO instance-group( l-interface MemberOf instance-group, MANY2MANY) + - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2) + - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4) + - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4) + - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4) + - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) + - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1) + - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1) + - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4) + + -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also required: - - cloud-owner - - cloud-region-id - - sriov-automation + - interface-name + - is-port-mirrored + - in-maint + - is-ip-unnumbered properties: - cloud-owner: + interface-name: type: string - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - cloud-region-id: + description: Name given to the interface + interface-role: type: string - description: Identifier used by the vendor for the region. Second part of composite key - cloud-type: + description: E.g., CUSTOMER, UPLINK, etc. + v6-wan-link-ip: type: string - description: Type of the cloud (e.g., openstack) - owner-defined-type: + description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. + selflink: type: string - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - cloud-region-version: + description: URL to endpoint where AAI can get more details + interface-id: type: string - description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. - identity-url: + description: ID of interface + macaddr: type: string - description: URL of the keystone identity service - cloud-zone: + description: MAC address for the interface + network-name: type: string - description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. - complex-name: + description: Name of the network + management-option: type: string - description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. - sriov-automation: + description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER + interface-description: + type: string + description: Human friendly text regarding this interface. + is-port-mirrored: type: boolean + description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - volume-groups: - type: array - items: - $ref: "#/definitions/volume-group" - tenants: - type: array - items: - $ref: "#/definitions/tenant" - flavors: - type: array - items: - $ref: "#/definitions/flavor" - group-assignments: - type: array - items: - $ref: "#/definitions/group-assignment" - snapshots: - type: array - items: - $ref: "#/definitions/snapshot" - images: - type: array - items: - $ref: "#/definitions/image" - dvs-switches: + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + prov-status: + type: string + description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. + allowed-address-pairs: + type: string + description: Freeform field for storing an ip address, list of ip addresses or a subnet block. + vlans: type: array items: - $ref: "#/definitions/dvs-switch" - oam-networks: + $ref: "#/getDefinitions/vlan" + sriov-vfs: type: array items: - $ref: "#/definitions/oam-network" - availability-zones: + $ref: "#/getDefinitions/sriov-vf" + l-interfaces: type: array items: - $ref: "#/definitions/availability-zone" + $ref: "#/getDefinitions/l-interface" relationship-list: type: array items: - $ref: "#/definitions/relationship" - auth-info-items: - type: array - items: - $ref: "#/definitions/auth-info-item" - cloud-regions: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + l-interfaces: + description: | + Collection of logical interfaces. properties: - cloud-region: + l-interface: type: array items: - $ref: "#/definitions/cloud-region" - network-profile: + $ref: "#/getDefinitions/l-interface" + l3-interface-ipv4-address-list: description: | - Network profile populated by SDN-GP for SNMP - ###### Default Delete Scope - THIS_NODE_ONLY + IPv4 Address Range ###### Related Nodes - - FROM generic-vnf + - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also required: - - nm-profile-name + - l3-interface-ipv4-address properties: - nm-profile-name: - type: string - description: Unique name of network profile. - community-string: + l3-interface-ipv4-address: type: string - description: Encrypted SNMP community string + description: IP address + l3-interface-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to relationship-list: type: array items: - $ref: "#/definitions/relationship" - network-profiles: - description: | - Collection of network profiles - properties: - network-profile: - type: array - items: - $ref: "#/definitions/network-profile" - sriov-pf: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv6-address-list: description: | - SR-IOV Physical Function - ###### Default Delete Scope - THIS_NODE_ONLY + IPv6 Address Range ###### Related Nodes - - FROM p-interface (is composed of sriov-pf) - - FROM sriov-vf + - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4) + - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4) + - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also required: - - pf-pci-id + - l3-interface-ipv6-address properties: - pf-pci-id: + l3-interface-ipv6-address: type: string - description: Identifier for the sriov-pf + description: IP address + l3-interface-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to relationship-list: type: array items: - $ref: "#/definitions/relationship" - sriov-pfs: - description: | - Collection of SR-IOV Physical Functions. - properties: - sriov-pf: - type: array - items: - $ref: "#/definitions/sriov-pf" - p-interface: + $ref: "#/getDefinitions/relationship" + l3-network: description: | - Physical interface (e.g., nic) - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO l-interface (comprises p-interface, Many2Many) - - TO physical-link (Many2Many) - - TO logical-link (Many2One) - - TO sriov-pf (comprises p-interface, One2One) - - FROM lag-interface - - FROM pserver (is composed of p-interface) - - FROM pnf (is composed of p-interface) - - FROM vpls-pe (is composed of p-interface) + Generic network definition + ###### Related Nodes + - TO instance-group( l3-network MemberOf instance-group, MANY2MANY) + - TO network-policy( l3-network Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) + - FROM complex( complex Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1) + - FROM tenant( tenant Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY) + + -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also required: - - interface-name - - in-maint + - network-id + - network-name + - is-bound-to-vpn + - is-provider-network + - is-shared-network + - is-external-network properties: - interface-name: - type: string - description: Name that identifies the physical interface - speed-value: + network-id: type: string - description: Captures the numeric part of the speed - speed-units: + description: Network ID, should be uuid. Unique across A&AI. + network-name: type: string - description: Captures the units corresponding to the speed - port-description: + description: Name of the network, governed by some naming convention.. + network-type: type: string - description: Nature of the services and connectivity on this port. - equipment-identifier: + description: Type of the network - who defines these values? + network-role: type: string - description: CLEI or other specification for p-interface hardware. - interface-role: + description: Role the network plans - who defines these values? + network-technology: type: string - description: Role specification for p-interface hardware. - interface-type: + description: Network technology - who defines these values? + neutron-network-id: type: string - description: Indicates the physical properties of the interface. - prov-status: + description: Neutron network id of this Interface + is-bound-to-vpn: + type: boolean + description: Set to true if bound to VPN + service-id: type: string - description: Trigger for operational monitoring of this resource by Service Assurance systems. + description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED + network-role-instance: + type: integer + format: int64 + description: network role instance resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - in-maint: + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + contrail-network-fqdn: + type: string + description: Contrail FQDN for the network + model-invariant-id: + type: string + description: the ASDC model id for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + physical-network-name: + type: string + description: Name associated with the physical network. + is-provider-network: type: boolean - inv-status: + description: boolean indicatating whether or not network is a provider network. + is-shared-network: + type: boolean + description: boolean indicatating whether or not network is a shared network. + is-external-network: + type: boolean + description: boolean indicatating whether or not network is an external network. + selflink: type: string - description: inventory status - relationship-list: + description: Path to the controller object. + operational-status: + type: string + description: Indicator for whether the resource is considered operational. + subnets: type: array items: - $ref: "#/definitions/relationship" - sriov-pfs: + $ref: "#/getDefinitions/subnet" + ctag-assignments: type: array items: - $ref: "#/definitions/sriov-pf" - l-interfaces: + $ref: "#/getDefinitions/ctag-assignment" + segmentation-assignments: type: array items: - $ref: "#/definitions/l-interface" - p-interfaces: - description: | - Collection of physical interfaces. + $ref: "#/getDefinitions/segmentation-assignment" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding + l3-networks: properties: - p-interface: + l3-network: type: array items: - $ref: "#/definitions/p-interface" + $ref: "#/getDefinitions/l3-network" lag-interface: description: | Link aggregate interface - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO logical-link (Many2Many) - - TO lag-link (Many2Many) - - TO p-interface (Many2Many) - - TO l-interface (comprises lag-interface, Many2Many) - - FROM generic-vnf (is composed of lag-interface) - - FROM pserver (is composed of lag-interface) - - FROM pnf (is composed of lag-interface) - - FROM vpls-pe (is composed of lag-interface) + ###### Related Nodes + - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4) + - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2) + - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2) + - TO p-interface( lag-interface Uses p-interface, MANY2MANY) + - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1) + + -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also required: - interface-name - in-maint @@ -40313,14 +57180,15 @@ definitions: description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: - $ref: "#/definitions/relationship" + $ref: "#/getDefinitions/relationship" l-interfaces: type: array items: - $ref: "#/definitions/l-interface" + $ref: "#/getDefinitions/l-interface" lag-interfaces: description: | Collection of link aggregate interfaces. @@ -40328,397 +57196,146 @@ definitions: lag-interface: type: array items: - $ref: "#/definitions/lag-interface" - pserver: + $ref: "#/getDefinitions/lag-interface" + lag-link: description: | - Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE - ###### Related Nodes - - TO complex (Many2One) - - TO cloud-region (Many2One) - - TO availability-zone (Many2One) - - TO lag-interface (comprises pserver, Many2Many) - - TO p-interface (comprises pserver, Many2Many) - - TO zone (Many2One) - - FROM generic-vnf - - FROM group-assignment - - FROM vserver - - FROM logical-link + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses lag-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also required: - - hostname - - in-maint + - link-name properties: - hostname: - type: string - description: Value from executing hostname on the compute node. - ptnii-equip-name: - type: string - description: PTNII name - number-of-cpus: - type: integer - format: int32 - description: Number of cpus - disk-in-gigabytes: - type: integer - format: int32 - description: Disk size, in GBs - ram-in-megabytes: - type: integer - format: int32 - description: RAM size, in MBs - equip-type: - type: string - description: Equipment type. Source of truth should define valid values. - equip-vendor: - type: string - description: Equipment vendor. Source of truth should define valid values. - equip-model: - type: string - description: Equipment model. Source of truth should define valid values. - fqdn: - type: string - description: Fully-qualified domain name - pserver-selflink: - type: string - description: URL to endpoint where AAI can get more details - ipv4-oam-address: - type: string - description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. - serial-number: - type: string - description: Serial number, may be queried - ipaddress-v4-loopback-0: - type: string - description: IPV4 Loopback 0 address - ipaddress-v6-loopback-0: - type: string - description: IPV6 Loopback 0 address - ipaddress-v4-aim: - type: string - description: IPV4 AIM address - ipaddress-v6-aim: - type: string - description: IPV6 AIM address - ipaddress-v6-oam: - type: string - description: IPV6 OAM address - inv-status: - type: string - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. - pserver-id: - type: string - description: ID of Pserver - internet-topology: + link-name: type: string - description: internet topology of Pserver - in-maint: - type: boolean + description: Alphabetical concatenation of lag-interface names resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - pserver-name2: - type: string - description: alternative pserver name - purpose: - type: string - description: purpose of pserver - prov-status: - type: string - description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] - management-option: - type: string - description: Indicates who owns and or manages the device. - host-profile: - type: string - description: The host profile that defines the configuration of the pserver. relationship-list: type: array items: - $ref: "#/definitions/relationship" - p-interfaces: - type: array - items: - $ref: "#/definitions/p-interface" - lag-interfaces: - type: array - items: - $ref: "#/definitions/lag-interface" - pservers: + $ref: "#/getDefinitions/relationship" + lag-links: description: | - Collection of compute hosts. + Collection of link aggregation connections properties: - pserver: + lag-link: type: array items: - $ref: "#/definitions/pserver" - virtual-data-center: + $ref: "#/getDefinitions/lag-link" + license: description: | - Virtual organization of cloud infrastructure elements in a data center context - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Metadata for license group. ###### Related Nodes - - TO generic-vnf (Many2Many) - - TO logical-link (Many2Many) - - FROM connector + - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4) + - TO vce( license BelongsTo vce, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this LICENSE is DELETED also required: - - vdc-id - - vdc-name + - group-uuid + - resource-uuid properties: - vdc-id: + group-uuid: type: string - description: Unique ID of the vdc - vdc-name: + description: Unique ID for the license group the resource belongs to, should be uuid. + resource-uuid: type: string - description: Name of the virtual data center + description: Unique ID of a license resource. resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + description: Concurrency value relationship-list: type: array items: - $ref: "#/definitions/relationship" - virtual-data-centers: + $ref: "#/getDefinitions/relationship" + licenses: description: | - Virtual organization of cloud infrastructure elements in a data center context + Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management properties: - virtual-data-center: + license: type: array items: - $ref: "#/definitions/virtual-data-center" - cloud-infrastructure: - description: | - Namespace for cloud infrastructure. - properties: - complexes: - type: array - items: - $ref: "#/definitions/complex" - cloud-regions: - type: array - items: - $ref: "#/definitions/cloud-region" - network-profiles: - type: array - items: - $ref: "#/definitions/network-profile" - pservers: - type: array - items: - $ref: "#/definitions/pserver" - virtual-data-centers: - type: array - items: - $ref: "#/definitions/virtual-data-center" - connector: + $ref: "#/getDefinitions/license" + line-of-business: description: | - Collection of resource instances used to connect a variety of disparate inventory widgets - ###### Default Delete Scope - CASCADE_TO_CHILDREN + describes a line-of-business ###### Related Nodes - - TO virtual-data-center (Many2Many) - - TO metadatum (comprises connector, Many2Many) - - FROM service-instance + - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) + required: - - resource-instance-id + - line-of-business-name properties: - resource-instance-id: + line-of-business-name: type: string - description: Unique id of resource instance. + description: Name of the line-of-business (product) resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-invariant-id: - type: string - description: the ASDC model id for this resource or service model. - model-version-id: - type: string - description: the ASDC model version for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - widget-model-id: - type: string - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - widget-model-version: - type: string - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. relationship-list: type: array items: - $ref: "#/definitions/relationship" - metadata: - type: array - items: - $ref: "#/definitions/metadatum" - connectors: + $ref: "#/getDefinitions/relationship" + lines-of-business: description: | - Collection of resource instances used to connect a variety of disparate inventory widgets + Collection of lines-of-business properties: - connector: + line-of-business: type: array items: - $ref: "#/definitions/connector" - tunnel-xconnect: + $ref: "#/getDefinitions/line-of-business" + logical-link: description: | - Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted - ###### Default Delete Scope - THIS_NODE_ONLY + Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - FROM allotted-resource (is composed of tunnel-xconnect) - required: - - id - - bandwidth-up-wan1 - - bandwidth-down-wan1 - - bandwidth-up-wan2 - - bandwidth-down-wan2 - properties: - id: - type: string - description: Allotted Resource id UUID assigned to this instance. - bandwidth-up-wan1: - type: string - description: The WAN uplink bandwidth for WAN1 - bandwidth-down-wan1: - type: string - description: The WAN downlink bandwidth for WAN1 - bandwidth-up-wan2: - type: string - description: The WAN uplink bandwidth for WAN2 - bandwidth-down-wan2: - type: string - description: The WAN downlink bandwidth for WAN2 - resource-version: - type: string - description: Concurrency value - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - tunnel-xconnects: - description: | - This object is used to store the specific tunnel cross connect aspects of an allotted resource - properties: - tunnel-xconnect: - type: array - items: - $ref: "#/definitions/tunnel-xconnect" - allotted-resource: - description: | - Represents a slice or partial piece of a resource that gets separately allotted - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO generic-vnf (Many2Many) - - TO l3-network (Many2Many) - - TO instance-group (Many2Many) - - TO network-policy (One2One) - - TO vlan (Many2Many) - - TO l-interface (One2Many) - - TO tunnel-xconnect (comprises allotted-resource, One2One) - - TO vpn-binding (Many2Many) - - TO allotted-resource (One2One) - - FROM service-instance (is composed of allotted-resource) - - FROM service-instance - - FROM allotted-resource - required: - - id - properties: - id: - type: string - description: Allotted Resource id UUID assigned to this instance. - description: - type: string - description: The descriptive information assigned to this allotted resource instance - selflink: - type: string - description: Link back to more information in the controller - model-invariant-id: - type: string - description: the ASDC model id for this resource or service model. - model-version-id: - type: string - description: the ASDC model version for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - resource-version: - type: string - description: Concurrency value - orchestration-status: - type: string - description: Orchestration status - operational-status: - type: string - description: Indicator for whether the resource is considered operational - type: - type: string - description: Generic description of the type of allotted resource. - role: - type: string - description: role in the network that this resource will be providing. - tunnel-xconnects: - type: array - items: - $ref: "#/definitions/tunnel-xconnect" - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - allotted-resources: - description: | - This object is used to store slices of services being offered - properties: - allotted-resource: - type: array - items: - $ref: "#/definitions/allotted-resource" - service-instance: - description: | - Instance of a service - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO zone (Many2One) - - TO cvlan-tag (Many2Many) - - TO pnf (One2Many) - - TO connector (Many2Many) - - TO metadatum (comprises service-instance, Many2Many) - - TO logical-link (Many2Many) - - TO vlan (One2Many) - - TO service-instance (One2Many) - - TO ctag-assignment (One2Many) - - TO instance-group (Many2Many) - - TO allotted-resource (comprises service-instance, Many2Many) - - TO allotted-resource (Many2Many) - - FROM generic-vnf - - FROM l3-network - - FROM service-subscription (is composed of service-instance) - - FROM vce - - FROM service-instance + - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link Uses lag-link, MANY2MANY) + - TO logical-link( logical-link Uses logical-link, MANY2MANY) + - TO pnf( logical-link BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) + - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) + - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) + - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) + - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3) + - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) + - FROM logical-link( logical-link Uses logical-link, MANY2MANY) + + -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also required: - - service-instance-id - - service-type - - service-role + - link-name + - in-maint + - link-type properties: - service-instance-id: + link-name: type: string - description: Uniquely identifies this instance of a service - service-instance-name: + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + link-type: type: string - description: This field will store a name assigned to the service-instance. - service-type: + description: Type of logical link, e.g., evc + speed-value: type: string - description: String capturing type of service. - service-role: + description: Captures the numeric part of the speed + speed-units: type: string - description: String capturing the service role. - environment-context: + description: Captures the units corresponding to the speed + ip-version: type: string - description: This field will store the environment context assigned to the service-instance. - workload-context: + description: v4, v6, or ds for dual stack + routing-protocol: type: string - description: This field will store the workload context assigned to the service-instance. + description: For example, static or BGP + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. @@ -40734,427 +57351,770 @@ definitions: widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - bandwidth-total: + operational-status: type: string - description: Indicates the total bandwidth to be used for this service. - bandwidth-up-wan1: + description: Indication of operational status of the logical link. + prov-status: type: string - description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. - bandwidth-down-wan1: + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: type: string - description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. - bandwidth-up-wan2: + description: Indication of the network use of the logical link. + link-name2: type: string - description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. - bandwidth-down-wan2: + description: Alias or alternate name (CLCI or D1 name). + link-id: type: string - description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. - vhn-portal-url: + description: UUID of the logical-link, SDNC generates this. + circuit-id: type: string - description: URL customers will use to access the vHN Portal. - service-instance-location-id: + description: Circuit id + purpose: + type: string + description: Reason for this entity, role it is playing + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + logical-links: + description: | + Collection of logical connections + properties: + logical-link: + type: array + items: + $ref: "#/getDefinitions/logical-link" + metadata: + description: | + Collection of metadatum (key/value pairs) + properties: + metadatum: + type: array + items: + $ref: "#/getDefinitions/metadatum" + metadatum: + description: | + Key/value pairs + ###### Related Nodes + - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4) + - TO connector( metadatum BelongsTo connector, MANY2ONE)(4) + - TO image( metadatum BelongsTo image, MANY2ONE)(4) + - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4) + - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this METADATUM is DELETED also + required: + - metaname + - metaval + properties: + metaname: + type: string + metaval: type: string - description: An identifier that customers assign to the location where this service is being used. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - selflink: + model: + description: | + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version + ###### Related Nodes + - TO model( model-ver BelongsTo model, MANY2ONE)(1) + - FROM instance-group( instance-group Targets model, MANY2MANY) + - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1) + - FROM named-query( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element IsA model, MANY2ONE) + + -(1) IF this MODEL node is deleted, this FROM node is DELETED also + -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + + required: + - model-invariant-id + - model-type + properties: + model-invariant-id: type: string - description: Path to the controller object. - orchestration-status: + description: Unique identifier corresponding to the main definition of a model in ASDC + model-type: type: string - description: Orchestration status of this service. - relationship-list: + description: Type of the model, e.g., service, resource, widget, etc. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-vers: type: array items: - $ref: "#/definitions/relationship" - metadata: + $ref: "#/getDefinitions/model-ver" + relationship-list: type: array items: - $ref: "#/definitions/metadatum" - allotted-resources: + $ref: "#/getDefinitions/relationship" + model-and-named-query-search: + description: | + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query + properties: + query-parameters: + type: object + $ref: "#/getDefinitions/query-parameters" + instance-filters: + type: object + $ref: "#/getDefinitions/instance-filters" + secondary-filts: + type: object + $ref: "#/getDefinitions/secondary-filts" + top-node-type: + type: string + secondary-filter-cut-point: + type: string + model-constraint: + description: | + This is how we would capture constraints defining allowed sets of elements. + ###### Related Nodes + - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1) + + -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also + required: + - model-constraint-uuid + - constrained-element-set-uuid-to-replace + properties: + model-constraint-uuid: + type: string + constrained-element-set-uuid-to-replace: + type: string + constrained-element-sets: type: array items: - $ref: "#/definitions/allotted-resource" - service-instances: - description: | - Collection of service instances + $ref: "#/getDefinitions/constrained-element-set" + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-constraints: properties: - service-instance: + model-constraint: type: array items: - $ref: "#/definitions/service-instance" - service-subscription: + $ref: "#/getDefinitions/model-constraint" + model-element: description: | - Object that group service instances. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Defines how other models combine to make up a higher-level model. ###### Related Nodes - - TO service-instance (comprises service-subscription, Many2Many) - - FROM customer (is composed of service-subscription) - - FROM tenant + - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4) + - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4) + - TO model-ver( model-element IsA model-ver, MANY2ONE) + - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4) + - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1) + - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1) + - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4) + + -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also required: - - service-type + - model-element-uuid + - new-data-del-flag + - cardinality properties: - service-type: + model-element-uuid: type: string - description: Value defined by orchestration to identify this service across ECOMP. - temp-ub-sub-account-id: + new-data-del-flag: + type: string + description: Indicates whether this element was created as part of instantiation from this model + cardinality: + type: string + description: How many of this type of element are required/allowed + linkage-points: type: string - description: This property will be deleted from A&AI in the near future. Only stop gap solution. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - service-instances: + model-elements: type: array items: - $ref: "#/definitions/service-instance" + $ref: "#/getDefinitions/model-element" + description: Defines how other models combine to make up a higher-level model + model-constraints: + type: array + items: + $ref: "#/getDefinitions/model-constraint" + description: Describes new constraints on this model element that are not part of that model's definition relationship-list: type: array items: - $ref: "#/definitions/relationship" - service-subscriptions: - description: | - Collection of objects that group service instances. + $ref: "#/getDefinitions/relationship" + model-elements: properties: - service-subscription: + model-element: type: array items: - $ref: "#/definitions/service-subscription" - customer: + $ref: "#/getDefinitions/model-element" + model-ver: description: | - customer identifiers to provide linkage back to BSS information. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - - TO service-subscription (comprises customer, Many2Many) + - TO model( model-ver BelongsTo model, MANY2ONE)(4) + - FROM model-element( model-element IsA model-ver, MANY2ONE) + - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1) + + -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this MODEL-VER is DELETED also + -MODEL-VER cannot be deleted if related to MODEL-ELEMENT + required: - - global-customer-id - - subscriber-name - - subscriber-type + - model-version-id + - model-name + - model-version properties: - global-customer-id: + model-version-id: type: string - description: Global customer id used across ECOMP to uniquely identify customer. - subscriber-name: + description: Unique identifier corresponding to one version of a model in ASDC + model-name: type: string - description: Subscriber name, an alternate way to retrieve a customer. - subscriber-type: + description: Name of the model, which can change from version to version. + model-version: type: string - description: Subscriber type, a way to provide VID with only the INFRA customers. + description: Version + model-description: + type: string + description: Description resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - service-subscriptions: + model-elements: type: array items: - $ref: "#/definitions/service-subscription" + $ref: "#/getDefinitions/model-element" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" relationship-list: type: array items: - $ref: "#/definitions/relationship" - customers: - description: | - Collection of customer identifiers to provide linkage back to BSS information. + $ref: "#/getDefinitions/relationship" + model-vers: properties: - customer: + model-ver: type: array items: - $ref: "#/definitions/customer" - business: + $ref: "#/getDefinitions/model-ver" + models: description: | - Namespace for business related constructs + Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models properties: - connectors: - type: array - items: - $ref: "#/definitions/connector" - customers: + model: type: array - items: - $ref: "#/definitions/customer" - vnf-image: + items: + $ref: "#/getDefinitions/model" + multicast-configuration: description: | - Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES ###### Related Nodes - - FROM generic-vnf + - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) + required: - - vnf-image-uuid - - application - - application-vendor + - multicast-configuration-id + - multicast-protocol + - rp-type properties: - vnf-image-uuid: - type: string - description: Unique ID of this asset - application: - type: string - description: The application that the image instantiates. - application-vendor: + multicast-configuration-id: type: string - description: The vendor of the application. - application-version: + description: Unique id of multicast configuration. + multicast-protocol: type: string - description: The version of the application. - selflink: + description: protocol of multicast configuration + rp-type: type: string - description: URL to endpoint where AAI can get more details + description: rp type of multicast configuration resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - vnf-images: + $ref: "#/getDefinitions/relationship" + multicast-configurations: description: | - Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. + multicast configuration of generic-vnf ip-address properties: - vnf-image: + multicast-configuration: type: array items: - $ref: "#/definitions/vnf-image" - service: + $ref: "#/getDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/getDefinitions/named-query" + named-query: description: | - Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES + TBD + ###### Related Nodes + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1) + - TO model( named-query AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1) + + -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also required: - - service-id - - service-description + - named-query-uuid + - named-query-name + - named-query-version properties: - service-id: + named-query-uuid: type: string - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. - service-description: + named-query-name: type: string - description: Description of the service - service-selflink: + named-query-version: + type: string + required-input-param: + type: string + description: type: string - description: URL to endpoint where AAI can get more details resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - service-version: + named-query-elements: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + named-query-element: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4) + - TO model( named-query-element IsA model, MANY2ONE) + - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1) + - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1) + - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4) + + -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also + required: + - named-query-element-uuid + properties: + named-query-element-uuid: type: string - description: service version + property-collect-list: + type: string + resource-version: + type: string + property-limit-desc: + type: string + do-not-output: + type: string + named-query-elements: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + related-lookups: + type: array + items: + $ref: "#/getDefinitions/related-lookup" + property-constraints: + type: array + items: + $ref: "#/getDefinitions/property-constraint" relationship-list: type: array items: - $ref: "#/definitions/relationship" - services: + $ref: "#/getDefinitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + network: description: | - Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + Namespace for network inventory resources. properties: - service: + logical-links: + type: array + items: + $ref: "#/getDefinitions/logical-link" + site-pair-sets: + type: array + items: + $ref: "#/getDefinitions/site-pair-set" + vpn-bindings: + type: array + items: + $ref: "#/getDefinitions/vpn-binding" + vpls-pes: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + multicast-configurations: + type: array + items: + $ref: "#/getDefinitions/multicast-configuration" + vces: + type: array + items: + $ref: "#/getDefinitions/vce" + vnfcs: + type: array + items: + $ref: "#/getDefinitions/vnfc" + l3-networks: + type: array + items: + $ref: "#/getDefinitions/l3-network" + network-policies: + type: array + items: + $ref: "#/getDefinitions/network-policy" + generic-vnfs: + type: array + items: + $ref: "#/getDefinitions/generic-vnf" + lag-links: + type: array + items: + $ref: "#/getDefinitions/lag-link" + newvces: + type: array + items: + $ref: "#/getDefinitions/newvce" + pnfs: + type: array + items: + $ref: "#/getDefinitions/pnf" + physical-links: + type: array + items: + $ref: "#/getDefinitions/physical-link" + ipsec-configurations: + type: array + items: + $ref: "#/getDefinitions/ipsec-configuration" + route-table-references: + type: array + items: + $ref: "#/getDefinitions/route-table-reference" + instance-groups: + type: array + items: + $ref: "#/getDefinitions/instance-group" + zones: + type: array + items: + $ref: "#/getDefinitions/zone" + configurations: + type: array + items: + $ref: "#/getDefinitions/configurations" + network-policies: + properties: + network-policy: type: array items: - $ref: "#/definitions/service" - service-capability: + $ref: "#/getDefinitions/network-policy" + network-policy: description: | - Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES ###### Related Nodes - - FROM availability-zone - - FROM oam-network + - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) + - FROM l3-network( l3-network Uses network-policy, MANY2MANY) + required: - - service-type - - vnf-type + - network-policy-id properties: - service-type: + network-policy-id: type: string - description: This gets defined by others to provide a unique ID for the service, we accept what is sent. - vnf-type: + description: UUID representing unique key to this instance + network-policy-fqdn: type: string - 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. + description: Contrail FQDN for the policy + heat-stack-id: + type: string + description: ID for the openStack Heat instance resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - service-capabilities: + $ref: "#/getDefinitions/relationship" + network-profile: description: | - Collection of service capabilities. + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) + + required: + - nm-profile-name properties: - service-capability: + nm-profile-name: + type: string + description: Unique name of network profile. + community-string: + type: string + description: Encrypted SNMP community string + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: type: array items: - $ref: "#/definitions/service-capability" - element-choice-set: + $ref: "#/getDefinitions/network-profile" + newvce: description: | - This is how we would capture constraints defining allowed sets of elements. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - - TO model-element (comprises element-choice-set, One2Many) - - FROM constrained-element-set (is composed of element-choice-set) + - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1) + + -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also required: - - element-choice-set-uuid - - element-choice-set-name + - vnf-id2 + - vnf-name + - vnf-type properties: - element-choice-set-uuid: + vnf-id2: type: string - element-choice-set-name: + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: type: string - cardinality: + description: Name of VNF. + vnf-name2: type: string + description: Alternate name of VNF. + vnf-type: + type: string + 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. + prov-status: + type: string + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + operational-status: + type: string + description: Indicator for whether the resource is considered operational + license-key: + type: string + description: OBSOLETE - do not use + ipv4-oam-address: + type: string + 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). + equipment-role: + type: string + description: Client should send valid enumerated value. resource-version: type: string - model-elements: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + ipv4-loopback0-address: + type: string + description: v4 Loopback0 address + orchestration-status: + type: string + description: Orchestration status of this VNF, mastered by MSO. + heat-stack-id: + type: string + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: + type: string + description: Corresponds to the SDN-C catalog id used to configure this VCE + relationship-list: type: array items: - $ref: "#/definitions/model-element" - relationship-list: + $ref: "#/getDefinitions/relationship" + l-interfaces: type: array items: - $ref: "#/definitions/relationship" - element-choice-sets: + $ref: "#/getDefinitions/l-interface" + newvces: + description: | + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. properties: - element-choice-set: + newvce: type: array items: - $ref: "#/definitions/element-choice-set" - constrained-element-set: - description: | - This is how we would capture constraints defining allowed sets of elements. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO element-choice-set (comprises constrained-element-set, One2Many) - - FROM model-element (is composed of constrained-element-set) - - FROM model-constraint (is composed of constrained-element-set) - required: - - constrained-element-set-uuid - - constraint-type - - check-type + $ref: "#/getDefinitions/newvce" + nodes: properties: - constrained-element-set-uuid: + inventory-item-data: + type: array + items: + $ref: "#/getDefinitions/inventory-item-data" + notification-event: + properties: + cambria.partition: type: string - constraint-type: + notification-event-header: + type: object + $ref: "#/getDefinitions/notification-event-header" + notification-event-header: + properties: + id: type: string - check-type: + timestamp: type: string - resource-version: + source-name: type: string - element-choice-sets: - type: array - items: - $ref: "#/definitions/element-choice-set" - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - constrained-element-sets: + domain: + type: string + sequence-number: + type: string + severity: + type: string + event-type: + type: string + version: + type: string + action: + type: string + entity-type: + type: string + top-entity-type: + type: string + entity-link: + type: string + status: + type: string + notify: + required: + - event-id properties: - constrained-element-set: + event-id: + type: string + node-type: + type: string + event-trigger: + type: string + key-data: type: array items: - $ref: "#/definitions/constrained-element-set" - model-constraint: + $ref: "#/getDefinitions/key-data" + selflink: + type: string + oam-network: description: | - This is how we would capture constraints defining allowed sets of elements. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - TO constrained-element-set (comprises model-constraint, One2Many) - - FROM model-element (is composed of model-constraint) + - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY) + required: - - model-constraint-uuid - - constrained-element-set-uuid-to-replace + - network-uuid + - network-name + - cvlan-tag properties: - model-constraint-uuid: + network-uuid: type: string - constrained-element-set-uuid-to-replace: + description: UUID of the network. Unique across a cloud-region + network-name: type: string - constrained-element-sets: - type: array - items: - $ref: "#/definitions/constrained-element-set" + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: + type: string + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network + ipv4-oam-gateway-address-prefix-length: + type: integer + format: int32 + description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-constraints: + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + oam-networks: + description: | + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. properties: - model-constraint: + oam-network: type: array items: - $ref: "#/definitions/model-constraint" - model-element: + $ref: "#/getDefinitions/oam-network" + operational-environment: description: | - Defines how other models combine to make up a higher-level model. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - - TO model-ver (Many2One) - - TO model-element (comprises model-element, One2Many) - - TO model-constraint (comprises model-element, One2Many) - - TO constrained-element-set (comprises model-element, One2Many) - - FROM model-ver (is composed of model-element) - - FROM element-choice-set (is composed of model-element) - - FROM model-element (is composed of model-element) + - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE) + required: - - model-element-uuid - - new-data-del-flag - - cardinality + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context properties: - model-element-uuid: + operational-environment-id: type: string - new-data-del-flag: + description: UUID of an operational environment + operational-environment-name: type: string - description: Indicates whether this element was created as part of instantiation from this model - cardinality: + description: Operational Environment name + operational-environment-type: type: string - description: How many of this type of element are required/allowed - linkage-points: + description: Operational Environment Type. + operational-environment-status: + type: string + description: Status + tenant-context: type: string + description: Tenant Context. + workload-context: + type: string + description: Workload Context. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-elements: - type: array - items: - $ref: "#/definitions/model-element" - description: Defines how other models combine to make up a higher-level model - model-constraints: - type: array - items: - $ref: "#/definitions/model-constraint" - description: Describes new constraints on this model element that are not part of that model's definition relationship-list: type: array items: - $ref: "#/definitions/relationship" - model-elements: + $ref: "#/getDefinitions/relationship" + operational-environments: + description: | + a logical partition of the cloud which allows to have multiple environments in the production AIC. properties: - model-element: + operational-environment: type: array items: - $ref: "#/definitions/model-element" - model-ver: + $ref: "#/getDefinitions/operational-environment" + overloaded-model: description: | - Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE - ###### Related Nodes - - TO model-element (comprises model-ver, One2Many) - - TO metadatum (comprises model-ver, One2Many) - - FROM model (is composed of model-ver) - - FROM model-element + Allows for legacy POST of old-style and new-style models required: - - model-version-id + - model-invariant-id + - model-name-version-id + - model-type - model-name + - model-id - model-version properties: - model-version-id: + model-invariant-id: + type: string + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: type: string description: Unique identifier corresponding to one version of a model in ASDC + model-type: + type: string + description: Type of the model, e.g., service, resource, widget, etc. model-name: type: string description: Name of the model, which can change from version to version. + model-id: + type: string + description: Invariant unique ID which does not change from version to version model-version: type: string description: Version @@ -41164,1575 +58124,1567 @@ definitions: resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-elements: - type: array - items: - $ref: "#/definitions/model-element" - metadata: - type: array - items: - $ref: "#/definitions/metadatum" + model-vers: + type: object + $ref: "#/getDefinitions/model-vers" relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - model-vers: + type: object + $ref: "#/getDefinitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities properties: - model-ver: + owning-entity: type: array items: - $ref: "#/definitions/model-ver" - model: + $ref: "#/getDefinitions/owning-entity" + owning-entity: description: | - Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE + describes an owning-entity ###### Related Nodes - - TO model-ver (comprises model, One2Many) - - FROM named-query - - FROM named-query-element - - FROM instance-group + - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) + required: - - model-invariant-id - - model-type + - owning-entity-id + - owning-entity-name properties: - model-invariant-id: + owning-entity-id: type: string - description: Unique identifier corresponding to the main definition of a model in ASDC - model-type: + description: UUID of an owning entity + owning-entity-name: type: string - description: Type of the model, e.g., service, resource, widget, etc. + description: Owning entity name resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-vers: - type: array - items: - $ref: "#/definitions/model-ver" relationship-list: type: array items: - $ref: "#/definitions/relationship" - models: - description: | - Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models - properties: - model: - type: array - items: - $ref: "#/definitions/model" - related-lookup: + $ref: "#/getDefinitions/relationship" + p-interface: description: | - TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Physical interface (e.g., nic) ###### Related Nodes - - FROM named-query-element (is composed of related-lookup) + - TO logical-link( p-interface LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2) + - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4) + - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4) + - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4) + - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1) + - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1) + + -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also + -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also required: - - related-lookup-uuid - - source-node-type - - source-node-property - - target-node-type - - target-node-property + - interface-name + - in-maint properties: - related-lookup-uuid: + interface-name: type: string - source-node-type: + description: Name that identifies the physical interface + speed-value: type: string - source-node-property: + description: Captures the numeric part of the speed + speed-units: type: string - target-node-type: + description: Captures the units corresponding to the speed + port-description: type: string - target-node-property: + description: Nature of the services and connectivity on this port. + equipment-identifier: type: string - property-collect-list: + description: CLEI or other specification for p-interface hardware. + interface-role: + type: string + description: Role specification for p-interface hardware. + interface-type: + type: string + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. + mac-addresss: type: string + description: MAC Address of the p-interface. resource-version: type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + inv-status: + type: string + description: inventory status relationship-list: type: array items: - $ref: "#/definitions/relationship" - related-lookups: + $ref: "#/getDefinitions/relationship" + sriov-pfs: + type: array + items: + $ref: "#/getDefinitions/sriov-pf" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. properties: - related-lookup: + p-interface: type: array items: - $ref: "#/definitions/related-lookup" - property-constraint: + $ref: "#/getDefinitions/p-interface" + physical-link: description: | - TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Collection of physical connections, typically between p-interfaces ###### Related Nodes - - FROM named-query-element (is composed of property-constraint) + - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) + + -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also required: - - property-constraint-uuid - - constraint-type - - property-name - - property-value + - link-name properties: - property-constraint-uuid: + link-name: type: string - constraint-type: + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: type: string - property-name: + description: Captures the numeric part of the speed + speed-units: type: string - property-value: + description: Captures the units corresponding to the speed + circuit-id: type: string - resource-version: + description: Circuit it + dual-mode: type: string - property-constraints: - properties: - property-constraint: - type: array - items: - $ref: "#/definitions/property-constraint" - named-query-element: - description: | - TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO named-query-element (comprises named-query-element, Many2Many) - - TO model (Many2One) - - TO property-constraint (comprises named-query-element, One2Many) - - TO related-lookup (comprises named-query-element, One2Many) - - FROM named-query (is composed of named-query-element) - - FROM named-query-element (is composed of named-query-element) - required: - - named-query-element-uuid - properties: - named-query-element-uuid: + description: Dual access mode (e.g., primary, secondary + management-option: type: string - property-collect-list: + description: To provide information on who manages this circuit. A&AI or 3rd party transport provider + service-provider-name: type: string - resource-version: + description: Name of the service Provider on this link. + service-provider-bandwidth-up-value: + type: integer + format: int32 + description: Upstream Bandwidth value agreed with the service provider + service-provider-bandwidth-up-units: type: string - property-limit-desc: + description: Units for the upstream BW value + service-provider-bandwidth-down-value: + type: integer + format: int32 + description: Downstream Bandwidth value agreed with the service provider + service-provider-bandwidth-down-units: type: string - do-not-output: + description: Units for downstream BW value + resource-version: type: string - named-query-elements: - type: array - items: - $ref: "#/definitions/named-query-element" - related-lookups: - type: array - items: - $ref: "#/definitions/related-lookup" - property-constraints: - type: array - items: - $ref: "#/definitions/property-constraint" + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - named-query-elements: + $ref: "#/getDefinitions/relationship" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces properties: - named-query-element: + physical-link: type: array items: - $ref: "#/definitions/named-query-element" - named-query: + $ref: "#/getDefinitions/physical-link" + platform: description: | - TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN + describes a platform ###### Related Nodes - - TO model (One2Many) - - TO named-query-element (comprises named-query, One2One) + - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) + required: - - named-query-uuid - - named-query-name - - named-query-version + - platform-name properties: - named-query-uuid: - type: string - named-query-name: - type: string - named-query-version: - type: string - required-input-param: - type: string - description: + platform-name: type: string + description: Name of the platform resource-version: type: string - named-query-elements: - type: array - items: - $ref: "#/definitions/named-query-element" + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - named-queries: - properties: - named-query: - type: array - items: - $ref: "#/definitions/named-query" - service-design-and-creation: + $ref: "#/getDefinitions/relationship" + platforms: description: | - Namespace for objects managed by ASDC + Collection of platforms properties: - vnf-images: - type: array - items: - $ref: "#/definitions/vnf-image" - services: - type: array - items: - $ref: "#/definitions/service" - service-capabilities: - type: array - items: - $ref: "#/definitions/service-capability" - models: - type: array - items: - $ref: "#/definitions/model" - named-queries: + platform: type: array - items: - $ref: "#/definitions/named-query" - logical-link: + items: + $ref: "#/getDefinitions/platform" + pnf: description: | - Logical links generally connect l-interfaces but are used to express logical connectivity between two points - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - TO lag-link (Many2Many) - - TO pnf (Many2Many) - - TO logical-link (One2Many) - - TO generic-vnf (Many2Many) - - TO pserver (Many2Many) - - TO cloud-region (Many2Many) - - TO vpn-binding (Many2Many) - - FROM l-interface - - FROM lag-interface - - FROM p-interface - - FROM service-instance - - FROM virtual-data-center - - FROM vlan - - FROM logical-link + 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. + ###### Related Nodes + - TO complex( pnf LocatedIn complex, MANY2ONE) + - TO instance-group( pnf MemberOf instance-group, MANY2MANY) + - TO zone( pnf LocatedIn zone, MANY2ONE) + - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY) + - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY) + + -(1) IF this PNF node is deleted, this FROM node is DELETED also required: - - link-name + - pnf-name - in-maint - - link-type properties: - link-name: + pnf-name: type: string - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + description: unique name of Physical Network Function. + pnf-name2: + type: string + description: name of Physical Network Function. + pnf-name2-source: + type: string + description: source of name2 + pnf-id: + type: string + description: id of pnf + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + management-option: + type: string + description: identifier of managed by ATT or customer + ipaddress-v4-oam: + type: string + description: ipv4-oam-address with new naming convention for IP addresses + sw-version: + type: string + description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean - link-type: + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + frame-id: type: string - description: Type of logical link, e.g., evc - speed-value: + description: ID of the physical frame (relay rack) where pnf is installed. + serial-number: type: string - description: Captures the numeric part of the speed - speed-units: + description: Serial number of the device + ipaddress-v4-loopback-0: type: string - description: Captures the units corresponding to the speed - ip-version: + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: type: string - description: v4, v6, or ds for dual stack - routing-protocol: + description: IPV6 Loopback 0 address + ipaddress-v4-aim: type: string - description: For example, static or BGP + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-invariant-id: + prov-status: type: string - description: the ASDC model id for this resource or service model. - model-version-id: + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + nf-role: type: string - description: the ASDC model version for this resource or service model. - persona-model-version: + description: Nf Role is the role performed by this instance in the network. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + pnfs: + description: | + Collection of Physical Network Functions. + properties: + pnf: + type: array + items: + $ref: "#/getDefinitions/pnf" + port-group: + description: | + Used to capture the network interfaces of this VCE + ###### Related Nodes + - TO vce( port-group BelongsTo vce, MANY2ONE)(4) + - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1) + + -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also + required: + - interface-id + - orchestration-status + properties: + interface-id: type: string - description: the ASDC model version for this resource or service model. - widget-model-id: + description: Unique ID of the interface + neutron-network-id: type: string - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - widget-model-version: + description: Neutron network id of this Interface + neutron-network-name: type: string - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - operational-status: + description: Neutron network name of this Interface + interface-role: + type: string + description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. + resource-version: type: string - description: Indication of operational status of the logical link. - prov-status: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + port-group-id: type: string - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - link-role: + description: Unique ID for port group in vmware + port-group-name: type: string - description: Indication of the network use of the logical link. - link-name2: + description: Likely to duplicate value of neutron network name + switch-name: type: string - description: Alias or alternate name (CLCI or D1 name). - link-id: + description: DVS or standard switch name (should be non-null for port groups associated with DVS) + orchestration-status: type: string - description: UUID of the logical-link, SDNC generates this. - circuit-id: + description: Orchestration status of this VNF, mastered by MSO + heat-stack-id: type: string - description: Circuit id - purpose: + description: Heat stack id corresponding to this instance, managed by MSO + mso-catalog-key: type: string - description: Reason for this entity, role it is playing + description: Corresponds to the SDN-C catalog id used to configure this VCE + cvlan-tags: + type: array + items: + $ref: "#/getDefinitions/cvlan-tag-entry" relationship-list: type: array items: - $ref: "#/definitions/relationship" - logical-links: - description: | - Collection of logical connections + $ref: "#/getDefinitions/relationship" + port-groups: properties: - logical-link: + port-group: type: array items: - $ref: "#/definitions/logical-link" - class-of-service: + $ref: "#/getDefinitions/port-group" + project: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + describes the project ###### Related Nodes - - FROM site-pair (is composed of class-of-service) + - TO service-instance( project Uses service-instance, ONE2MANY) + required: - - cos + - project-name properties: - cos: - type: string - description: unique identifier of probe - probe-id: + project-name: type: string - description: identifier of probe - probe-type: - type: string - description: type of probe + description: Name of the project deploying a service resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - classes-of-service: + $ref: "#/getDefinitions/relationship" + projects: description: | - class-of-service of probe + Collection of projects properties: - class-of-service: + project: type: array items: - $ref: "#/definitions/class-of-service" - site-pair: + $ref: "#/getDefinitions/project" + properties: description: | - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO class-of-service (comprises site-pair, Many2Many) - - FROM routing-instance (is composed of site-pair) - required: - - site-pair-id + Property holder for query properties or instance properties properties: - site-pair-id: + property-name: type: string - description: unique identifier of probe - source-ip: + property-value: type: string - description: Prefix address - destination-ip: + property-constraint: + description: | + TBD + ###### Related Nodes + - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also + required: + - property-constraint-uuid + - constraint-type + - property-name + - property-value + properties: + property-constraint-uuid: type: string - description: Prefix address - ip-version: + constraint-type: type: string - description: ip version, v4, v6 - destination-hostname: + property-name: type: string - description: Hostname of the destination equipment to which SLAs are measured against. - destination-equip-type: + property-value: type: string - description: The type of destinatination equipment. Could be Router, UCPE, etc. resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - classes-of-service: - type: array - items: - $ref: "#/definitions/class-of-service" - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - site-pairs: - description: | - probe within a set + property-constraints: properties: - site-pair: + property-constraint: type: array items: - $ref: "#/definitions/site-pair" - routing-instance: + $ref: "#/getDefinitions/property-constraint" + pserver: description: | - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - - TO site-pair (comprises routing-instance, Many2Many) - - FROM site-pair-set (is composed of routing-instance) + - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver LocatedIn complex, MANY2ONE) + - TO zone( pserver LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1) + - FROM vserver( vserver HostedOn pserver, MANY2ONE) + + -(1) IF this PSERVER node is deleted, this FROM node is DELETED also + -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT + required: - - routing-instance-id + - hostname + - in-maint properties: - routing-instance-id: + hostname: type: string - description: Unique id of routing instance - rpm-owner: + description: Value from executing hostname on the compute node. + ptnii-equip-name: type: string - description: rpm owner + description: PTNII name + number-of-cpus: + type: integer + format: int32 + description: Number of cpus + disk-in-gigabytes: + type: integer + format: int32 + description: Disk size, in GBs + ram-in-megabytes: + type: integer + format: int32 + description: RAM size, in MBs + equip-type: + type: string + description: Equipment type. Source of truth should define valid values. + equip-vendor: + type: string + description: Equipment vendor. Source of truth should define valid values. + equip-model: + type: string + description: Equipment model. Source of truth should define valid values. + fqdn: + type: string + description: Fully-qualified domain name + pserver-selflink: + type: string + description: URL to endpoint where AAI can get more details + ipv4-oam-address: + type: string + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: + type: string + description: Serial number, may be queried + ipaddress-v4-loopback-0: + type: string + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: + type: string + description: IPV6 Loopback 0 address + ipaddress-v4-aim: + type: string + description: IPV4 AIM address + ipaddress-v6-aim: + type: string + description: IPV6 AIM address + ipaddress-v6-oam: + type: string + description: IPV6 OAM address + inv-status: + type: string + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: + type: string + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - site-pairs: + pserver-name2: + type: string + description: alternative pserver name + purpose: + type: string + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + management-option: + type: string + description: Indicates who owns and or manages the device. + host-profile: + type: string + description: The host profile that defines the configuration of the pserver. + relationship-list: type: array items: - $ref: "#/definitions/site-pair" - relationship-list: + $ref: "#/getDefinitions/relationship" + p-interfaces: type: array items: - $ref: "#/definitions/relationship" - routing-instances: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + pservers: description: | - set of probes related to generic-vnf routing instance + Collection of compute hosts. properties: - routing-instance: + pserver: type: array items: - $ref: "#/definitions/routing-instance" - site-pair-set: + $ref: "#/getDefinitions/pserver" + query-parameters: description: | - Set of instances for probes used to measure service level agreements - ###### Default Delete Scope - CASCADE_TO_CHILDREN + QueryParameters for performing a named-query or model query + properties: + named-query: + type: object + $ref: "#/getDefinitions/named-query" + overloaded-model: + type: object + $ref: "#/getDefinitions/overloaded-model" + related-lookup: + description: | + TBD ###### Related Nodes - - TO routing-instance (comprises site-pair-set, Many2Many) - - FROM generic-vnf + - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also required: - - site-pair-set-id + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property properties: - site-pair-set-id: + related-lookup-uuid: + type: string + source-node-type: + type: string + source-node-property: + type: string + target-node-type: + type: string + target-node-property: + type: string + property-collect-list: type: string - description: Unique id of site pair set. resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - routing-instances: - type: array - items: - $ref: "#/definitions/routing-instance" relationship-list: type: array items: - $ref: "#/definitions/relationship" - site-pair-sets: - description: | - Collection of sets of instances for probes related to generic-vnf + $ref: "#/getDefinitions/relationship" + related-lookups: properties: - site-pair-set: + related-lookup: type: array items: - $ref: "#/definitions/site-pair-set" - route-target: - description: | - Route target information - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - FROM vpn-binding (is composed of route-target) - required: - - global-route-target - - route-target-role + $ref: "#/getDefinitions/related-lookup" + related-to-property: properties: - global-route-target: + property-key: type: string - description: Number used to identify an RT, globally unique in the network - route-target-role: + description: Key part of a key/value pair + property-value: type: string - description: Role assigned to this route target - resource-version: + description: Value part of a key/value pair + relationship: + properties: + related-to: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: + description: A keyword provided by A&AI to indicate type of node. + related-link: + type: string + description: URL to the object in A&AI. + relationship-data: type: array - items: - $ref: "#/definitions/relationship" - route-targets: - description: | - Collection of route target information + items: + $ref: "#/getDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/getDefinitions/related-to-property" + relationship-data: + required: + - relationship-key + - relationship-value properties: - route-target: + relationship-key: + type: string + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: + type: string + description: Value of the attribute. + relationship-list: + properties: + relationship: type: array items: - $ref: "#/definitions/route-target" - vpn-binding: + $ref: "#/getDefinitions/relationship" + reserved-prop-names: description: | - VPN binding - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE - ###### Related Nodes - - TO route-target (comprises vpn-binding, One2Many) - - FROM l3-network - - FROM logical-link - - FROM allotted-resource - required: - - vpn-id - - vpn-name + Internal map to define some reserved properties of a vertex properties: - vpn-id: + last-mod-source-of-truth: type: string - description: VPN ID, globally unique within A&AI - vpn-name: + aai-node-type: type: string - description: VPN Name - vpn-platform: + aai-created-ts: + type: integer + format: int64 + aai-unique-key: type: string - description: the platform associated with the VPN example AVPN, Mobility - vpn-type: + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: type: string - description: Type of the vpn, should be taken from enumerated/valid values - vpn-region: + aai-uri: type: string - description: region of customer vpn - customer-vpn-id: + response-list: + description: | + Response container for the results of a named-query or model query + properties: + inventory-response-items: + type: object + $ref: "#/getDefinitions/inventory-response-items" + result-data: + properties: + resource-type: type: string - description: id for this customer vpn - route-distinguisher: + description: The specific type of node in the A&AI graph + resource-link: type: string - description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) + + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: + type: string + description: Route Table Reference id, UUID assigned to this instance. + route-table-reference-fqdn: + type: string + description: FQDN entry in the route table. resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - route-targets: - type: array - items: - $ref: "#/definitions/route-target" + description: Concurrency value relationship-list: type: array items: - $ref: "#/definitions/relationship" - description: l3-networks relate to vpn-bindings - vpn-bindings: + $ref: "#/getDefinitions/relationship" + route-table-references: + description: | + Collection of openstack route table references properties: - vpn-binding: + route-table-reference: type: array items: - $ref: "#/definitions/vpn-binding" - vpls-pe: + $ref: "#/getDefinitions/route-table-reference" + route-target: description: | - VPLS Provider Edge routers. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Route target information ###### Related Nodes - - TO complex (Many2Many) - - TO ctag-pool (Many2Many) - - TO p-interface (comprises vpls-pe, Many2Many) - - TO lag-interface (comprises vpls-pe, Many2Many) + - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also required: - - equipment-name + - global-route-target + - route-target-role properties: - equipment-name: - type: string - prov-status: - type: string - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - ipv4-oam-address: + global-route-target: type: string - 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). - equipment-role: + description: Number used to identify an RT, globally unique in the network + route-target-role: type: string - description: Client should send valid enumerated value, e.g., VPLS-PE. - vlan-id-outer: - type: integer - format: int64 - description: Temporary location for stag to get to VCE + description: Role assigned to this route target resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - p-interfaces: - type: array - items: - $ref: "#/definitions/p-interface" - lag-interfaces: - type: array - items: - $ref: "#/definitions/lag-interface" - vpls-pes: + $ref: "#/getDefinitions/relationship" + route-targets: description: | - Collection of VPLS Provider Edge routers + Collection of route target information properties: - vpls-pe: + route-target: type: array items: - $ref: "#/definitions/vpls-pe" - multicast-configuration: + $ref: "#/getDefinitions/route-target" + routing-instance: description: | - ###### Default Delete Scope - THIS_NODE_ONLY ###### Related Nodes - - FROM vlan + - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4) + - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1) + + -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also required: - - multicast-configuration-id - - multicast-protocol - - rp-type + - routing-instance-id properties: - multicast-configuration-id: - type: string - description: Unique id of multicast configuration. - multicast-protocol: + routing-instance-id: type: string - description: protocol of multicast configuration - rp-type: + description: Unique id of routing instance + rpm-owner: type: string - description: rp type of multicast configuration + description: rpm owner resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + site-pairs: + type: array + items: + $ref: "#/getDefinitions/site-pair" relationship-list: type: array items: - $ref: "#/definitions/relationship" - multicast-configurations: + $ref: "#/getDefinitions/relationship" + routing-instances: description: | - multicast configuration of generic-vnf ip-address + set of probes related to generic-vnf routing instance properties: - multicast-configuration: + routing-instance: type: array items: - $ref: "#/definitions/multicast-configuration" - cvlan-tag-entry: - required: - - cvlan-tag + $ref: "#/getDefinitions/routing-instance" + sdn-zone-response: properties: - cvlan-tag: - type: integer - format: int64 - description: See mis-na-virtualization-platform.yang - resource-version: - type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: + oam-networks: + type: object + $ref: "#/getDefinitions/oam-networks" + az-and-dvs-switches: type: array - items: - $ref: "#/definitions/relationship" - cvlan-tags: + items: + $ref: "#/getDefinitions/az-and-dvs-switches" + search: properties: - cvlan-tag-entry: + edge-tag-query-result: + type: object + $ref: "#/getDefinitions/edge-tag-query-result" + edge-tag-query-request: + type: object + $ref: "#/getDefinitions/edge-tag-query-request" + search-results: + type: object + $ref: "#/getDefinitions/search-results" + sdn-zone-response: + type: object + $ref: "#/getDefinitions/sdn-zone-response" + search-results: + properties: + result-data: type: array items: - $ref: "#/definitions/cvlan-tag-entry" - port-group: + $ref: "#/getDefinitions/result-data" + secondary-filt: description: | - Used to capture the network interfaces of this VCE - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO cvlan-tag (comprises port-group, Many2Many) - - FROM vce (is composed of port-group) - required: - - interface-id - - orchestration-status + SecondaryFilt for performing a named-query or model query + secondary-filter: properties: - interface-id: - type: string - description: Unique ID of the interface - neutron-network-id: - type: string - description: Neutron network id of this Interface - neutron-network-name: - type: string - description: Neutron network name of this Interface - interface-role: - type: string - description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. - resource-version: - type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - port-group-id: - type: string - description: Unique ID for port group in vmware - port-group-name: + property-name: type: string - description: Likely to duplicate value of neutron network name - switch-name: + filter-type: type: string - description: DVS or standard switch name (should be non-null for port groups associated with DVS) - orchestration-status: + property-value: type: string - description: Orchestration status of this VNF, mastered by MSO - heat-stack-id: + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query + properties: + secondary-filt: + type: array + items: + $ref: "#/getDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also + required: + - segmentation-id + properties: + segmentation-id: type: string - description: Heat stack id corresponding to this instance, managed by MSO - mso-catalog-key: + description: Route Table Reference id, UUID assigned to this instance. + resource-version: type: string - description: Corresponds to the SDN-C catalog id used to configure this VCE - cvlan-tags: - type: array - items: - $ref: "#/definitions/cvlan-tag-entry" + description: Concurrency value relationship-list: type: array items: - $ref: "#/definitions/relationship" - port-groups: + $ref: "#/getDefinitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments properties: - port-group: + segmentation-assignment: type: array items: - $ref: "#/definitions/port-group" - license: + $ref: "#/getDefinitions/segmentation-assignment" + service: description: | - Metadata for license group. - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - FROM generic-vnf (is composed of license) - - FROM vce (is composed of license) + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. required: - - group-uuid - - resource-uuid + - service-id + - service-description properties: - group-uuid: + service-id: type: string - description: Unique ID for the license group the resource belongs to, should be uuid. - resource-uuid: + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: type: string - description: Unique ID of a license resource. + description: Description of the service + service-selflink: + type: string + description: URL to endpoint where AAI can get more details resource-version: type: string - description: Concurrency value + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-version: + type: string + description: service version relationship-list: type: array items: - $ref: "#/definitions/relationship" - licenses: + $ref: "#/getDefinitions/relationship" + service-capabilities: description: | - Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + Collection of service capabilities. properties: - license: + service-capability: type: array items: - $ref: "#/definitions/license" - entitlement: + $ref: "#/getDefinitions/service-capability" + service-capability: description: | - Metadata for entitlement group. - ###### Default Delete Scope - THIS_NODE_ONLY + Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - - FROM generic-vnf (is composed of entitlement) - - FROM vce (is composed of entitlement) + - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY) + + -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK + required: - - group-uuid - - resource-uuid + - service-type + - vnf-type properties: - group-uuid: + service-type: type: string - description: Unique ID for the entitlement group the resource comes from, should be uuid. - resource-uuid: + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + vnf-type: type: string - description: Unique ID of an entitlement resource. + 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. resource-version: type: string - description: Concurrency value + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - entitlements: + $ref: "#/getDefinitions/relationship" + service-design-and-creation: description: | - Entitlements, keyed by group-uuid and resource-uuid, related to license management + Namespace for objects managed by ASDC properties: - entitlement: + vnf-images: type: array - items: - $ref: "#/definitions/entitlement" - vce: + items: + $ref: "#/getDefinitions/vnf-image" + services: + type: array + items: + $ref: "#/getDefinitions/service" + service-capabilities: + type: array + items: + $ref: "#/getDefinitions/service-capability" + models: + type: array + items: + $ref: "#/getDefinitions/model" + named-queries: + type: array + items: + $ref: "#/getDefinitions/named-query" + service-instance: description: | - Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Instance of a service ###### Related Nodes - - TO availability-zone (Many2Many) - - TO complex (Many2Many) - - TO port-group (comprises vce, Many2Many) - - TO vserver (Many2Many) - - TO service-instance (Many2Many) - - TO entitlement (comprises vce, One2Many) - - TO license (comprises vce, One2Many) + - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY) + - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE) + - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY) + - TO configuration( service-instance Uses configuration, ONE2MANY) + - TO connector( service-instance Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2) + - TO pnf( service-instance ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance ComposedOf vlan, ONE2MANY) + - TO zone( service-instance LocatedIn zone, MANY2ONE) + - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4) + - TO vce( service-instance ComposedOf vce, ONE2MANY) + - FROM project( project Uses service-instance, ONE2MANY) + - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1) + - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY) + + -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also + -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also required: - - vnf-id - - vnf-name - - vnf-type + - service-instance-id properties: - vnf-id: + service-instance-id: type: string - description: Unique id of VNF. This is unique across the graph. - vnf-name: + description: Uniquely identifies this instance of a service + service-instance-name: type: string - description: Name of VNF. - vnf-name2: + description: This field will store a name assigned to the service-instance. + service-type: type: string - description: Alternate name of VNF. - vnf-type: + description: String capturing type of service. + service-role: type: string - 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. - service-id: + description: String capturing the service role. + environment-context: type: string - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - regional-resource-zone: + description: This field will store the environment context assigned to the service-instance. + workload-context: type: string - description: Regional way of organizing pservers, source of truth should define values - prov-status: + description: This field will store the workload context assigned to the service-instance. + created-at: type: string - description: Trigger for operational monitoring of this resource by Service Assurance systems. - operational-status: + description: create time of Network Service. + updated-at: type: string - description: Indicator for whether the resource is considered operational - license-key: + description: last update of Network Service. + description: type: string - description: OBSOLETE - do not use - equipment-role: + description: short description for service-instance. + model-invariant-id: type: string - description: Network role being played by this VNF - orchestration-status: + description: the ASDC model id for this resource or service model. + model-version-id: type: string - description: Orchestration status of this VNF, mastered by MSO - heat-stack-id: + description: the ASDC model version for this resource or service model. + persona-model-version: type: string - description: Heat stack id corresponding to this instance, managed by MSO - mso-catalog-key: + description: the ASDC model version for this resource or service model. + widget-model-id: type: string - description: Corresponds to the SDN-C catalog id used to configure this VCE - vpe-id: + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: type: string - description: Unique ID of VPE connected to this VCE. - v6-vce-wan-address: + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + bandwidth-total: type: string - description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. - ipv4-oam-address: + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: type: string - description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-down-wan1: + type: string + description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device. + bandwidth-up-wan2: + type: string + description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device. + bandwidth-down-wan2: + type: string + description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device. + vhn-portal-url: + type: string + description: URL customers will use to access the vHN Portal. + service-instance-location-id: + type: string + description: An identifier that customers assign to the location where this service is being used. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - ipv4-loopback0-address: + selflink: type: string - description: Loopback0 address - entitlement-resource-uuid: + description: Path to the controller object. + orchestration-status: type: string - description: OBSOLETE - see child relationships - port-groups: - type: array - items: - $ref: "#/definitions/port-group" - licenses: + description: Orchestration status of this service. + relationship-list: type: array items: - $ref: "#/definitions/license" - entitlements: + $ref: "#/getDefinitions/relationship" + metadata: type: array items: - $ref: "#/definitions/entitlement" - relationship-list: + $ref: "#/getDefinitions/metadatum" + allotted-resources: type: array items: - $ref: "#/definitions/relationship" - vces: + $ref: "#/getDefinitions/allotted-resource" + service-instances: description: | - Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + Collection of service instances properties: - vce: + service-instance: type: array items: - $ref: "#/definitions/vce" - vnfc: + $ref: "#/getDefinitions/service-instance" + service-subscription: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + Object that group service instances. ###### Related Nodes - - TO instance-group (Many2Many) - - FROM vserver - - FROM vf-module - - FROM generic-vnf + - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4) + - TO tenant( service-subscription Uses tenant, MANY2MANY) + - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1) + + -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also required: - - vnfc-name - - nfc-naming-code - - nfc-function - - in-maint - - is-closed-loop-disabled + - service-type properties: - vnfc-name: - type: string - description: Unique ID of vnfc. - nfc-naming-code: - type: string - description: Short code that is used in naming instances of the item being modeled - nfc-function: - type: string - description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service - prov-status: - type: string - description: prov status of this vnfc - orchestration-status: - type: string - description: Orchestration status of this VNF, mastered by APP-C - ipaddress-v4-oam-vip: - type: string - description: Oam V4 vip address of this vnfc - in-maint: - type: boolean - is-closed-loop-disabled: - type: boolean - group-notation: - type: string - description: Group notation of VNFC - model-invariant-id: + service-type: type: string - description: the ASDC model id for this resource or service model. - model-version-id: + description: Value defined by orchestration to identify this service across ECOMP. + temp-ub-sub-account-id: type: string - description: the ASDC model version for this resource or service model. + description: This property will be deleted from A&AI in the near future. Only stop gap solution. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + service-instances: + type: array + items: + $ref: "#/getDefinitions/service-instance" relationship-list: type: array items: - $ref: "#/definitions/relationship" - vnfcs: + $ref: "#/getDefinitions/relationship" + service-subscriptions: description: | - virtual network components associated with a vserver from application controller. + Collection of objects that group service instances. properties: - vnfc: + service-subscription: type: array items: - $ref: "#/definitions/vnfc" - subnet: + $ref: "#/getDefinitions/service-subscription" + services: + description: | + Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. + properties: + service: + type: array + items: + $ref: "#/getDefinitions/service" + site-pair: description: | - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES ###### Related Nodes - - FROM l3-interface-ipv4-address-list - - FROM l3-interface-ipv6-address-list - - FROM l3-network (is composed of subnet) + - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4) + - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1) + + -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also required: - - subnet-id - - dhcp-enabled + - site-pair-id properties: - subnet-id: - type: string - description: Subnet ID, should be UUID. - subnet-name: - type: string - description: Name associated with the subnet. - neutron-subnet-id: - type: string - description: Neutron id of this subnet - gateway-address: + site-pair-id: type: string - description: gateway ip address - network-start-address: + description: unique identifier of probe + source-ip: type: string - description: network start address - cidr-mask: + description: Prefix address + destination-ip: type: string - description: cidr mask + description: Prefix address ip-version: type: string - description: ip version - orchestration-status: - type: string - description: Orchestration status of this VNF, mastered by MSO - dhcp-enabled: - type: boolean - dhcp-start: - type: string - description: the start address reserved for use by dhcp - dhcp-end: + description: ip version, v4, v6 + destination-hostname: type: string - description: the last address reserved for use by dhcp - subnet-role: + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: type: string - description: role of the subnet, referenced when assigning IPs + description: The type of destinatination equipment. Could be Router, UCPE, etc. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: + classes-of-service: type: array items: - $ref: "#/definitions/relationship" - subnets: - properties: - subnet: + $ref: "#/getDefinitions/class-of-service" + relationship-list: type: array - items: - $ref: "#/definitions/subnet" - ctag-assignment: + items: + $ref: "#/getDefinitions/relationship" + site-pair-set: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + Set of instances for probes used to measure service level agreements ###### Related Nodes - - FROM l3-network (is composed of ctag-assignment) - - FROM service-instance + - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1) + + -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also required: - - vlan-id-inner + - site-pair-set-id properties: - vlan-id-inner: - type: integer - format: int64 - description: id. + site-pair-set-id: + type: string + description: Unique id of site pair set. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - relationship-list: + routing-instances: type: array items: - $ref: "#/definitions/relationship" - ctag-assignments: - properties: - ctag-assignment: + $ref: "#/getDefinitions/routing-instance" + relationship-list: type: array - items: - $ref: "#/definitions/ctag-assignment" - segmentation-assignment: + items: + $ref: "#/getDefinitions/relationship" + site-pair-sets: description: | - Openstack segmentation assignment. - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - FROM l3-network (is composed of segmentation-assignment) - required: - - segmentation-id + Collection of sets of instances for probes related to generic-vnf properties: - segmentation-id: - type: string - description: Route Table Reference id, UUID assigned to this instance. - resource-version: - type: string - description: Concurrency value - relationship-list: + site-pair-set: type: array - items: - $ref: "#/definitions/relationship" - segmentation-assignments: + items: + $ref: "#/getDefinitions/site-pair-set" + site-pairs: description: | - Collection of openstack segmentation assignments + probe within a set properties: - segmentation-assignment: + site-pair: type: array items: - $ref: "#/definitions/segmentation-assignment" - l3-network: + $ref: "#/getDefinitions/site-pair" + snapshot: description: | - Generic network definition - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO vpn-binding (Many2Many) - - TO instance-group (Many2Many) - - TO subnet (comprises l3-network, Many2Many) - - TO service-instance (Many2Many) - - TO ctag-assignment (comprises l3-network, Many2Many) - - TO network-policy (Many2Many) - - TO segmentation-assignment (comprises l3-network, One2Many) - - TO route-table-reference (Many2Many) - - FROM cloud-region - - FROM complex - - FROM generic-vnf - - FROM l3-interface-ipv4-address-list - - FROM l3-interface-ipv6-address-list - - FROM tenant - - FROM vf-module - - FROM allotted-resource + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver Uses snapshot, ONE2ONE) + required: - - network-id - - network-name - - is-bound-to-vpn - - is-provider-network - - is-shared-network - - is-external-network + - snapshot-id properties: - network-id: - type: string - description: Network ID, should be uuid. Unique across A&AI. - network-name: - type: string - description: Name of the network, governed by some naming convention.. - network-type: - type: string - description: Type of the network - who defines these values? - network-role: - type: string - description: Role the network plans - who defines these values? - network-technology: - type: string - description: Network technology - who defines these values? - neutron-network-id: - type: string - description: Neutron network id of this Interface - is-bound-to-vpn: - type: boolean - service-id: - type: string - description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED - network-role-instance: - type: integer - format: int64 - description: network role instance - resource-version: - type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - orchestration-status: - type: string - description: Orchestration status of this VNF, mastered by MSO - heat-stack-id: - type: string - description: Heat stack id corresponding to this instance, managed by MSO - mso-catalog-key: + snapshot-id: type: string - description: Corresponds to the SDN-C catalog id used to configure this VCE - contrail-network-fqdn: + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: type: string - description: Contrail FQDN for the network - model-invariant-id: + description: Snapshot name + snapshot-architecture: type: string - description: the ASDC model id for this resource or service model. - model-version-id: + description: Operating system architecture + snapshot-os-distro: type: string - description: the ASDC model version for this resource or service model. - persona-model-version: + description: The common name of the operating system distribution in lowercase + snapshot-os-version: type: string - description: the ASDC model version for this resource or service model. - model-customization-id: + description: The operating system version as specified by the distributor. + application: type: string - description: captures the id of all the configuration used to customize the resource for the service. - widget-model-id: + description: The application that the image instantiates. + application-vendor: type: string - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - widget-model-version: + description: The vendor of the application. + application-version: type: string - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - physical-network-name: + description: The version of the application. + snapshot-selflink: type: string - description: Name associated with the physical network. - is-provider-network: - type: boolean - is-shared-network: - type: boolean - is-external-network: - type: boolean - selflink: + description: URL to endpoint where AAI can get more details + prev-snapshot-id: type: string - description: Path to the controller object. - operational-status: + description: This field contains the UUID of the previous snapshot (if any). + resource-version: type: string - description: Indicator for whether the resource is considered operational. - subnets: - type: array - items: - $ref: "#/definitions/subnet" - ctag-assignments: - type: array - items: - $ref: "#/definitions/ctag-assignment" - segmentation-assignments: - type: array - items: - $ref: "#/definitions/segmentation-assignment" + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding - l3-networks: + $ref: "#/getDefinitions/relationship" + snapshots: + description: | + Collection of openstack snapshots properties: - l3-network: + snapshot: type: array items: - $ref: "#/definitions/l3-network" - network-policy: + $ref: "#/getDefinitions/snapshot" + sriov-pf: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + SR-IOV Physical Function ###### Related Nodes - - FROM l3-network - - FROM allotted-resource + - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4) + - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also required: - - network-policy-id + - pf-pci-id properties: - network-policy-id: - type: string - description: UUID representing unique key to this instance - network-policy-fqdn: - type: string - description: Contrail FQDN for the policy - heat-stack-id: + pf-pci-id: type: string - description: ID for the openStack Heat instance + description: Identifier for the sriov-pf resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - network-policies: + $ref: "#/getDefinitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. properties: - network-policy: + sriov-pf: type: array items: - $ref: "#/definitions/network-policy" - vf-module: + $ref: "#/getDefinitions/sriov-pf" + sriov-vf: description: | - a deployment unit of VNFCs - ###### Default Delete Scope - THIS_NODE_ONLY + SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO volume-group (One2One) - - TO l3-network (Many2Many) - - TO vnfc (One2Many) - - FROM vserver - - FROM generic-vnf (is composed of vf-module) + - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4) + - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE) + + -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also required: - - vf-module-id - - is-base-vf-module + - pci-id properties: - vf-module-id: + pci-id: type: string - description: Unique ID of vf-module. - vf-module-name: + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: type: string - description: Name of vf-module - heat-stack-id: + description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. + vf-mac-filter: type: string - description: Heat stack id corresponding to this instance. - orchestration-status: + description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. + vf-vlan-strip: + type: boolean + description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. + vf-vlan-anti-spoof-check: + type: boolean + 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. + vf-mac-anti-spoof-check: + type: boolean + 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. + vf-mirrors: type: string - description: orchestration status of this vf-module, mastered by MSO - is-base-vf-module: + description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. + vf-broadcast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM + vf-unknown-multicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM + vf-unknown-unicast-allow: + type: boolean + description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM + vf-insert-stag: type: boolean + description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. + vf-link-status: + type: string + description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-invariant-id: - type: string - description: the ASDC model id for this resource or service model. - model-version-id: - type: string - description: the ASDC model version for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - model-customization-id: - type: string - description: captures the id of all the configuration used to customize the resource for the service. - widget-model-id: - type: string - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - widget-model-version: - type: string - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - contrail-service-instance-fqdn: - type: string - description: the Contrail unique ID for a service-instance - module-index: - type: integer - format: int32 - 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 - selflink: + neutron-network-id: type: string - description: Path to the controller object. + description: Neutron network id of the interface relationship-list: type: array items: - $ref: "#/definitions/relationship" - vf-modules: + $ref: "#/getDefinitions/relationship" + sriov-vfs: description: | - Collection of vf-modules, a deployment unit of VNFCs + Collection of SR-IOV Virtual Functions. properties: - vf-module: + sriov-vf: type: array items: - $ref: "#/definitions/vf-module" - generic-vnf: - description: | - General purpose VNF - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO license-key-resource (Many2Many) - - TO l-interface (comprises generic-vnf, Many2Many) - - TO availability-zone (Many2Many) - - TO lag-interface (comprises generic-vnf, Many2Many) - - TO l3-network (Many2Many) - - TO pserver (Many2Many) - - TO vnf-image (Many2One) - - TO vserver (One2Many) - - TO service-instance (Many2Many) - - TO site-pair-set (Many2Many) - - TO network-profile (Many2Many) - - TO pnf (Many2Many) - - TO ipsec-configuration (Many2One) - - TO vf-module (comprises generic-vnf, One2Many) - - TO volume-group (One2Many) - - TO vnfc (One2Many) - - TO instance-group (Many2Many) - - TO entitlement (comprises generic-vnf, One2Many) - - TO license (comprises generic-vnf, One2Many) - - TO complex (Many2Many) - - TO ctag-pool (Many2Many) - - FROM virtual-data-center - - FROM logical-link - - FROM allotted-resource - required: - - vnf-id - - vnf-name - - vnf-type - - in-maint - - is-closed-loop-disabled + $ref: "#/getDefinitions/sriov-vf" + start-node-filter: properties: - vnf-id: - type: string - description: Unique id of VNF. This is unique across the graph. - vnf-name: + property-name: type: string - description: Name of VNF. - vnf-name2: + property-value: type: string - description: Alternate name of VNF. - vnf-type: + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1) + - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + + -(1) IF this SUBNET node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this SUBNET is DELETED also + -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST + + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: type: string - 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. - service-id: + description: Subnet ID, should be UUID. + subnet-name: type: string - description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED - regional-resource-zone: + description: Name associated with the subnet. + neutron-subnet-id: type: string - description: Regional way of organizing pservers, source of truth should define values - prov-status: + description: Neutron id of this subnet + gateway-address: type: string - description: Trigger for operational monitoring of this resource by Service Assurance systems. - operational-status: + description: gateway ip address + network-start-address: type: string - description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. - license-key: + description: network start address + cidr-mask: type: string - description: OBSOLETE - do not use - equipment-role: + description: cidr mask + ip-version: type: string - description: Client should send valid enumerated value + description: ip version orchestration-status: type: string - description: Orchestration status of this VNF, used by MSO. - heat-stack-id: - type: string - description: Heat stack id corresponding to this instance, managed by MSO - mso-catalog-key: - type: string - description: Corresponds to the SDN-C catalog id used to configure this VCE - management-option: - type: string - description: identifier of managed by ATT or customer - ipv4-oam-address: - type: string - description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf. - ipv4-loopback0-address: - type: string - description: v4 Loopback0 address - nm-lan-v6-address: - type: string - description: v6 Loopback address - management-v6-address: + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + description: dhcp enabled + dhcp-start: type: string - description: v6 management address - vcpu: - type: integer - format: int64 - description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE - vcpu-units: + description: the start address reserved for use by dhcp + dhcp-end: type: string - description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE - vmemory: - type: integer - format: int64 - 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 - vmemory-units: + description: the last address reserved for use by dhcp + subnet-role: type: string - description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE - vdisk: - type: integer - format: int64 - description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE - vdisk-units: + description: role of the subnet, referenced when assigning IPs + ip-assignment-direction: type: string - description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE - in-maint: - type: boolean - is-closed-loop-disabled: - type: boolean + description: ip address assignment direction of the subnet resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - summary-status: - type: string - description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. - encrypted-access-flag: - type: boolean - description: indicates whether generic-vnf access uses SSH - entitlement-assignment-group-uuid: - type: string - description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. - entitlement-resource-uuid: - type: string - description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. - license-assignment-group-uuid: - type: string - description: UUID of the license assignment group. OBSOLETE - See child relationships. - license-key-uuid: - type: string - description: UUID of the actual license resource. OBSOLETE - See child relationships. - model-invariant-id: - type: string - description: the ASDC model id for this resource or service model. - model-version-id: - type: string - description: the ASDC model version for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - model-customization-id: - type: string - description: captures the id of all the configuration used to customize the resource for the service. - widget-model-id: - type: string - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - widget-model-version: - type: string - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - as-number: - type: string - description: as-number of the VNF - regional-resource-subzone: - type: string - description: represents sub zone of the rr plane - nf-type: - type: string - description: Generic description of the type of NF - nf-function: - type: string - description: English description of Network function that the specific VNF deployment is providing - nf-role: - type: string - description: role in the network that this model will be providing - nf-naming-code: - type: string - description: string assigned to this model used for naming purposes - selflink: - type: string - description: Path to the controller object. - ipv4-oam-gateway-address: - type: string - description: Gateway address - ipv4-oam-gateway-address-prefix-length: + subnet-sequence: type: integer format: int32 - description: Prefix length for oam-address - vlan-id-outer: - type: integer - format: int64 - description: Temporary location for S-TAG to get to VCE - nm-profile-name: - type: string - description: Network Management profile of this VNF - relationship-list: + description: sequence of the subnet + host-routes: type: array items: - $ref: "#/definitions/relationship" - l-interfaces: + $ref: "#/getDefinitions/host-route" + relationship-list: type: array items: - $ref: "#/definitions/l-interface" - lag-interfaces: + $ref: "#/getDefinitions/relationship" + subnets: + properties: + subnet: type: array - items: - $ref: "#/definitions/lag-interface" - vf-modules: + items: + $ref: "#/getDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: type: array - items: - $ref: "#/definitions/vf-module" - licenses: + items: + $ref: "#/getDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant Uses l3-network, MANY2MANY) + - TO volume-group( tenant DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription Uses tenant, MANY2MANY) + - FROM vserver( vserver BelongsTo tenant, MANY2ONE) + + -TENANT cannot be deleted if related to VSERVER + + required: + - tenant-id + - tenant-name + properties: + tenant-id: + type: string + description: Unique id relative to the cloud-region. + tenant-name: + type: string + description: Readable name of tenant + tenant-context: + type: string + description: This field will store the tenant context. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vservers: type: array items: - $ref: "#/definitions/license" - entitlements: + $ref: "#/getDefinitions/vserver" + relationship-list: type: array items: - $ref: "#/definitions/entitlement" - generic-vnfs: + $ref: "#/getDefinitions/relationship" + tenants: description: | - Collection of VNFs + Collection of openstack tenants. properties: - generic-vnf: + tenant: type: array items: - $ref: "#/definitions/generic-vnf" - lag-link: + $ref: "#/getDefinitions/tenant" + tunnel-xconnect: description: | - LAG links can connect lag-interfaces - ###### Default Delete Scope - THIS_NODE_ONLY + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - FROM lag-interface - - FROM logical-link + - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4) + + -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also required: - - link-name + - id + - bandwidth-up-wan1 + - bandwidth-down-wan1 + - bandwidth-up-wan2 + - bandwidth-down-wan2 properties: - link-name: + id: type: string - description: Alphabetical concatenation of lag-interface names + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: + type: string + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: + type: string + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: + type: string + description: The WAN uplink bandwidth for WAN2 + bandwidth-down-wan2: + type: string + description: The WAN downlink bandwidth for WAN2 resource-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + description: Concurrency value relationship-list: type: array items: - $ref: "#/definitions/relationship" - lag-links: + $ref: "#/getDefinitions/relationship" + tunnel-xconnects: description: | - Collection of link aggregation connections + This object is used to store the specific tunnel cross connect aspects of an allotted resource properties: - lag-link: + tunnel-xconnect: type: array items: - $ref: "#/definitions/lag-link" - newvce: + $ref: "#/getDefinitions/tunnel-xconnect" + update: description: | - This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + required: + - update-node-type + properties: + update-node-type: + type: string + update-node-key: + type: array + items: + $ref: "#/getDefinitions/update-node-key" + update-node-uri: + type: string + action: + type: array + items: + $ref: "#/getDefinitions/action" + update-node-key: + properties: + key-name: + type: string + key-value: + type: string + vce: + description: | + Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - - TO l-interface (comprises newvce, Many2Many) + - TO availability-zone( vce Uses availability-zone, MANY2MANY) + - TO complex( vce LocatedIn complex, MANY2MANY) + - TO vserver( vce HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1) + - FROM license( license BelongsTo vce, MANY2ONE)(1) + - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1) + - FROM service-instance( service-instance ComposedOf vce, ONE2MANY) + + -(1) IF this VCE node is deleted, this FROM node is DELETED also required: - - vnf-id2 + - vnf-id - vnf-name - vnf-type properties: - vnf-id2: + vnf-id: type: string - description: Unique id of VNF, can't use same attribute name right now until we promote this new object + description: Unique id of VNF. This is unique across the graph. vnf-name: type: string description: Name of VNF. @@ -42742,208 +59694,157 @@ definitions: vnf-type: type: string 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. + service-id: + type: string + description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. + regional-resource-zone: + type: string + description: Regional way of organizing pservers, source of truth should define values prov-status: type: string - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use - ipv4-oam-address: - type: string - 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). equipment-role: type: string - description: Client should send valid enumerated value. - resource-version: - type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - ipv4-loopback0-address: - type: string - description: v4 Loopback0 address + description: Network role being played by this VNF orchestration-status: type: string - description: Orchestration status of this VNF, mastered by MSO. + description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - l-interfaces: - type: array - items: - $ref: "#/definitions/l-interface" - newvces: - description: | - This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. - properties: - newvce: - type: array - items: - $ref: "#/definitions/newvce" - pnf: - description: | - 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. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO p-interface (comprises pnf, Many2Many) - - TO lag-interface (comprises pnf, One2Many) - - TO complex (Many2One) - - TO instance-group (Many2Many) - - TO zone (Many2One) - - FROM generic-vnf - - FROM logical-link - - FROM service-instance - required: - - pnf-name - - in-maint - properties: - pnf-name: - type: string - description: unique name of Physical Network Function. - pnf-name2: - type: string - description: name of Physical Network Function. - pnf-name2-source: - type: string - description: source of name2 - pnf-id: - type: string - description: id of pnf - equip-type: - type: string - description: Equipment type. Source of truth should define valid values. - equip-vendor: - type: string - description: Equipment vendor. Source of truth should define valid values. - equip-model: - type: string - description: Equipment model. Source of truth should define valid values. - management-option: - type: string - description: identifier of managed by ATT or customer - ipaddress-v4-oam: - type: string - description: ipv4-oam-address with new naming convention for IP addresses - sw-version: - type: string - description: sw-version is the version of SW for the hosted application on the PNF. - in-maint: - type: boolean - frame-id: - type: string - description: ID of the physical frame (relay rack) where pnf is installed. - serial-number: - type: string - description: Serial number of the device - ipaddress-v4-loopback-0: - type: string - description: IPV4 Loopback 0 address - ipaddress-v6-loopback-0: - type: string - description: IPV6 Loopback 0 address - ipaddress-v4-aim: - type: string - description: IPV4 AIM address - ipaddress-v6-aim: + vpe-id: type: string - description: IPV6 AIM address - ipaddress-v6-oam: + description: Unique ID of VPE connected to this VCE. + v6-vce-wan-address: type: string - description: IPV6 OAM address - inv-status: + description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. + ipv4-oam-address: type: string - description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - prov-status: + ipv4-loopback0-address: type: string - description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] - nf-role: + description: Loopback0 address + entitlement-resource-uuid: type: string - description: Nf Role is the role performed by this instance in the network. - relationship-list: + description: OBSOLETE - see child relationships + port-groups: type: array items: - $ref: "#/definitions/relationship" - p-interfaces: + $ref: "#/getDefinitions/port-group" + licenses: type: array items: - $ref: "#/definitions/p-interface" - lag-interfaces: + $ref: "#/getDefinitions/license" + entitlements: type: array items: - $ref: "#/definitions/lag-interface" - pnfs: + $ref: "#/getDefinitions/entitlement" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vces: description: | - Collection of Physical Network Functions. + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. properties: - pnf: + vce: type: array items: - $ref: "#/definitions/pnf" - physical-link: + $ref: "#/getDefinitions/vce" + vf-module: description: | - Collection of physical connections, typically between p-interfaces - ###### Default Delete Scope - THIS_NODE_ONLY + a deployment unit of VNFCs ###### Related Nodes - - FROM p-interface + - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4) + - TO l3-network( vf-module DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module Uses vnfc, ONE2MANY) + - TO volume-group( vf-module Uses volume-group, ONE2ONE) + - TO vserver( vf-module Uses vserver, ONE2MANY) + + -(4) IF this TO node is deleted, this VF-MODULE is DELETED also + -VF-MODULE cannot be deleted if related to VNFC + required: - - link-name + - vf-module-id + - is-base-vf-module properties: - link-name: + vf-module-id: type: string - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ - speed-value: + description: Unique ID of vf-module. + vf-module-name: type: string - description: Captures the numeric part of the speed - speed-units: + description: Name of vf-module + heat-stack-id: type: string - description: Captures the units corresponding to the speed - circuit-id: + description: Heat stack id corresponding to this instance. + orchestration-status: type: string - description: Circuit it - dual-mode: + description: orchestration status of this vf-module, mastered by MSO + is-base-vf-module: + type: boolean + description: used to indicate whether or not this object is base vf module + resource-version: type: string - description: Dual access mode (e.g., primary, secondary - management-option: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + model-invariant-id: type: string - description: To provide information on who manages this circuit. A&AI or 3rd party transport provider - service-provider-name: + description: the ASDC model id for this resource or service model. + model-version-id: type: string - description: Name of the service Provider on this link. - resource-version: + description: the ASDC model version for this resource or service model. + persona-model-version: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + description: the ASDC model version for this resource or service model. + model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + widget-model-id: + type: string + description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. + widget-model-version: + type: string + description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. + contrail-service-instance-fqdn: + type: string + description: the Contrail unique ID for a service-instance + module-index: + type: integer + format: int32 + 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 + selflink: + type: string + description: Path to the controller object. relationship-list: type: array items: - $ref: "#/definitions/relationship" - physical-links: + $ref: "#/getDefinitions/relationship" + vf-modules: description: | - Collection of physical connections, typically between p-interfaces + Collection of vf-modules, a deployment unit of VNFCs properties: - physical-link: + vf-module: type: array items: - $ref: "#/definitions/physical-link" + $ref: "#/getDefinitions/vf-module" vig-server: description: | vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 - ###### Default Delete Scope - THIS_NODE_ONLY ###### Related Nodes - - FROM ipsec-configuration (is composed of vig-server) + - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4) + + -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also required: - vig-address-type properties: @@ -42962,725 +59863,641 @@ definitions: relationship-list: type: array items: - $ref: "#/definitions/relationship" + $ref: "#/getDefinitions/relationship" vig-servers: properties: vig-server: type: array items: - $ref: "#/definitions/vig-server" - ipsec-configuration: + $ref: "#/getDefinitions/vig-server" + vip-ipv4-address-list: description: | - 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 - ###### Default Delete Scope - CASCADE_TO_CHILDREN + IPv4 Address Range ###### Related Nodes - - TO vig-server (comprises ipsec-configuration, One2Many) - - FROM generic-vnf + - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY) + required: - - ipsec-configuration-id + - vip-ipv4-address properties: - ipsec-configuration-id: - type: string - description: UUID of this configuration - requested-vig-address-type: - type: string - description: Indicate the type of VIG server like AVPN, INTERNET, BOTH - requested-encryption-strength: - type: string - description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc - requested-dmz-type: - type: string - description: ATT can offer a shared DMZ or a DMZ specific to a customer - shared-dmz-network-address: - type: string - description: Network address of shared DMZ - requested-customer-name: - type: string - description: If the DMZ is a custom DMZ, this field will indicate the customer information - ike-version: - type: string - description: can be 1 or 2 - ikev1-authentication: - type: string - description: Contains values like md5, sha1, sha256, sha384 - ikev1-encryption: - type: string - description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc - ikev1-dh-group: - type: string - description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 - ikev1-am-group-id: - type: string - description: Group name defined in VIG for clients using aggressive mode - ikev1-am-password: - type: string - description: pre-shared key for the above group name - ikev1-sa-lifetime: - type: string - description: Lifetime for IKEv1 SA - ipsec-authentication: - type: string - description: md5, sha1, sha256, sha384 - ipsec-encryption: - type: string - description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc - ipsec-sa-lifetime: - type: string - description: Life time for IPSec SA - ipsec-pfs: - type: string - description: enable PFS or not - xauth-userid: - type: string - description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName - xauth-user-password: - type: string - description: Encrypted using the Juniper $9$ algorithm - dpd-interval: - type: string - description: The time between DPD probe - dpd-frequency: + vip-ipv4-address: type: string - description: Maximum number of DPD before claiming the tunnel is down + description: IP address + vip-ipv4-prefix-length: + type: integer + format: int64 + description: Prefix length, 32 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to relationship-list: type: array items: - $ref: "#/definitions/relationship" - vig-servers: - type: array - items: - $ref: "#/definitions/vig-server" - ipsec-configurations: - properties: - ipsec-configuration: - type: array - items: - $ref: "#/definitions/ipsec-configuration" - route-table-reference: + $ref: "#/getDefinitions/relationship" + vip-ipv6-address-list: description: | - Openstack route table reference. - ###### Default Delete Scope - THIS_NODE_ONLY + IPv6 Address Range ###### Related Nodes - - FROM l3-network + - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY) + required: - - route-table-reference-id - - route-table-reference-fqdn + - vip-ipv6-address properties: - route-table-reference-id: + vip-ipv6-address: type: string - description: Route Table Reference id, UUID assigned to this instance. - route-table-reference-fqdn: - type: string - description: FQDN entry in the route table. + description: IP address + vip-ipv6-prefix-length: + type: integer + format: int64 + description: Prefix length, 128 for single address + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag + is-floating: + type: boolean + description: Indicator of fixed or floating address resource-version: type: string - description: Concurrency value + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: + type: string + description: Neutron network id of the interface that address belongs to + neutron-subnet-id: + type: string + description: Neutron id of subnet that address belongs to relationship-list: type: array items: - $ref: "#/definitions/relationship" - route-table-references: - description: | - Collection of openstack route table references - properties: - route-table-reference: - type: array - items: - $ref: "#/definitions/route-table-reference" - instance-group: + $ref: "#/getDefinitions/relationship" + virtual-data-center: description: | - General mechanism for grouping instances - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - TO model (Many2Many) - - FROM l-interface - - FROM vnfc - - FROM l3-interface-ipv4-address-list - - FROM l3-interface-ipv6-address-list - - FROM l3-network - - FROM pnf - - FROM allotted-resource - - FROM generic-vnf - - FROM service-instance - required: - - instance-group-role - - model-invariant-id - - model-version-id - - id - - description - - type + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY) + + required: + - vdc-id + - vdc-name properties: - instance-group-role: - type: string - description: role of the instance group. - model-invariant-id: - type: string - description: ASDC model id for this resource or service model. - model-version-id: - type: string - description: ASDC model version uid for this resource model. - id: - type: string - description: Instance Group ID, UUID assigned to this instance. - description: - type: string - description: Descriptive text to help identify the usage of this instance-group - type: + vdc-id: type: string - description: Only valid value today is lower case ha for high availability - sub-type: + description: Unique ID of the vdc + vdc-name: type: string - description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + description: Name of the virtual data center resource-version: type: string - description: Concurrency value + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: - $ref: "#/definitions/relationship" - instance-groups: + $ref: "#/getDefinitions/relationship" + virtual-data-centers: description: | - Collection of openstack route table references + Virtual organization of cloud infrastructure elements in a data center context properties: - instance-group: + virtual-data-center: type: array items: - $ref: "#/definitions/instance-group" - zone: + $ref: "#/getDefinitions/virtual-data-center" + vlan: description: | - A zone is a grouping of assets in a location homing to the same connections into the CBB - ###### Default Delete Scope - THIS_NODE_ONLY + Definition of vlan ###### Related Nodes - - TO complex (Many2One) - - FROM cloud-region - - FROM pserver - - FROM pnf - - FROM service-instance + - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4) + - TO logical-link( vlan Uses logical-link, MANY2MANY)(2) + - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1) + + -(1) IF this VLAN node is deleted, this FROM node is DELETED also + -(2) IF this VLAN node is deleted, this TO node is DELETED also + -(4) IF this TO node is deleted, this VLAN is DELETED also required: - - zone-id - - zone-name - - design-type - - zone-context + - vlan-interface + - in-maint + - is-ip-unnumbered properties: - zone-id: - type: string - description: Code assigned by AIC to the zone - zone-name: - type: string - description: English name associated with the zone - design-type: - type: string - description: Design of zone [Medium/Large?] - zone-context: - type: string - description: Context of zone [production/test] - status: + vlan-interface: type: string - description: Status of a zone. + description: String that identifies the interface + vlan-id-inner: + type: integer + format: int64 + description: Inner VLAN tag + vlan-id-outer: + type: integer + format: int64 + description: Outer VLAN tag resource-version: type: string - description: Concurrency value - relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - zones: - description: | - Collection of zones - properties: - zone: - type: array - items: - $ref: "#/definitions/zone" - network: - description: | - Namespace for network inventory resources. - properties: - logical-links: - type: array - items: - $ref: "#/definitions/logical-link" - site-pair-sets: - type: array - items: - $ref: "#/definitions/site-pair-set" - vpn-bindings: - type: array - items: - $ref: "#/definitions/vpn-binding" - vpls-pes: - type: array - items: - $ref: "#/definitions/vpls-pe" - multicast-configurations: - type: array - items: - $ref: "#/definitions/multicast-configuration" - vces: - type: array - items: - $ref: "#/definitions/vce" - vnfcs: - type: array - items: - $ref: "#/definitions/vnfc" - l3-networks: - type: array - items: - $ref: "#/definitions/l3-network" - network-policies: - type: array - items: - $ref: "#/definitions/network-policy" - generic-vnfs: - type: array - items: - $ref: "#/definitions/generic-vnf" - lag-links: - type: array - items: - $ref: "#/definitions/lag-link" - newvces: - type: array - items: - $ref: "#/definitions/newvce" - pnfs: - type: array - items: - $ref: "#/definitions/pnf" - physical-links: - type: array - items: - $ref: "#/definitions/physical-link" - ipsec-configurations: - type: array - items: - $ref: "#/definitions/ipsec-configuration" - route-table-references: - type: array - items: - $ref: "#/definitions/route-table-reference" - instance-groups: - type: array - items: - $ref: "#/definitions/instance-group" - zones: - type: array - items: - $ref: "#/definitions/zone" - inventory: - properties: - search: - type: object - $ref: "#/definitions/search" - actions: - type: object - $ref: "#/definitions/actions" - cloud-infrastructure: - type: object - $ref: "#/definitions/cloud-infrastructure" - business: - type: object - $ref: "#/definitions/business" - service-design-and-creation: - type: object - $ref: "#/definitions/service-design-and-creation" - network: - type: object - $ref: "#/definitions/network" - aai-internal: - type: object - $ref: "#/definitions/aai-internal" - nodes: - type: array - items: - $ref: "#/definitions/" - edge-tag-query-result: - properties: - tagged-inventory-item-list: - type: array - items: - $ref: "#/definitions/tagged-inventory-item-list" - tagged-inventory-item-list: - properties: - inventory-item: - type: array - items: - $ref: "#/definitions/inventory-item" - inventory-item: - properties: - inventory-item-type: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: type: string - inventory-item-link: + description: Captures the numeric part of the speed + speed-units: type: string - inventory-item-data: - type: array - items: - $ref: "#/definitions/inventory-item-data" - tagged-inventory-item-list: - type: array - items: - $ref: "#/definitions/tagged-inventory-item-list" - inventory-item-data: - properties: - property-name: + description: Captures the units corresponding to the speed + vlan-description: type: string - property-value: + description: Used to describe (the service associated with) the vlan + backdoor-connection: type: string - edge-tag-query-request: - properties: - edge-tag: + description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. + vpn-key: type: string - result-detail: + description: This indicates the customers VPN ID associated with this vlan + orchestration-status: type: string - start-node-type: + description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + prov-status: type: string - start-node-filter: + description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. + is-ip-unnumbered: + type: boolean + description: Flag indicating the interface uses the IP Unnumbered configuration. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: type: array items: - $ref: "#/definitions/start-node-filter" - include-node-filter: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: type: array items: - $ref: "#/definitions/include-node-filter" - secondary-filter: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + vlans: + properties: + vlan: type: array items: - $ref: "#/definitions/secondary-filter" - start-node-filter: + $ref: "#/getDefinitions/vlan" + vnf: + description: | + Abstract vnf class + required: + - vnf-id properties: - property-name: - type: string - property-value: + vnf-id: type: string - include-node-filter: + description: Unique id of VNF. This is unique across the graph. + vnf-image: + description: | + Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. + ###### Related Nodes + - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) + + -VNF-IMAGE cannot be deleted if related to GENERIC-VNF + + required: + - vnf-image-uuid + - application + - application-vendor properties: - include-node-type: + vnf-image-uuid: type: string - secondary-filter: - properties: - property-name: + description: Unique ID of this asset + application: type: string - filter-type: + description: The application that the image instantiates. + application-vendor: type: string - property-value: + description: The vendor of the application. + application-version: type: string - search-results: - properties: - result-data: - type: array - items: - $ref: "#/definitions/result-data" - result-data: - properties: - resource-type: + description: The version of the application. + selflink: type: string - description: The specific type of node in the A&AI graph - resource-link: + description: URL to endpoint where AAI can get more details + resource-version: type: string - description: The URL to the specific resource - sdn-zone-response: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + vnf-images: + description: | + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. properties: - oam-networks: - type: object - $ref: "#/definitions/oam-networks" - az-and-dvs-switches: + vnf-image: type: array items: - $ref: "#/definitions/az-and-dvs-switches" - az-and-dvs-switches: - properties: - dvs-switches: - type: object - $ref: "#/definitions/dvs-switches" - availability-zone: - type: object - $ref: "#/definitions/availability-zone" - update: + $ref: "#/getDefinitions/vnf-image" + vnfc: description: | - Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. + ###### Related Nodes + - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4) + - TO instance-group( vnfc MemberOf instance-group, MANY2MANY) + - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY) + - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY) + - TO vserver( vnfc HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module Uses vnfc, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1) + + -(1) IF this VNFC node is deleted, this FROM node is DELETED also + -(4) IF this TO node is deleted, this VNFC is DELETED also required: - - update-node-type + - vnfc-name + - nfc-naming-code + - nfc-function + - in-maint + - is-closed-loop-disabled properties: - update-node-type: + vnfc-name: type: string - update-node-key: - type: array - items: - $ref: "#/definitions/update-node-key" - update-node-uri: + description: Unique ID of vnfc. + nfc-naming-code: type: string - action: - type: array - items: - $ref: "#/definitions/action" - action: - properties: - action-type: + description: Short code that is used in naming instances of the item being modeled + nfc-function: type: string - action-data: - type: array - items: - $ref: "#/definitions/action-data" - action-data: - properties: - property-name: + description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service + prov-status: type: string - property-value: + description: prov status of this vnfc + orchestration-status: type: string - update-node-key: - properties: - key-name: + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: type: string - key-value: + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) + is-closed-loop-disabled: + type: boolean + description: used to indicate whether closed loop function is enabled on this node + group-notation: type: string - notify: - required: - - event-id - properties: - event-id: + description: Group notation of VNFC + model-invariant-id: type: string - node-type: + description: the ASDC model id for this resource or service model. + model-version-id: type: string - event-trigger: + description: the ASDC model version for this resource or service model. + resource-version: type: string - key-data: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l3-interface-ipv4-address-list: type: array items: - $ref: "#/definitions/key-data" - selflink: - type: string - key-data: - properties: - key-name: - type: string - key-value: - type: string - notification-event: + $ref: "#/getDefinitions/l3-interface-ipv4-address-list" + l3-interface-ipv6-address-list: + type: array + items: + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. properties: - cambria.partition: - type: string - notification-event-header: - type: object - $ref: "#/definitions/notification-event-header" - notification-event-header: + vnfc: + type: array + items: + $ref: "#/getDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3) + + -(3) IF this FROM node is deleted, this VOLUME is DELETED also + required: + - volume-id + - volume-selflink properties: - id: - type: string - timestamp: - type: string - source-name: + volume-id: type: string - domain: + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: type: string - sequence-number: + description: URL to endpoint where AAI can get more details + resource-version: type: string - severity: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + volume-group: + description: | + Persistent block-level storage. + ###### Related Nodes + - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module Uses volume-group, ONE2ONE) + - FROM tenant( tenant DependsOn volume-group, ONE2MANY) + + required: + - volume-group-id + - volume-group-name + - vnf-type + properties: + volume-group-id: type: string - event-type: + description: Unique ID of volume-group. + volume-group-name: type: string - version: + description: Name of the volume group. + heat-stack-id: type: string - action: + description: Heat stack id corresponding to this volume-group + vnf-type: type: string - entity-type: + 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. + orchestration-status: type: string - top-entity-type: + description: Orchestration status of this volume-group + model-customization-id: type: string - entity-link: + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-model-customization-id: type: string - status: + description: helps relate the volume group to the vf-module whose components will require the volume group + resource-version: type: string - reserved-prop-names: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + volume-groups: description: | - Internal map to define some reserved properties of a vertex + Collection of persistent block-level storage. properties: - last-mod-source-of-truth: + volume-group: + type: array + items: + $ref: "#/getDefinitions/volume-group" + volumes: + description: | + Collection of ephemeral Block storage volumes. + properties: + volume: + type: array + items: + $ref: "#/getDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1) + - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1) + + -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also + required: + - equipment-name + properties: + equipment-name: type: string - aai-node-type: + prov-status: type: string - aai-created-ts: - type: integer - format: int64 - aai-unique-key: + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: type: string - aai-last-mod-ts: + 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). + equipment-role: + type: string + description: Client should send valid enumerated value, e.g., VPLS-PE. + vlan-id-outer: type: integer format: int64 - source-of-truth: - type: string - aai-uri: + description: Temporary location for stag to get to VCE + resource-version: type: string - edge-prop-names: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + p-interfaces: + type: array + items: + $ref: "#/getDefinitions/p-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + vpls-pes: description: | - Internal map to define the properties of an edge and interpret the map EdgeRules + Collection of VPLS Provider Edge routers properties: - edgeLabel: - type: string - direction: + vpls-pe: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + vpn-binding: + description: | + VPN binding + ###### Related Nodes + - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY) + - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY) + - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1) + + -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also + -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK + + required: + - vpn-id + - vpn-name + properties: + vpn-id: type: string - multiplicityRule: + description: VPN ID, globally unique within A&AI + vpn-name: type: string - contains-other-v: + description: VPN Name + vpn-platform: type: string - delete-other-v: + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: type: string - SVC-INFRA: + description: Type of the vpn, should be taken from enumerated/valid values + vpn-region: type: string - prevent-delete: + description: region of customer vpn + customer-vpn-id: type: string - model-and-named-query-search: - description: | - ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query - properties: - query-parameters: - type: object - $ref: "#/definitions/query-parameters" - instance-filters: - type: object - $ref: "#/definitions/instance-filters" - secondary-filts: - type: object - $ref: "#/definitions/secondary-filts" - top-node-type: + description: id for this customer vpn + route-distinguisher: type: string - secondary-filter-cut-point: + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + resource-version: type: string - query-parameters: - description: | - QueryParameters for performing a named-query or model query + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + route-targets: + type: array + items: + $ref: "#/getDefinitions/route-target" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: properties: - named-query: - type: object - $ref: "#/definitions/named-query" - overloaded-model: - type: object - $ref: "#/definitions/overloaded-model" - overloaded-model: + vpn-binding: + type: array + items: + $ref: "#/getDefinitions/vpn-binding" + vserver: description: | - Allows for legacy POST of old-style and new-style models + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver BelongsTo tenant, MANY2ONE) + - TO flavor( vserver Uses flavor, MANY2ONE) + - TO image( vserver Uses image, MANY2ONE) + - TO pserver( vserver HostedOn pserver, MANY2ONE) + - TO snapshot( vserver Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2) + - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY) + - FROM vce( vce HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1) + - FROM vf-module( vf-module Uses vserver, ONE2MANY) + - FROM vnfc( vnfc HostedOn vserver, ONE2MANY) + + -(1) IF this VSERVER node is deleted, this FROM node is DELETED also + -(2) IF this VSERVER node is deleted, this TO node is DELETED also required: - - model-invariant-id - - model-name-version-id - - model-type - - model-name - - model-id - - model-version + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled properties: - model-invariant-id: - type: string - description: Unique identifier corresponding to the main definition of a model in ASDC - model-name-version-id: - type: string - description: Unique identifier corresponding to one version of a model in ASDC - model-type: + vserver-id: type: string - description: Type of the model, e.g., service, resource, widget, etc. - model-name: + description: Unique identifier for this vserver relative to its tenant + vserver-name: type: string - description: Name of the model, which can change from version to version. - model-id: + description: Name of vserver + vserver-name2: type: string - description: Invariant unique ID which does not change from version to version - model-version: + description: Alternative name of vserver + prov-status: type: string - description: Version - model-description: + description: Trigger for operational monitoring of this resource by Service Assurance systems. + vserver-selflink: type: string - description: Description + description: URL to endpoint where AAI can get more details + in-maint: + type: boolean + description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs. + is-closed-loop-disabled: + type: boolean + description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - model-vers: - type: object - $ref: "#/definitions/model-vers" + volumes: + type: array + items: + $ref: "#/getDefinitions/volume" relationship-list: - type: object - $ref: "#/definitions/relationship-list" - instance-filters: - description: | - InstanceFilters for performing a named-query or model query - properties: - instance-filter: type: array - items: - $ref: "#/definitions/instance-filter" - instance-filter: - description: | - InstanceFilter for performing a named-query or model query - secondary-filts: + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + vservers: description: | - SecondaryFilts for performing a named-query or model query + Collection of virtual Servers, aka virtual machines or VMs. properties: - secondary-filt: + vserver: type: array items: - $ref: "#/definitions/secondary-filt" - secondary-filt: - description: | - SecondaryFilt for performing a named-query or model query - properties: + $ref: "#/getDefinitions/vserver" + zone: description: | - Property holder for query properties or instance properties + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE) + - FROM pnf( pnf LocatedIn zone, MANY2ONE) + - FROM pserver( pserver LocatedIn zone, MANY2ONE) + - FROM service-instance( service-instance LocatedIn zone, MANY2ONE) + + required: + - zone-id + - zone-name + - design-type + - zone-context properties: - property-name: + zone-id: type: string - property-value: + description: Code assigned by AIC to the zone + zone-name: type: string - response-list: - description: | - Response container for the results of a named-query or model query - properties: - inventory-response-items: - type: object - $ref: "#/definitions/inventory-response-items" - inventory-response-items: - description: | - Container for inventory items in response list - properties: - inventory-response-item: - type: array - items: - $ref: "#/definitions/inventory-response-item" - inventory-response-item: - description: | - Inventory item for response list - properties: - model-name: + description: English name associated with the zone + design-type: type: string - extra-properties: - type: object - $ref: "#/definitions/extra-properties" - inventory-response-items: - type: object - $ref: "#/definitions/inventory-response-items" - extra-properties: - description: | - Extra properties for inventory item for response list - properties: - extra-property: - type: array - items: - $ref: "#/definitions/extra-property" - extra-property: - properties: - property-name: + description: Design of zone [Medium/Large?] + zone-context: type: string - property-value: + description: Context of zone [production/test] + status: type: string - vnf: + description: Status of a zone. + resource-version: + type: string + description: Concurrency value + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + zones: description: | - Abstract vnf class - required: - - vnf-id + Collection of zones properties: - vnf-id: - type: string - description: Unique id of VNF. This is unique across the graph. + zone: + type: array + items: + $ref: "#/getDefinitions/zone"