X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Faai-common.git;a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v9.yaml;fp=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_yaml%2Faai_swagger_v9.yaml;h=a793e1b2d0bfa36f7c3726badab1bcbb94a85e7a;hp=905c350b7506803100e32a50e9fc7568648650fb;hb=aefeb9ff5ec5c7ce3c20f420db1116c31f034615;hpb=4eae7a8de0381e013daa717626c6c431d1dca35b diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml index 905c350b..a793e1b2 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v9.yaml @@ -1,28 +1,9 @@ -# -# ============LICENSE_START======================================================= -# org.onap.aai -# ================================================================================ -# Copyright © 2017 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. -# - swagger: "2.0" info: description: | + + [Differences versus the previous schema version](apidocs/aai_swagger_v9.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. @@ -71,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/v9/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true schema: $ref: "#/definitions/relationship" @@ -108,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: @@ -132,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: @@ -141,16 +128,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: data-center-code in: query description: Data center code which can be an alternate way to identify a complex @@ -170,7 +160,10 @@ paths: 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 @@ -187,22 +180,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-pool" delete: tags: - CloudInfrastructure @@ -224,16 +271,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 @@ -253,7 +303,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: @@ -262,6 +312,7 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: data-center-code in: query description: Data center code which can be an alternate way to identify a complex @@ -298,9 +349,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/v9/CloudInfrastructureComplexesComplex.json) required: true schema: $ref: "#/definitions/relationship" @@ -325,6 +377,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: @@ -339,7 +392,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: @@ -348,6 +401,7 @@ paths: description: Unique identifier for physical location, e.g., CLLI required: true type: string + example: __PHYSICAL-LOCATION-ID__ - name: data-center-code in: query description: Data center code which can be an alternate way to identify a complex @@ -367,7 +421,10 @@ paths: 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 @@ -384,12 +441,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/complex" delete: tags: - CloudInfrastructure @@ -411,6 +508,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 @@ -430,7 +528,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/complexes" + $ref: "#/getDefinitions/complexes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship: @@ -454,19 +552,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/v9/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true schema: $ref: "#/definitions/relationship" @@ -491,16 +592,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: @@ -515,7 +619,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: @@ -524,16 +628,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -563,7 +670,10 @@ paths: 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 @@ -580,22 +690,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/volume-group" delete: tags: - CloudInfrastructure @@ -617,16 +781,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 @@ -646,7 +813,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: @@ -655,11 +822,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -691,29 +860,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: $ref: "#/definitions/relationship" @@ -738,26 +912,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: @@ -772,7 +951,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: @@ -781,26 +960,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -843,7 +1027,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing volume - description: 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 @@ -860,32 +1047,100 @@ 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true schema: $ref: "#/definitions/volume" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/volume" delete: tags: - CloudInfrastructure @@ -907,26 +1162,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 @@ -946,7 +1206,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: @@ -955,21 +1215,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -1029,24 +1293,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -1071,21 +1339,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: @@ -1107,34 +1379,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -1159,31 +1437,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: @@ -1205,39 +1489,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -1262,36 +1553,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: @@ -1306,7 +1604,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: @@ -1315,36 +1613,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -1429,7 +1734,10 @@ paths: 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -1446,42 +1754,124 @@ 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure @@ -1503,36 +1893,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 @@ -1559,39 +1956,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -1616,36 +2020,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: @@ -1660,7 +2071,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: @@ -1669,36 +2080,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -1783,7 +2201,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -1800,42 +2221,124 @@ 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure @@ -1857,36 +2360,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 @@ -1906,7 +2416,7 @@ 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: @@ -1915,31 +2425,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -2008,7 +2524,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing vlan - description: 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 @@ -2025,37 +2544,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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - CloudInfrastructure @@ -2077,31 +2671,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 @@ -2121,7 +2721,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: @@ -2130,26 +2730,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -2224,34 +2829,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -2276,31 +2887,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: @@ -2315,7 +2932,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: @@ -2324,31 +2941,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -2426,7 +3049,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing sriov-vf - description: 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 @@ -2443,37 +3069,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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - CloudInfrastructure @@ -2495,31 +3196,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 @@ -2539,7 +3246,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: @@ -2548,26 +3255,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -2642,29 +3354,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -2689,26 +3406,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: @@ -2730,34 +3452,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -2782,31 +3510,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: @@ -2821,7 +3555,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: @@ -2830,31 +3564,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -2928,7 +3668,10 @@ paths: 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 @@ -2945,43 +3688,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: 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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + patch: tags: - CloudInfrastructure - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 @@ -2997,94 +3757,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: 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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship - 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: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - 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 + 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. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -3100,154 +3815,48 @@ 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: l3-interface-ipv6-address - in: path - description: IP address - required: true - 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}/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: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList - 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: 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: tenant-id - in: path - description: Unique id relative to the cloud-region. - required: true - type: string - - name: vserver-id - in: path - description: Unique identifier for this vserver relative to its tenant - 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: 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: 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 + 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 + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -3263,43 +3872,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: 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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.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: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -3315,43 +3930,44 @@ 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: resource-version - in: query - description: resource-version for concurrency - required: true - 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}: + 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: - CloudInfrastructure - summary: returns l-interface - description: returns l-interface - operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -3359,7 +3975,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: @@ -3368,26 +3984,341 @@ 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: 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: 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 + 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 + 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. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + 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 + 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-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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList + 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-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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - CloudInfrastructure + summary: returns l-interface + description: returns l-interface + operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + 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: 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -3445,7 +4376,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l-interface - description: 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 @@ -3462,32 +4396,100 @@ 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/l-interface" + patch: + tags: + - 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: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface + 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: body + in: body + description: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - CloudInfrastructure @@ -3509,26 +4511,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 @@ -3548,7 +4555,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: @@ -3557,21 +4564,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -3624,7 +4635,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: @@ -3633,21 +4644,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -3690,7 +4705,10 @@ paths: 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 @@ -3707,27 +4725,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vserver" delete: tags: - CloudInfrastructure @@ -3749,21 +4828,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 @@ -3783,7 +4866,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: @@ -3792,16 +4875,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -3838,19 +4924,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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) required: true schema: $ref: "#/definitions/relationship" @@ -3875,16 +4964,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: @@ -3899,7 +4991,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: @@ -3908,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: tenant-id in: path description: Unique id relative to the cloud-region. required: true type: string + example: __TENANT-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -3937,7 +5032,10 @@ paths: 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 @@ -3954,22 +5052,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/tenant" delete: tags: - CloudInfrastructure @@ -3991,16 +5143,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 @@ -4020,7 +5175,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: @@ -4029,11 +5184,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4065,19 +5222,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/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: $ref: "#/definitions/relationship" @@ -4102,16 +5262,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: @@ -4126,7 +5289,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: @@ -4135,16 +5298,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4164,7 +5330,10 @@ paths: 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 @@ -4181,22 +5350,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/flavor" delete: tags: - CloudInfrastructure @@ -4218,16 +5441,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 @@ -4247,7 +5473,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: @@ -4256,11 +5482,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4292,19 +5520,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/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true schema: $ref: "#/definitions/relationship" @@ -4329,16 +5560,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: @@ -4353,7 +5587,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: @@ -4362,16 +5596,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4396,7 +5633,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing group-assignment - description: 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 @@ -4413,22 +5653,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: 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 created or updated + description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 + 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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/group-assignment" delete: tags: - CloudInfrastructure @@ -4450,16 +5744,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 @@ -4479,7 +5776,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: @@ -4488,11 +5785,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4524,19 +5823,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/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: $ref: "#/definitions/relationship" @@ -4561,16 +5863,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: @@ -4585,7 +5890,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: @@ -4594,16 +5899,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4643,7 +5951,10 @@ paths: 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 @@ -4660,22 +5971,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/snapshot" delete: tags: - CloudInfrastructure @@ -4697,16 +6062,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 @@ -4726,7 +6094,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: @@ -4735,11 +6103,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4771,19 +6141,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/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true schema: $ref: "#/definitions/relationship" @@ -4808,16 +6181,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: @@ -4832,7 +6208,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: @@ -4841,20 +6217,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -4889,7 +6269,10 @@ paths: 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 @@ -4906,26 +6289,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" delete: tags: - CloudInfrastructure @@ -4947,20 +6390,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 @@ -4980,7 +6427,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: @@ -4989,16 +6436,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5043,7 +6493,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: @@ -5052,16 +6502,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5096,7 +6549,10 @@ paths: 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 @@ -5113,22 +6569,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/image" delete: tags: - CloudInfrastructure @@ -5150,16 +6660,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 @@ -5179,7 +6692,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: @@ -5188,11 +6701,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5224,19 +6739,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/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: $ref: "#/definitions/relationship" @@ -5261,16 +6779,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: @@ -5285,7 +6806,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: @@ -5294,16 +6815,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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5323,7 +6847,10 @@ paths: 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 @@ -5340,28 +6867,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: 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/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: $ref: "#/definitions/dvs-switch" - delete: + patch: tags: - CloudInfrastructure - summary: delete an existing dvs-switch - description: delete an existing dvs-switch - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + 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 @@ -5377,102 +6918,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: switch-name in: path description: DVS switch name required: true type: string - - 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}/dvs-switches: - get: - tags: - - CloudInfrastructure - summary: returns dvs-switches - description: returns dvs-switches - operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/dvs-switches" - "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}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship - 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: network-uuid - in: path - description: UUID of the network. Unique across a cloud-region - required: true - type: string + example: __SWITCH-NAME__ - name: body in: body - description: relationship object that needs to be created or updated + description: dvs-switch object that needs to be created or updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/dvs-switch" delete: tags: - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + summary: delete an existing dvs-switch + description: delete an existing dvs-switch + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -5488,23 +6958,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: network-uuid + example: __CLOUD-REGION-ID__ + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: + example: __SWITCH-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}/dvs-switches: get: tags: - CloudInfrastructure - summary: returns oam-network - description: returns oam-network - operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + summary: returns dvs-switches + description: returns dvs-switches + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches produces: - application/json - application/xml @@ -5512,7 +6990,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/oam-network" + $ref: "#/getDefinitions/dvs-switches" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5521,16 +6999,133 @@ 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: 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}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + 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__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: + get: + tags: + - CloudInfrastructure + summary: returns oam-network + description: returns oam-network + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-network" + "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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5556,7 +7151,10 @@ paths: 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 @@ -5573,22 +7171,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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/oam-network" delete: tags: - CloudInfrastructure @@ -5610,16 +7262,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 @@ -5639,7 +7294,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: @@ -5648,11 +7303,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5684,19 +7341,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/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) required: true schema: $ref: "#/definitions/relationship" @@ -5721,16 +7381,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: @@ -5745,7 +7408,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: @@ -5754,16 +7417,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__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5778,7 +7444,10 @@ paths: 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 @@ -5795,22 +7464,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: 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/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) required: true schema: $ref: "#/definitions/availability-zone" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/availability-zone" delete: tags: - CloudInfrastructure @@ -5832,16 +7555,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__ - name: resource-version in: query description: resource-version for concurrency @@ -5861,7 +7587,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/availability-zones" + $ref: "#/getDefinitions/availability-zones" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5870,11 +7596,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5906,14 +7634,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 + 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/v9/CloudInfrastructureCloudRegionsCloudRegion.json) required: true schema: $ref: "#/definitions/relationship" @@ -5938,11 +7668,13 @@ 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__ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: get: tags: @@ -5957,7 +7689,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/cloud-region" + $ref: "#/getDefinitions/cloud-region" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5966,11 +7698,13 @@ 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5985,7 +7719,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing cloud-region - description: 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 @@ -6002,17 +7739,64 @@ 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: body in: body - description: cloud-region object that needs to be created or updated + description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: 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: cloud-region object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/cloud-region" delete: tags: - CloudInfrastructure @@ -6034,11 +7818,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -6058,7 +7844,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/cloud-regions" + $ref: "#/getDefinitions/cloud-regions" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: @@ -6082,9 +7868,10 @@ paths: 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/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json) required: true schema: $ref: "#/definitions/relationship" @@ -6109,6 +7896,7 @@ paths: description: Unique name of network profile. required: true type: string + example: __NM-PROFILE-NAME__ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}: get: tags: @@ -6123,7 +7911,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-profile" + $ref: "#/getDefinitions/network-profile" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6132,11 +7920,15 @@ paths: description: Unique name of network profile. required: true type: string + example: __NM-PROFILE-NAME__ put: tags: - CloudInfrastructure summary: create or update an existing network-profile - description: 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 @@ -6153,12 +7945,52 @@ paths: description: Unique name of network profile. required: true type: string + example: __NM-PROFILE-NAME__ - name: body in: body - description: network-profile object that needs to be created or updated + description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json) required: true 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 + example: __NM-PROFILE-NAME__ + - name: body + in: body + description: network-profile object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/network-profile" delete: tags: - CloudInfrastructure @@ -6180,6 +8012,7 @@ paths: description: Unique name of network profile. required: true type: string + example: __NM-PROFILE-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -6199,7 +8032,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-profiles" + $ref: "#/getDefinitions/network-profiles" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: @@ -6223,9 +8056,10 @@ paths: 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/v9/CloudInfrastructurePserversPserver.json) required: true schema: $ref: "#/definitions/relationship" @@ -6250,6 +8084,7 @@ paths: 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: @@ -6271,14 +8106,16 @@ 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: 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -6303,11 +8140,13 @@ 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}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: @@ -6329,24 +8168,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 + 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -6371,21 +8214,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 + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + 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: @@ -6407,29 +8254,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 + 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -6454,26 +8306,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 + 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}/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: @@ -6488,7 +8345,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: @@ -6497,26 +8354,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 + example: __VLAN-INTERFACE__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -6587,7 +8449,10 @@ paths: 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -6604,32 +8469,100 @@ 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-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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure @@ -6651,26 +8584,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 + 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 @@ -6697,29 +8635,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 + 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -6744,26 +8687,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 + 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}/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: @@ -6778,7 +8726,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: @@ -6787,26 +8735,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 + example: __VLAN-INTERFACE__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -6877,7 +8830,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -6894,38 +8850,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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + 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-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 @@ -6941,26 +8913,83 @@ 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: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + 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: + "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: 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 @@ -6980,7 +9009,7 @@ 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: @@ -6989,21 +9018,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 + example: __INTERFACE-NAME__ - name: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -7058,7 +9091,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing vlan - description: 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 @@ -7075,27 +9111,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 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: vlan 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + 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: + "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: 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - CloudInfrastructure @@ -7117,21 +9214,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 + 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 @@ -7151,7 +9252,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: @@ -7160,16 +9261,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -7230,24 +9334,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 + 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -7272,21 +9380,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 + 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/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: @@ -7301,7 +9413,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: @@ -7310,21 +9422,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -7388,7 +9504,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing sriov-vf - description: 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 @@ -7405,27 +9524,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 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: sriov-vf 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - CloudInfrastructure @@ -7447,21 +9627,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 + 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 @@ -7481,7 +9665,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: @@ -7490,16 +9674,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -7560,19 +9747,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 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -7597,16 +9787,19 @@ 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__ /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: @@ -7628,24 +9821,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 + 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -7670,21 +9867,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 + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + 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: @@ -7699,7 +9900,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: @@ -7708,21 +9909,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 + example: __INTERFACE-NAME__ - name: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -7782,7 +9987,10 @@ paths: 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: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -7799,27 +10007,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 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: 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure @@ -7841,21 +10110,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 + 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 @@ -7882,24 +10155,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 + 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -7924,21 +10201,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 + 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: @@ -7953,7 +10234,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: @@ -7962,21 +10243,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 + example: __INTERFACE-NAME__ - name: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -8036,7 +10321,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -8053,27 +10341,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 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 + description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure @@ -8095,21 +10444,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 + 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 @@ -8129,7 +10482,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: @@ -8138,16 +10491,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -8191,7 +10547,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l-interface - description: 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 @@ -8208,22 +10567,76 @@ 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: 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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/l-interface" + patch: + tags: + - 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: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - CloudInfrastructure @@ -8245,16 +10658,19 @@ 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: resource-version in: query description: resource-version for concurrency @@ -8274,7 +10690,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: @@ -8283,11 +10699,13 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -8326,7 +10744,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interface" + $ref: "#/getDefinitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8335,11 +10753,13 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -8368,7 +10788,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing p-interface - description: 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 @@ -8385,17 +10808,64 @@ 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: body in: body - description: p-interface object that needs to be created or updated + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json) required: true 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: 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: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" delete: tags: - CloudInfrastructure @@ -8417,11 +10887,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -8441,7 +10913,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interfaces" + $ref: "#/getDefinitions/p-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8450,6 +10922,7 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -8490,14 +10963,16 @@ 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: 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -8522,11 +10997,13 @@ 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__ /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: @@ -8548,24 +11025,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 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -8590,21 +11071,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 + 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__ /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: @@ -8626,29 +11111,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-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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -8673,26 +11163,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: 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/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: @@ -8707,7 +11202,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: @@ -8716,26 +11211,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: 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -8811,7 +11311,10 @@ paths: 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -8828,38 +11331,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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + 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 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 @@ -8875,37 +11394,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 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: 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 created or updated. 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/l3-interface-ipv4-address-list" + delete: tags: - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + 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 @@ -8921,29 +11446,85 @@ 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-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}/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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + 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 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -8968,26 +11549,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: 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: @@ -9002,7 +11588,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: @@ -9011,26 +11597,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: 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -9106,7 +11697,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -9123,32 +11717,100 @@ 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: l3-interface-ipv6-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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + 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 + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure @@ -9170,26 +11832,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: 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 @@ -9209,7 +11876,7 @@ 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: @@ -9218,21 +11885,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -9292,7 +11963,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing vlan - description: 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 @@ -9309,27 +11983,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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/vlan" + patch: + tags: + - CloudInfrastructure + 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 + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - CloudInfrastructure @@ -9351,21 +12086,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 + 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 @@ -9385,7 +12124,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: @@ -9394,16 +12133,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -9469,24 +12211,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 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -9511,21 +12257,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 + 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__ /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: @@ -9540,7 +12290,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: @@ -9549,21 +12299,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -9632,7 +12386,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing sriov-vf - description: 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 @@ -9649,27 +12406,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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/sriov-vf" + patch: + tags: + - CloudInfrastructure + 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 + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - CloudInfrastructure @@ -9691,21 +12509,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 + 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 @@ -9725,7 +12547,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: @@ -9734,16 +12556,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -9809,19 +12634,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 + 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -9846,16 +12674,19 @@ 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__ /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: @@ -9877,24 +12708,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 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -9919,21 +12754,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 + 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__ /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: @@ -9948,7 +12787,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: @@ -9957,21 +12796,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10036,7 +12879,10 @@ paths: 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: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -10053,27 +12899,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 + 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - CloudInfrastructure @@ -10095,21 +13002,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 + 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 @@ -10136,24 +13047,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 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -10178,21 +13093,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 + 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: @@ -10207,7 +13126,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: @@ -10216,21 +13135,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10295,7 +13218,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -10312,27 +13238,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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + 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 + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - CloudInfrastructure @@ -10354,21 +13341,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 + 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 @@ -10388,7 +13379,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: @@ -10397,16 +13388,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10455,7 +13449,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing l-interface - description: 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 @@ -10472,22 +13469,76 @@ 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: 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/l-interface" + patch: + tags: + - 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 + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - CloudInfrastructure @@ -10509,16 +13560,19 @@ 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: resource-version in: query description: resource-version for concurrency @@ -10538,7 +13592,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: @@ -10547,11 +13601,13 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10595,7 +13651,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interface" + $ref: "#/getDefinitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10604,11 +13660,13 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10642,7 +13700,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing lag-interface - description: 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 @@ -10659,17 +13720,64 @@ 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: body in: body - description: lag-interface 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/lag-interface" + patch: + tags: + - 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 + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" delete: tags: - CloudInfrastructure @@ -10691,11 +13799,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -10715,7 +13825,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/getDefinitions/lag-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10724,6 +13834,7 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10757,7 +13868,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/pserver" + $ref: "#/getDefinitions/pserver" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10766,6 +13877,7 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -10789,7 +13901,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing pserver - description: 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 @@ -10806,12 +13921,52 @@ paths: description: Value from executing hostname on the compute node. required: true type: string + example: __HOSTNAME__ - name: body in: body - description: pserver object that needs to be created or updated + description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json) required: true 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: pserver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/pserver" delete: tags: - CloudInfrastructure @@ -10833,6 +13988,7 @@ paths: 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 @@ -10852,7 +14008,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/pservers" + $ref: "#/getDefinitions/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: @@ -10876,9 +14032,10 @@ paths: 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/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) required: true schema: $ref: "#/definitions/relationship" @@ -10903,6 +14060,7 @@ paths: description: Unique ID of the vdc required: true type: string + example: __VDC-ID__ /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}: get: tags: @@ -10917,7 +14075,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/virtual-data-center" + $ref: "#/getDefinitions/virtual-data-center" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -10926,6 +14084,7 @@ paths: description: Unique ID of the vdc required: true type: string + example: __VDC-ID__ - name: vdc-name in: query description: Name of the virtual data center @@ -10935,7 +14094,10 @@ paths: tags: - CloudInfrastructure summary: create or update an existing virtual-data-center - description: 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 @@ -10952,12 +14114,52 @@ paths: description: Unique ID of the vdc required: true type: string + example: __VDC-ID__ - name: body in: body - description: virtual-data-center object that needs to be created or updated + description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: Unique ID of the vdc + required: true + type: string + example: __VDC-ID__ + - name: body + in: body + description: virtual-data-center object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/virtual-data-center" delete: tags: - CloudInfrastructure @@ -10979,6 +14181,7 @@ paths: description: Unique ID of the vdc required: true type: string + example: __VDC-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -10998,7 +14201,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/virtual-data-centers" + $ref: "#/getDefinitions/virtual-data-centers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: @@ -11022,9 +14225,10 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-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/v9/BusinessConnectorsConnector.json) required: true schema: $ref: "#/definitions/relationship" @@ -11049,6 +14253,7 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}: get: tags: @@ -11063,7 +14268,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: @@ -11072,10 +14277,12 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ - name: metaname in: path required: true type: string + example: __METANAME__ - name: persona-model-id in: query description: the ASDC model id for this resource or service model. @@ -11100,7 +14307,10 @@ paths: tags: - Business 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: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum consumes: - application/json @@ -11117,16 +14327,62 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-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/v9/BusinessConnectorsConnectorMetadataMetadatum.json) required: true schema: $ref: "#/definitions/metadatum" + patch: + tags: + - Business + 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 + 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 + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" delete: tags: - Business @@ -11148,10 +14404,12 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ - name: metaname in: path required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency @@ -11171,7 +14429,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: @@ -11180,6 +14438,7 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ - name: persona-model-id in: query description: the ASDC model id for this resource or service model. @@ -11214,7 +14473,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/connector" + $ref: "#/getDefinitions/connector" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11223,6 +14482,7 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ - name: persona-model-id in: query description: the ASDC model id for this resource or service model. @@ -11247,7 +14507,10 @@ paths: tags: - Business summary: create or update an existing connector - description: 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 @@ -11264,12 +14527,52 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ - name: body in: body - description: connector object that needs to be created or updated + description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: Unique id of resource instance. + required: true + type: string + example: __RESOURCE-INSTANCE-ID__ + - name: body + in: body + description: connector object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/connector" delete: tags: - Business @@ -11291,6 +14594,7 @@ paths: description: Unique id of resource instance. required: true type: string + example: __RESOURCE-INSTANCE-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -11310,7 +14614,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/connectors" + $ref: "#/getDefinitions/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: @@ -11334,19 +14638,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 + 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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) required: true schema: $ref: "#/definitions/relationship" @@ -11371,16 +14678,19 @@ 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__ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}: get: tags: @@ -11395,7 +14705,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: @@ -11404,20 +14714,24 @@ 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: metaname in: path required: true type: string + example: __METANAME__ - name: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -11467,7 +14781,10 @@ paths: tags: - Business 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: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum consumes: - application/json @@ -11484,26 +14801,86 @@ 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: 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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) required: true schema: $ref: "#/definitions/metadatum" + patch: + tags: + - Business + 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 + 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: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" delete: tags: - Business @@ -11525,20 +14902,24 @@ 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: metaname in: path required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency @@ -11558,7 +14939,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: @@ -11567,16 +14948,19 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -11643,29 +15027,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 + 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: 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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) required: true schema: $ref: "#/definitions/relationship" @@ -11690,26 +15079,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: 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__ /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: @@ -11724,7 +15118,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/tunnel-xconnect" + $ref: "#/getDefinitions/tunnel-xconnect" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11733,26 +15127,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: 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -11812,7 +15211,10 @@ paths: tags: - Business summary: create or update an existing tunnel-xconnect - description: 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 @@ -11829,32 +15231,100 @@ 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: tunnel-xconnect object that needs to be created or updated + description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) required: true schema: $ref: "#/definitions/tunnel-xconnect" + patch: + tags: + - Business + 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 + 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: id + in: path + description: Allotted Resource id UUID assigned to this instance. + required: true + type: string + example: __ID__ + - name: body + in: body + description: tunnel-xconnect object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/tunnel-xconnect" delete: tags: - Business @@ -11876,26 +15346,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: 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 @@ -11915,7 +15390,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/tunnel-xconnects" + $ref: "#/getDefinitions/tunnel-xconnects" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -11924,21 +15399,25 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12015,24 +15494,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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) required: true schema: $ref: "#/definitions/relationship" @@ -12057,21 +15540,25 @@ 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__ /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: @@ -12086,7 +15573,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/allotted-resource" + $ref: "#/getDefinitions/allotted-resource" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12095,21 +15582,25 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12169,7 +15660,10 @@ paths: tags: - Business summary: create or update an existing allotted-resource - description: 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 @@ -12186,27 +15680,88 @@ 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: allotted-resource 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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) required: true schema: $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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/allotted-resource" delete: tags: - Business @@ -12228,21 +15783,25 @@ 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 @@ -12262,7 +15821,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/allotted-resources" + $ref: "#/getDefinitions/allotted-resources" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12271,16 +15830,19 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12340,7 +15902,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-instance" + $ref: "#/getDefinitions/service-instance" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12349,16 +15911,19 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12408,7 +15973,10 @@ paths: tags: - Business summary: create or update an existing service-instance - description: 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 @@ -12425,22 +15993,76 @@ 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: service-instance object that needs to be created or updated + description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) required: true schema: $ref: "#/definitions/service-instance" + patch: + tags: + - Business + 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 + 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: body + in: body + description: service-instance object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-instance" delete: tags: - Business @@ -12462,16 +16084,19 @@ 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 @@ -12491,7 +16116,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-instances" + $ref: "#/getDefinitions/service-instances" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12500,11 +16125,13 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12536,14 +16163,16 @@ 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: 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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) required: true schema: $ref: "#/definitions/relationship" @@ -12568,11 +16197,13 @@ 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__ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}: get: tags: @@ -12587,7 +16218,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-subscription" + $ref: "#/getDefinitions/service-subscription" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12596,11 +16227,13 @@ 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: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12615,7 +16248,10 @@ paths: tags: - Business summary: create or update an existing service-subscription - description: 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 @@ -12632,17 +16268,64 @@ 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: body in: body - description: service-subscription object that needs to be created or updated + description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) required: true schema: $ref: "#/definitions/service-subscription" + patch: + tags: + - 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 + 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: body + in: body + description: service-subscription object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-subscription" delete: tags: - Business @@ -12664,11 +16347,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -12688,7 +16373,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-subscriptions" + $ref: "#/getDefinitions/service-subscriptions" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12697,6 +16382,7 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12728,9 +16414,10 @@ paths: 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/v9/BusinessCustomersCustomer.json) required: true schema: $ref: "#/definitions/relationship" @@ -12755,6 +16442,7 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ /business/customers/customer/{global-customer-id}: get: tags: @@ -12769,7 +16457,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/customer" + $ref: "#/getDefinitions/customer" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12778,6 +16466,7 @@ paths: description: Global customer id used across ECOMP to uniquely identify customer. required: true type: string + example: __GLOBAL-CUSTOMER-ID__ - name: subscriber-name in: query description: Subscriber name, an alternate way to retrieve a customer. @@ -12792,7 +16481,10 @@ paths: tags: - Business summary: create or update an existing customer - description: 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 @@ -12809,12 +16501,52 @@ paths: 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 created or updated + description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json) required: true schema: $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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/customer" delete: tags: - Business @@ -12836,6 +16568,7 @@ paths: 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 @@ -12855,7 +16588,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/customers" + $ref: "#/getDefinitions/customers" "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: @@ -12879,9 +16612,10 @@ paths: 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/v9/ServiceDesignAndCreationVnfImagesVnfImage.json) required: true schema: $ref: "#/definitions/relationship" @@ -12906,6 +16640,7 @@ paths: description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: get: tags: @@ -12920,7 +16655,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnf-image" + $ref: "#/getDefinitions/vnf-image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -12929,6 +16664,7 @@ paths: description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ - name: application in: query description: The application that the image instantiates. @@ -12948,7 +16684,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing vnf-image - description: 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 @@ -12965,12 +16704,52 @@ paths: description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ - name: body in: body - description: vnf-image object that needs to be created or updated + description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json) required: true 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: vnf-image object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vnf-image" delete: tags: - ServiceDesignAndCreation @@ -12992,6 +16771,7 @@ paths: description: Unique ID of this asset required: true type: string + example: __VNF-IMAGE-UUID__ - name: resource-version in: query description: resource-version for concurrency @@ -13011,7 +16791,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnf-images" + $ref: "#/getDefinitions/vnf-images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: @@ -13035,9 +16815,10 @@ paths: 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: 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/v9/ServiceDesignAndCreationServicesService.json) required: true schema: $ref: "#/definitions/relationship" @@ -13062,6 +16843,7 @@ paths: 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__ /service-design-and-creation/services/service/{service-id}: get: tags: @@ -13076,7 +16858,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service" + $ref: "#/getDefinitions/service" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13085,6 +16867,7 @@ paths: 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: service-description in: query description: Description of the service @@ -13094,7 +16877,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing service - description: 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 @@ -13111,12 +16897,52 @@ paths: 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: service object that needs to be created or updated + description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json) required: true 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: service object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service" delete: tags: - ServiceDesignAndCreation @@ -13138,6 +16964,7 @@ paths: 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 @@ -13157,7 +16984,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/services" + $ref: "#/getDefinitions/services" "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: @@ -13181,14 +17008,16 @@ paths: 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-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 + 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/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) required: true schema: $ref: "#/definitions/relationship" @@ -13213,11 +17042,13 @@ paths: 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-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 + example: __VNF-TYPE__ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}: get: tags: @@ -13232,7 +17063,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-capability" + $ref: "#/getDefinitions/service-capability" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13241,16 +17072,21 @@ paths: 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-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 + example: __VNF-TYPE__ put: tags: - ServiceDesignAndCreation summary: create or update an existing service-capability - description: 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 @@ -13267,17 +17103,64 @@ paths: 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-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 + example: __VNF-TYPE__ - name: body in: body - description: service-capability object that needs to be created or updated + description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) required: true schema: $ref: "#/definitions/service-capability" + patch: + tags: + - ServiceDesignAndCreation + 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 + 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 + 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 + example: __VNF-TYPE__ + - name: body + in: body + description: service-capability object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/service-capability" delete: tags: - ServiceDesignAndCreation @@ -13299,11 +17182,13 @@ paths: 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-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 + example: __VNF-TYPE__ - name: resource-version in: query description: resource-version for concurrency @@ -13323,7 +17208,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/service-capabilities" + $ref: "#/getDefinitions/service-capabilities" "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: @@ -13347,30 +17232,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/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) required: true schema: $ref: "#/definitions/relationship" @@ -13395,27 +17286,33 @@ 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__ /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: @@ -13430,7 +17327,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/element-choice-set" + $ref: "#/getDefinitions/element-choice-set" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13439,27 +17336,33 @@ 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: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -13479,7 +17382,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing element-choice-set - description: 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 @@ -13496,33 +17402,104 @@ 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: element-choice-set 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/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) required: true schema: $ref: "#/definitions/element-choice-set" + patch: + tags: + - ServiceDesignAndCreation + 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 + 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 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: element-choice-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/element-choice-set" delete: tags: - ServiceDesignAndCreation @@ -13544,27 +17521,33 @@ 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: resource-version in: query description: resource-version for concurrency @@ -13584,7 +17567,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/element-choice-sets" + $ref: "#/getDefinitions/element-choice-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13593,23 +17576,28 @@ 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: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -13646,26 +17634,31 @@ 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: 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/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) required: true schema: $ref: "#/definitions/relationship" @@ -13690,23 +17683,28 @@ 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__ /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: @@ -13721,7 +17719,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/constrained-element-set" + $ref: "#/getDefinitions/constrained-element-set" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13730,23 +17728,28 @@ 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: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -13766,7 +17769,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing constrained-element-set - description: 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 @@ -13783,29 +17789,94 @@ 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: body in: body - description: constrained-element-set object that needs to be created or updated + description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) required: true schema: $ref: "#/definitions/constrained-element-set" + patch: + tags: + - ServiceDesignAndCreation + 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 + 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 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: body + in: body + description: constrained-element-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/constrained-element-set" delete: tags: - ServiceDesignAndCreation @@ -13827,23 +17898,28 @@ 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: resource-version in: query description: resource-version for concurrency @@ -13863,7 +17939,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/constrained-element-sets" + $ref: "#/getDefinitions/constrained-element-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13872,19 +17948,23 @@ 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: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -13914,7 +17994,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-constraint" + $ref: "#/getDefinitions/model-constraint" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -13923,19 +18003,23 @@ 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: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -13955,7 +18039,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing model-constraint - description: 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 @@ -13972,31 +18059,46 @@ 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: body in: body - description: model-constraint object that needs to be created or updated + description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) required: true schema: $ref: "#/definitions/model-constraint" - delete: + patch: tags: - ServiceDesignAndCreation - summary: delete an existing model-constraint - description: delete an existing model-constraint - operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint + 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 @@ -14012,77 +18114,35 @@ 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 - - name: resource-version - in: query - description: resource-version for concurrency + example: __MODEL-CONSTRAINT-UUID__ + - name: body + in: body + description: model-constraint object that needs to be created or updated. 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: - get: - tags: - - ServiceDesignAndCreation - summary: returns model-constraints - description: returns model-constraints - operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation schema: - $ref: "#/definitions/model-constraints" - "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 - 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}/relationship-list/relationship: - put: + $ref: "#/patchDefinitions/model-constraint" + delete: tags: - ServiceDesignAndCreation - summary: see node definition for valid relationships - operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + summary: delete an existing model-constraint + description: delete an existing model-constraint + operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint consumes: - application/json - application/xml @@ -14098,18 +18158,114 @@ 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: 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: + get: + tags: + - ServiceDesignAndCreation + summary: returns model-constraints + description: returns model-constraints + operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/model-constraints" + "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 + 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-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}/relationship-list/relationship: + put: + tags: + - ServiceDesignAndCreation + summary: see node definition for valid relationships + operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship + 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 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/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) required: true schema: $ref: "#/definitions/relationship" @@ -14134,15 +18290,18 @@ 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__ /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: @@ -14157,7 +18316,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-element" + $ref: "#/getDefinitions/model-element" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14166,15 +18325,18 @@ 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-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14194,7 +18356,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing model-element - description: 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 @@ -14211,21 +18376,74 @@ 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: body in: body - description: model-element 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/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) required: true schema: $ref: "#/definitions/model-element" + patch: + tags: + - ServiceDesignAndCreation + 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 + 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 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: model-element object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-element" delete: tags: - ServiceDesignAndCreation @@ -14247,15 +18465,18 @@ 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: resource-version in: query description: resource-version for concurrency @@ -14275,7 +18496,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-elements" + $ref: "#/getDefinitions/model-elements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14284,11 +18505,13 @@ 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-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14318,7 +18541,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: @@ -14327,15 +18550,18 @@ 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: metaname in: path required: true type: string + example: __METANAME__ - name: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14355,7 +18581,10 @@ paths: tags: - ServiceDesignAndCreation 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: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum consumes: - application/json @@ -14372,21 +18601,74 @@ 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: 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/v9/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json) required: true schema: $ref: "#/definitions/metadatum" + patch: + tags: + - 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 + 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 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: metaname + in: path + required: true + type: string + example: __METANAME__ + - name: body + in: body + description: metadatum object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/metadatum" delete: tags: - ServiceDesignAndCreation @@ -14408,15 +18690,18 @@ 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: metaname in: path required: true type: string + example: __METANAME__ - name: resource-version in: query description: resource-version for concurrency @@ -14436,7 +18721,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: @@ -14445,11 +18730,13 @@ 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-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14486,14 +18773,16 @@ 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: 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/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json) required: true schema: $ref: "#/definitions/relationship" @@ -14518,11 +18807,13 @@ 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__ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}: get: tags: @@ -14537,7 +18828,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-ver" + $ref: "#/getDefinitions/model-ver" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14546,11 +18837,13 @@ 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-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14570,7 +18863,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing model-ver - description: 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 @@ -14587,17 +18883,64 @@ 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: body in: body - description: model-ver object that needs to be created or updated + description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 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: model-ver object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model-ver" delete: tags: - ServiceDesignAndCreation @@ -14619,11 +18962,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -14643,7 +18988,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model-vers" + $ref: "#/getDefinitions/model-vers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14652,6 +18997,7 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ - name: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14678,9 +19024,10 @@ paths: 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/v9/ServiceDesignAndCreationModelsModel.json) required: true schema: $ref: "#/definitions/relationship" @@ -14705,6 +19052,7 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ /service-design-and-creation/models/model/{model-invariant-id}: get: tags: @@ -14719,7 +19067,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/model" + $ref: "#/getDefinitions/model" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14728,6 +19076,7 @@ paths: description: Unique identifier corresponding to the main definition of a model in ASDC required: true type: string + example: __MODEL-INVARIANT-ID__ - name: model-type in: query description: Type of the model, e.g., service, resource, widget, etc. @@ -14737,7 +19086,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing model - description: 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 @@ -14754,12 +19106,52 @@ paths: 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: model object that needs to be created or updated + description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 identifier corresponding to the main definition of a model in ASDC + required: true + type: string + example: __MODEL-INVARIANT-ID__ + - name: body + in: body + description: model object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/model" delete: tags: - ServiceDesignAndCreation @@ -14781,6 +19173,7 @@ paths: 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 @@ -14800,7 +19193,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/models" + $ref: "#/getDefinitions/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: @@ -14823,17 +19216,20 @@ paths: 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 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/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) required: true schema: $ref: "#/definitions/relationship" @@ -14857,14 +19253,17 @@ paths: 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 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: @@ -14879,7 +19278,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/related-lookup" + $ref: "#/getDefinitions/related-lookup" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14887,14 +19286,17 @@ paths: 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 required: true type: string + example: __RELATED-LOOKUP-UUID__ - name: named-query-name in: query required: false @@ -14903,7 +19305,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing related-lookup - description: 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 @@ -14919,20 +19324,71 @@ paths: 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 required: true type: string + example: __RELATED-LOOKUP-UUID__ - name: body in: body - description: related-lookup 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/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) required: true schema: $ref: "#/definitions/related-lookup" + patch: + tags: + - 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 + 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: 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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/related-lookup" delete: tags: - ServiceDesignAndCreation @@ -14953,14 +19409,17 @@ paths: 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 required: true type: string + example: __RELATED-LOOKUP-UUID__ - name: resource-version in: query description: resource-version for concurrency @@ -14980,7 +19439,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/related-lookups" + $ref: "#/getDefinitions/related-lookups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -14988,10 +19447,12 @@ paths: 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: named-query-name in: query required: false @@ -15010,7 +19471,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/property-constraint" + $ref: "#/getDefinitions/property-constraint" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15018,14 +19479,17 @@ paths: 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: property-constraint-uuid in: path required: true type: string + example: __PROPERTY-CONSTRAINT-UUID__ - name: named-query-name in: query required: false @@ -15034,7 +19498,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing property-constraint - description: 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 @@ -15050,20 +19517,71 @@ paths: 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: 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 + description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json) required: true schema: $ref: "#/definitions/property-constraint" + patch: + tags: + - 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/property-constraint" delete: tags: - ServiceDesignAndCreation @@ -15084,14 +19602,17 @@ paths: 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: property-constraint-uuid in: path required: true type: string + example: __PROPERTY-CONSTRAINT-UUID__ - name: resource-version in: query description: resource-version for concurrency @@ -15111,7 +19632,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/property-constraints" + $ref: "#/getDefinitions/property-constraints" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15119,10 +19640,12 @@ paths: 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: named-query-name in: query required: false @@ -15147,13 +19670,15 @@ paths: 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: 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/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) required: true schema: $ref: "#/definitions/relationship" @@ -15177,10 +19702,12 @@ paths: 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__ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}: get: tags: @@ -15195,7 +19722,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/named-query-element" + $ref: "#/getDefinitions/named-query-element" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15203,10 +19730,12 @@ paths: 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: named-query-name in: query required: false @@ -15215,7 +19744,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing named-query-element - description: 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 @@ -15231,16 +19763,61 @@ paths: 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 created or updated + description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) required: true schema: $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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query-element" delete: tags: - ServiceDesignAndCreation @@ -15261,10 +19838,12 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -15284,7 +19863,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/named-query-elements" + $ref: "#/getDefinitions/named-query-elements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15292,6 +19871,7 @@ paths: in: path required: true type: string + example: __NAMED-QUERY-UUID__ - name: named-query-name in: query required: false @@ -15316,9 +19896,10 @@ paths: 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/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json) required: true schema: $ref: "#/definitions/relationship" @@ -15342,6 +19923,7 @@ paths: in: path required: true type: string + example: __NAMED-QUERY-UUID__ /service-design-and-creation/named-queries/named-query/{named-query-uuid}: get: tags: @@ -15356,7 +19938,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/named-query" + $ref: "#/getDefinitions/named-query" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15364,6 +19946,7 @@ paths: in: path required: true type: string + example: __NAMED-QUERY-UUID__ - name: named-query-name in: query required: false @@ -15372,7 +19955,10 @@ paths: tags: - ServiceDesignAndCreation summary: create or update an existing named-query - description: 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 @@ -15388,12 +19974,51 @@ paths: in: path required: true type: string + example: __NAMED-QUERY-UUID__ - name: body in: body - description: named-query object that needs to be created or updated + description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json) required: true schema: $ref: "#/definitions/named-query" + patch: + tags: + - 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 + 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: body + in: body + description: named-query object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/named-query" delete: tags: - ServiceDesignAndCreation @@ -15414,6 +20039,7 @@ paths: in: path required: true type: string + example: __NAMED-QUERY-UUID__ - name: resource-version in: query description: resource-version for concurrency @@ -15433,7 +20059,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/named-queries" + $ref: "#/getDefinitions/named-queries" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/logical-links/logical-link/{link-name}/relationship-list/relationship: @@ -15457,9 +20083,10 @@ paths: 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json) required: true schema: $ref: "#/definitions/relationship" @@ -15484,6 +20111,7 @@ paths: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string + example: __LINK-NAME__ /network/logical-links/logical-link/{link-name}: get: tags: @@ -15498,7 +20126,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/logical-link" + $ref: "#/getDefinitions/logical-link" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15507,6 +20135,7 @@ paths: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string + example: __LINK-NAME__ - name: persona-model-id in: query description: the ASDC model id for this resource or service model. @@ -15551,7 +20180,10 @@ paths: tags: - Network summary: create or update an existing logical-link - description: 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 @@ -15568,12 +20200,52 @@ paths: 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: logical-link 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/v9/NetworkLogicalLinksLogicalLink.json) required: true schema: $ref: "#/definitions/logical-link" + patch: + tags: + - Network + 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 + 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., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: logical-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/logical-link" delete: tags: - Network @@ -15595,6 +20267,7 @@ paths: description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true type: string + example: __LINK-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -15614,7 +20287,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/logical-links" + $ref: "#/getDefinitions/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: @@ -15638,24 +20311,28 @@ paths: 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) required: true schema: $ref: "#/definitions/relationship" @@ -15680,21 +20357,25 @@ paths: 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__ /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: @@ -15709,7 +20390,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/class-of-service" + $ref: "#/getDefinitions/class-of-service" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15718,26 +20399,33 @@ paths: 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__ put: tags: - Network summary: create or update an existing class-of-service - description: 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 @@ -15754,27 +20442,88 @@ paths: 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: class-of-service object that needs to be created or updated + description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: 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: class-of-service object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/class-of-service" delete: tags: - Network @@ -15796,21 +20545,25 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -15830,7 +20583,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/classes-of-service" + $ref: "#/getDefinitions/classes-of-service" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15839,16 +20592,19 @@ paths: 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__ /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: @@ -15870,19 +20626,22 @@ paths: 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: 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/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) required: true schema: $ref: "#/definitions/relationship" @@ -15907,16 +20666,19 @@ paths: 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__ /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: @@ -15931,7 +20693,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/site-pair" + $ref: "#/getDefinitions/site-pair" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -15940,21 +20702,27 @@ paths: 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__ put: tags: - Network summary: create or update an existing site-pair - description: 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 @@ -15971,22 +20739,76 @@ paths: 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: body in: body - description: site-pair object that needs to be created or updated + description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) required: true schema: $ref: "#/definitions/site-pair" + patch: + tags: + - Network + 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 + 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 + 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: body + in: body + description: site-pair object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/site-pair" delete: tags: - Network @@ -16008,16 +20830,19 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -16037,7 +20862,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/site-pairs" + $ref: "#/getDefinitions/site-pairs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -16046,11 +20871,13 @@ paths: 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__ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship: put: tags: @@ -16072,14 +20899,16 @@ paths: 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: 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/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) required: true schema: $ref: "#/definitions/relationship" @@ -16104,11 +20933,13 @@ paths: 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__ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}: get: tags: @@ -16123,7 +20954,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/routing-instance" + $ref: "#/getDefinitions/routing-instance" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -16132,16 +20963,21 @@ paths: 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__ put: tags: - Network summary: create or update an existing routing-instance - description: 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 @@ -16158,17 +20994,64 @@ paths: 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: body in: body - description: routing-instance object that needs to be created or updated + description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: 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: body + in: body + description: routing-instance object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/routing-instance" delete: tags: - Network @@ -16190,11 +21073,13 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -16214,7 +21099,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/routing-instances" + $ref: "#/getDefinitions/routing-instances" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -16223,6 +21108,7 @@ paths: description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: put: tags: @@ -16244,9 +21130,10 @@ paths: 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/v9/NetworkSitePairSetsSitePairSet.json) required: true schema: $ref: "#/definitions/relationship" @@ -16271,6 +21158,7 @@ paths: description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ /network/site-pair-sets/site-pair-set/{site-pair-set-id}: get: tags: @@ -16285,7 +21173,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/site-pair-set" + $ref: "#/getDefinitions/site-pair-set" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -16294,11 +21182,15 @@ paths: description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ put: tags: - Network summary: create or update an existing site-pair-set - description: 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 @@ -16315,12 +21207,52 @@ paths: description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ - name: body in: body - description: site-pair-set object that needs to be created or updated + description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json) required: true 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: Unique id of site pair set. + required: true + type: string + example: __SITE-PAIR-SET-ID__ + - name: body + in: body + description: site-pair-set object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/site-pair-set" delete: tags: - Network @@ -16342,6 +21274,7 @@ paths: description: Unique id of site pair set. required: true type: string + example: __SITE-PAIR-SET-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -16361,7 +21294,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/site-pair-sets" + $ref: "#/getDefinitions/site-pair-sets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: @@ -16385,9 +21318,10 @@ paths: description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-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/v9/NetworkVpnBindingsVpnBinding.json) required: true schema: $ref: "#/definitions/relationship" @@ -16412,6 +21346,7 @@ paths: description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-ID__ /network/vpn-bindings/vpn-binding/{vpn-id}: get: tags: @@ -16426,7 +21361,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpn-binding" + $ref: "#/getDefinitions/vpn-binding" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -16435,6 +21370,7 @@ paths: description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-ID__ - name: vpn-name in: query description: VPN Name @@ -16454,7 +21390,10 @@ paths: tags: - Network summary: create or update an existing vpn-binding - description: 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 @@ -16471,12 +21410,52 @@ paths: description: VPN ID, globally unique within A&AI required: true type: string + example: __VPN-ID__ - name: body in: body - description: vpn-binding object that needs to be created or updated + description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json) required: true schema: $ref: "#/definitions/vpn-binding" + patch: + tags: + - Network + 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 + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: vpn-id + in: path + description: VPN ID, globally unique within A&AI + required: true + type: string + example: __VPN-ID__ + - name: body + in: body + description: vpn-binding object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vpn-binding" delete: tags: - Network @@ -16498,6 +21477,7 @@ paths: 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 @@ -16517,7 +21497,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpn-bindings" + $ref: "#/getDefinitions/vpn-bindings" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: @@ -16540,9 +21520,10 @@ paths: in: path 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/v9/NetworkVplsPesVplsPe.json) required: true schema: $ref: "#/definitions/relationship" @@ -16566,6 +21547,7 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: put: tags: @@ -16586,14 +21568,16 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -16617,11 +21601,13 @@ 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__ /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: @@ -16642,24 +21628,28 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -16683,21 +21673,25 @@ 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: vlan-interface in: path description: String that identifies the interface required: true type: string + 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: @@ -16718,29 +21712,34 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -16764,26 +21763,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: 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/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: @@ -16798,7 +21802,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: @@ -16806,26 +21810,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: 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -16882,7 +21891,10 @@ paths: tags: - Network 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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -16898,32 +21910,99 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -16944,26 +22023,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: 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 @@ -16989,29 +22073,34 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -17035,26 +22124,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: 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}/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: @@ -17069,7 +22163,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: @@ -17077,26 +22171,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: 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -17153,7 +22252,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -17169,32 +22271,99 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -17215,26 +22384,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: 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 @@ -17254,7 +22428,7 @@ 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: @@ -17262,21 +22436,25 @@ 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: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -17317,7 +22495,10 @@ paths: tags: - Network summary: create or update an existing vlan - description: 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 @@ -17333,33 +22514,48 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/vlan" - delete: + patch: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + 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 @@ -17374,21 +22570,70 @@ 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" + delete: + tags: + - Network + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + 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 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: resource-version in: query description: resource-version for concurrency @@ -17408,7 +22653,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: @@ -17416,16 +22661,19 @@ 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -17471,24 +22719,28 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -17512,21 +22764,25 @@ 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: 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: @@ -17541,7 +22797,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: @@ -17549,21 +22805,25 @@ 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: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -17613,7 +22873,10 @@ paths: tags: - Network summary: create or update an existing sriov-vf - description: 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 @@ -17629,27 +22892,87 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + 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 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: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network @@ -17670,21 +22993,25 @@ 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: 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 @@ -17704,7 +23031,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: @@ -17712,16 +23039,19 @@ 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -17767,19 +23097,22 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -17803,16 +23136,19 @@ 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__ /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: @@ -17833,24 +23169,28 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -17874,21 +23214,25 @@ 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: 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: get: tags: @@ -17903,7 +23247,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: @@ -17911,21 +23255,25 @@ 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: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -17971,7 +23319,10 @@ paths: tags: - Network 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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -17987,27 +23338,87 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 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: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -18028,21 +23439,25 @@ 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: 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 @@ -18068,24 +23483,28 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -18109,21 +23528,25 @@ 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: 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: @@ -18138,7 +23561,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: @@ -18146,21 +23569,25 @@ 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: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -18206,7 +23633,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -18222,27 +23652,87 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -18263,21 +23753,25 @@ 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: 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 @@ -18297,7 +23791,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: @@ -18305,16 +23799,19 @@ 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -18344,7 +23841,10 @@ paths: tags: - Network summary: create or update an existing l-interface - description: 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 @@ -18360,22 +23860,75 @@ 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: 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/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface + 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 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: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network @@ -18396,16 +23949,19 @@ 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 @@ -18425,7 +23981,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: @@ -18433,11 +23989,13 @@ 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -18462,7 +24020,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interface" + $ref: "#/getDefinitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -18470,11 +24028,13 @@ 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -18489,7 +24049,10 @@ paths: tags: - Network summary: create or update an existing p-interface - description: 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 @@ -18505,17 +24068,63 @@ 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: body in: body - description: p-interface object that needs to be created or updated + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json) required: true schema: $ref: "#/definitions/p-interface" + patch: + tags: + - Network + 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 + 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 that identifies the physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" delete: tags: - Network @@ -18536,11 +24145,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -18560,7 +24171,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interfaces" + $ref: "#/getDefinitions/p-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -18568,6 +24179,7 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -18593,14 +24205,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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -18624,11 +24238,13 @@ 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 + 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: @@ -18649,24 +24265,28 @@ 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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -18690,21 +24310,25 @@ 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 + 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/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: @@ -18725,29 +24349,34 @@ 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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -18771,26 +24400,31 @@ 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 + 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/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: @@ -18805,7 +24439,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: @@ -18813,26 +24447,31 @@ 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 + 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -18894,7 +24533,10 @@ paths: tags: - Network 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -18910,32 +24552,99 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -18956,26 +24665,31 @@ 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 + 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 @@ -19001,29 +24715,34 @@ 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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -19047,26 +24766,31 @@ 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 + 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/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: @@ -19081,7 +24805,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: @@ -19089,26 +24813,31 @@ 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 + 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -19170,7 +24899,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -19186,38 +24918,54 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + 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-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 @@ -19232,46 +24980,50 @@ 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 + 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: 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 created or 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-ipv6-address-list" + delete: tags: - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + 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 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: @@ -19279,21 +25031,77 @@ 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 + 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/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 vlan + description: returns vlan + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + 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: 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: vlan-interface + in: path + description: String that identifies the interface + required: true + type: string + example: __VLAN-INTERFACE__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -19339,7 +25147,10 @@ paths: tags: - Network summary: create or update an existing vlan - description: 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 @@ -19355,27 +25166,87 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - Network @@ -19396,21 +25267,25 @@ 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 + 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 @@ -19430,7 +25305,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: @@ -19438,16 +25313,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 + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -19498,24 +25376,28 @@ 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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -19539,21 +25421,25 @@ 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 + 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/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: @@ -19568,7 +25454,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: @@ -19576,21 +25462,25 @@ 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 + 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -19645,7 +25535,10 @@ paths: tags: - Network summary: create or update an existing sriov-vf - description: 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 @@ -19661,27 +25554,87 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network @@ -19702,21 +25655,25 @@ 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 + 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 @@ -19736,7 +25693,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: @@ -19744,16 +25701,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 + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -19804,19 +25764,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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -19840,16 +25803,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 + 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: @@ -19870,24 +25836,28 @@ 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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -19911,21 +25881,25 @@ 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 + 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: @@ -19940,7 +25914,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: @@ -19948,21 +25922,25 @@ 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 + 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -20013,7 +25991,10 @@ paths: tags: - Network 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: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -20029,27 +26010,87 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -20070,21 +26111,25 @@ 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 + 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 @@ -20110,24 +26155,28 @@ 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 + 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -20151,21 +26200,25 @@ 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 + 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: @@ -20180,7 +26233,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: @@ -20188,21 +26241,25 @@ 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 + 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: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -20253,7 +26310,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -20269,33 +26329,48 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + 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-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 @@ -20310,130 +26385,37 @@ 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 + 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: 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}: - get: - tags: - - Network - summary: returns l-interface - description: returns l-interface - operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface - 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: equipment-name - in: path - 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: 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 - put: - tags: - - Network - summary: create or update an existing l-interface - description: create or update an existing l-interface - 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: 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 + 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 created or 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: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + 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 @@ -20448,16 +26430,220 @@ 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 + 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/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: + get: + tags: + - Network + summary: returns l-interface + description: returns l-interface + operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + 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: 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: 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 + 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 + 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: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" + delete: + tags: + - Network + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface + 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 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 @@ -20477,7 +26663,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: @@ -20485,11 +26671,13 @@ 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 + example: __INTERFACE-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -20519,7 +26707,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interface" + $ref: "#/getDefinitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20527,11 +26715,13 @@ 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 + example: __INTERFACE-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -20551,7 +26741,10 @@ paths: tags: - Network summary: create or update an existing lag-interface - description: 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 @@ -20567,17 +26760,63 @@ 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 + example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface 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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" delete: tags: - Network @@ -20598,11 +26837,13 @@ 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 + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -20622,7 +26863,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/getDefinitions/lag-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20630,6 +26871,7 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -20649,7 +26891,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpls-pe" + $ref: "#/getDefinitions/vpls-pe" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20657,6 +26899,7 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: prov-status in: query description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. @@ -20666,7 +26909,10 @@ paths: tags: - Network summary: create or update an existing vpls-pe - description: 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 @@ -20682,12 +26928,51 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: body in: body - description: vpls-pe object that needs to be created or updated + description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json) required: true schema: $ref: "#/definitions/vpls-pe" + patch: + tags: + - Network + 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 + 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: body + in: body + description: vpls-pe object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vpls-pe" delete: tags: - Network @@ -20708,6 +26993,7 @@ paths: in: path required: true type: string + example: __EQUIPMENT-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -20727,7 +27013,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vpls-pes" + $ref: "#/getDefinitions/vpls-pes" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: @@ -20751,9 +27037,10 @@ paths: 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/v9/NetworkMulticastConfigurationsMulticastConfiguration.json) required: true schema: $ref: "#/definitions/relationship" @@ -20778,6 +27065,7 @@ paths: description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}: get: tags: @@ -20792,7 +27080,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/multicast-configuration" + $ref: "#/getDefinitions/multicast-configuration" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20801,11 +27089,15 @@ paths: description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ put: tags: - Network summary: create or update an existing multicast-configuration - description: 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 @@ -20822,12 +27114,52 @@ paths: description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ - name: body in: body - description: multicast-configuration object that needs to be created or updated + description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json) required: true schema: $ref: "#/definitions/multicast-configuration" + patch: + tags: + - Network + 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 + produces: + - application/json + - application/xml + responses: + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: multicast-configuration-id + in: path + description: Unique id of multicast configuration. + required: true + type: string + example: __MULTICAST-CONFIGURATION-ID__ + - name: body + in: body + description: multicast-configuration object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/multicast-configuration" delete: tags: - Network @@ -20849,6 +27181,7 @@ paths: description: Unique id of multicast configuration. required: true type: string + example: __MULTICAST-CONFIGURATION-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -20868,7 +27201,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/multicast-configurations" + $ref: "#/getDefinitions/multicast-configurations" "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: @@ -20892,20 +27225,23 @@ paths: 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: 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/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) required: true schema: $ref: "#/definitions/relationship" @@ -20930,17 +27266,20 @@ paths: 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__ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}: get: tags: @@ -20955,7 +27294,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/cvlan-tag-entry" + $ref: "#/getDefinitions/cvlan-tag-entry" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -20964,17 +27303,20 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -21034,7 +27376,10 @@ paths: tags: - Network summary: create or update an existing cvlan-tag-entry - description: 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 @@ -21051,23 +27396,78 @@ paths: 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: cvlan-tag-entry object that needs to be created or updated + description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) required: true schema: $ref: "#/definitions/cvlan-tag-entry" + patch: + tags: + - Network + 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 + 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-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. + required: true + schema: + $ref: "#/patchDefinitions/cvlan-tag-entry" delete: tags: - Network @@ -21089,17 +27489,20 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -21119,7 +27522,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/cvlan-tags" + $ref: "#/getDefinitions/cvlan-tags" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21128,11 +27531,13 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -21209,14 +27614,16 @@ paths: 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: 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/v9/NetworkVcesVcePortGroupsPortGroup.json) required: true schema: $ref: "#/definitions/relationship" @@ -21241,11 +27648,13 @@ paths: 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__ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}: get: tags: @@ -21260,7 +27669,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/port-group" + $ref: "#/getDefinitions/port-group" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21269,11 +27678,13 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -21333,7 +27744,10 @@ paths: tags: - Network summary: create or update an existing port-group - description: 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 @@ -21350,17 +27764,64 @@ paths: 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: body in: body - description: port-group object that needs to be created or updated + description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: 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: body + in: body + description: port-group object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/port-group" delete: tags: - Network @@ -21382,11 +27843,13 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -21406,7 +27869,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/port-groups" + $ref: "#/getDefinitions/port-groups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21415,6 +27878,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -21476,19 +27940,22 @@ paths: 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json) required: true schema: $ref: "#/definitions/relationship" @@ -21513,16 +27980,19 @@ paths: 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__ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: get: tags: @@ -21537,7 +28007,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/license" + $ref: "#/getDefinitions/license" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21546,16 +28016,19 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -21600,7 +28073,10 @@ paths: tags: - Network summary: create or update an existing license - description: 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 @@ -21617,22 +28093,76 @@ paths: 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: license object that needs to be created or updated + description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.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: UpdateNetworkVcesVceLicensesLicense + 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: 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: license object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/license" delete: tags: - Network @@ -21654,16 +28184,19 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -21683,7 +28216,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/licenses" + $ref: "#/getDefinitions/licenses" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21692,6 +28225,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -21753,19 +28287,22 @@ paths: 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 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: 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/v9/NetworkVcesVceEntitlementsEntitlement.json) required: true schema: $ref: "#/definitions/relationship" @@ -21790,16 +28327,19 @@ paths: 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 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__ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: get: tags: @@ -21814,7 +28354,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlement" + $ref: "#/getDefinitions/entitlement" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21823,16 +28363,19 @@ paths: 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 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: vnf-name in: query description: Name of VNF. @@ -21877,7 +28420,10 @@ paths: tags: - Network summary: create or update an existing entitlement - description: 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 @@ -21894,22 +28440,76 @@ paths: 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 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: entitlement 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/v9/NetworkVcesVceEntitlementsEntitlement.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: UpdateNetworkVcesVceEntitlementsEntitlement + 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: group-uuid + in: path + 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: entitlement object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" delete: tags: - Network @@ -21931,16 +28531,19 @@ paths: 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 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: resource-version in: query description: resource-version for concurrency @@ -21960,7 +28563,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlements" + $ref: "#/getDefinitions/entitlements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -21969,6 +28572,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -22030,9 +28634,10 @@ paths: 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/v9/NetworkVcesVce.json) required: true schema: $ref: "#/definitions/relationship" @@ -22057,6 +28662,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ /network/vces/vce/{vnf-id}: get: tags: @@ -22071,7 +28677,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vce" + $ref: "#/getDefinitions/vce" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -22080,6 +28686,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -22124,7 +28731,10 @@ paths: tags: - Network summary: create or update an existing vce - description: 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 @@ -22141,12 +28751,52 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: body in: body - description: vce 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/v9/NetworkVcesVce.json) required: true schema: $ref: "#/definitions/vce" + patch: + tags: + - Network + 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 + 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: vce object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vce" delete: tags: - Network @@ -22168,6 +28818,7 @@ paths: 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 @@ -22187,7 +28838,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vces" + $ref: "#/getDefinitions/vces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: @@ -22211,9 +28862,10 @@ paths: 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/v9/NetworkVnfcsVnfc.json) required: true schema: $ref: "#/definitions/relationship" @@ -22238,6 +28890,7 @@ paths: description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ /network/vnfcs/vnfc/{vnfc-name}: get: tags: @@ -22252,7 +28905,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnfc" + $ref: "#/getDefinitions/vnfc" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -22261,6 +28914,7 @@ paths: description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: vnfc-function-code in: query description: function code @@ -22298,7 +28952,10 @@ paths: tags: - Network summary: create or update an existing vnfc - description: 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 @@ -22315,12 +28972,52 @@ paths: description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: body in: body - description: vnfc object that needs to be created or updated + description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: Unique ID of vnfc. + required: true + type: string + example: __VNFC-NAME__ + - name: body + in: body + description: vnfc object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vnfc" delete: tags: - Network @@ -22342,6 +29039,7 @@ paths: description: Unique ID of vnfc. required: true type: string + example: __VNFC-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -22361,7 +29059,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vnfcs" + $ref: "#/getDefinitions/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: @@ -22385,14 +29083,16 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: subnet-id in: path 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json) required: true schema: $ref: "#/definitions/relationship" @@ -22417,11 +29117,13 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: subnet-id in: path description: Subnet ID, should be UUID. required: true type: string + example: __SUBNET-ID__ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}: get: tags: @@ -22436,7 +29138,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/subnet" + $ref: "#/getDefinitions/subnet" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -22445,11 +29147,13 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: subnet-id in: path description: Subnet ID, should be UUID. required: true type: string + example: __SUBNET-ID__ - name: network-name in: query description: Name of the network, governed by some naming convention.. @@ -22504,7 +29208,10 @@ paths: tags: - Network summary: create or update an existing subnet - description: 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 @@ -22521,23 +29228,36 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: subnet-id in: path description: Subnet ID, should be UUID. required: true type: string + example: __SUBNET-ID__ - name: body in: body - description: subnet object that needs to be created or updated + description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json) required: true schema: $ref: "#/definitions/subnet" - delete: + patch: tags: - Network - summary: delete an existing subnet - description: delete an existing subnet - operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet + 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 @@ -22553,123 +29273,25 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: subnet-id in: path description: Subnet ID, should be UUID. required: true type: string - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/l3-networks/l3-network/{network-id}/subnets: - get: - tags: - - Network - summary: returns subnets - description: returns subnets - operationId: getNetworkL3NetworksL3NetworkSubnets - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/subnets" - "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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - 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 - /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 - - name: vlan-id-inner - in: path - description: id. - required: true - type: integer - format: int64 + example: __SUBNET-ID__ - name: body in: body - description: relationship object that needs to be created or updated + description: subnet object that needs to be created or updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/subnet" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + summary: delete an existing subnet + description: delete an existing subnet + operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet consumes: - application/json - application/xml @@ -22685,19 +29307,25 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner + example: __NETWORK-ID__ + - name: subnet-id in: path - description: id. + description: Subnet ID, should be UUID. required: true - type: integer - format: int64 - /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}: + type: string + example: __SUBNET-ID__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/l3-networks/l3-network/{network-id}/subnets: get: tags: - Network - summary: returns ctag-assignment - description: returns ctag-assignment - operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment + summary: returns subnets + description: returns subnets + operationId: getNetworkL3NetworksL3NetworkSubnets produces: - application/json - application/xml @@ -22705,7 +29333,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ctag-assignment" + $ref: "#/getDefinitions/subnets" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -22714,12 +29342,147 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string - - name: vlan-id-inner - in: path - description: id. - required: true - type: integer - format: int64 + example: __NETWORK-ID__ + - 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: persona-model-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: persona-model-version + 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 + /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: path + description: id. + required: true + type: integer + format: int64 + 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/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship + 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: path + description: id. + required: true + 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: 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: network-name in: query description: Name of the network, governed by some naming convention.. @@ -22769,7 +29532,10 @@ paths: tags: - Network summary: create or update an existing ctag-assignment - description: 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 @@ -22786,18 +29552,66 @@ paths: 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: ctag-assignment 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/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) required: true schema: $ref: "#/definitions/ctag-assignment" + patch: + tags: + - Network + 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 + 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: path + description: id. + required: true + type: integer + format: int64 + example: __VLAN-ID-INNER__ + - name: body + in: body + description: ctag-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ctag-assignment" delete: tags: - Network @@ -22819,12 +29633,14 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -22844,7 +29660,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ctag-assignments" + $ref: "#/getDefinitions/ctag-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -22853,6 +29669,7 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: network-name in: query description: Name of the network, governed by some naming convention.. @@ -22919,14 +29736,16 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: segmentation-id in: path 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) required: true schema: $ref: "#/definitions/relationship" @@ -22951,11 +29770,13 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __SEGMENTATION-ID__ /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}: get: tags: @@ -22970,7 +29791,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/segmentation-assignment" + $ref: "#/getDefinitions/segmentation-assignment" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -22979,11 +29800,13 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __SEGMENTATION-ID__ - name: network-name in: query description: Name of the network, governed by some naming convention.. @@ -23033,7 +29856,10 @@ paths: tags: - Network summary: create or update an existing segmentation-assignment - description: 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 @@ -23050,17 +29876,64 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __SEGMENTATION-ID__ - name: body in: body - description: segmentation-assignment object that needs to be created or updated + description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) required: true schema: $ref: "#/definitions/segmentation-assignment" + patch: + tags: + - Network + 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 + 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: segmentation-id + in: path + description: Route Table Reference id, UUID assigned to this instance. + required: true + type: string + example: __SEGMENTATION-ID__ + - name: body + in: body + description: segmentation-assignment object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/segmentation-assignment" delete: tags: - Network @@ -23082,11 +29955,13 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __SEGMENTATION-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -23106,7 +29981,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/segmentation-assignments" + $ref: "#/getDefinitions/segmentation-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -23115,6 +29990,7 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: network-name in: query description: Name of the network, governed by some naming convention.. @@ -23181,9 +30057,10 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-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/v9/NetworkL3NetworksL3Network.json) required: true schema: $ref: "#/definitions/relationship" @@ -23208,6 +30085,7 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ /network/l3-networks/l3-network/{network-id}: get: tags: @@ -23222,7 +30100,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-network" + $ref: "#/getDefinitions/l3-network" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -23231,6 +30109,7 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: network-name in: query description: Name of the network, governed by some naming convention.. @@ -23280,7 +30159,10 @@ paths: tags: - Network summary: create or update an existing l3-network - description: 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 @@ -23297,12 +30179,52 @@ paths: description: Network ID, should be uuid. Unique across A&AI. required: true type: string + example: __NETWORK-ID__ - name: body in: body - description: l3-network 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/v9/NetworkL3NetworksL3Network.json) required: true schema: $ref: "#/definitions/l3-network" + patch: + tags: + - Network + 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 + 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: body + in: body + description: l3-network object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-network" delete: tags: - Network @@ -23324,6 +30246,7 @@ paths: 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 @@ -23343,7 +30266,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/l3-networks" + $ref: "#/getDefinitions/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: @@ -23367,9 +30290,10 @@ paths: 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/v9/NetworkNetworkPoliciesNetworkPolicy.json) required: true schema: $ref: "#/definitions/relationship" @@ -23394,6 +30318,7 @@ paths: description: UUID representing unique key to this instance required: true type: string + example: __NETWORK-POLICY-ID__ /network/network-policies/network-policy/{network-policy-id}: get: tags: @@ -23408,7 +30333,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-policy" + $ref: "#/getDefinitions/network-policy" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -23417,6 +30342,7 @@ paths: description: UUID representing unique key to this instance required: true type: string + example: __NETWORK-POLICY-ID__ - name: network-policy-fqdn in: query description: Contrail FQDN for the policy @@ -23426,7 +30352,10 @@ paths: tags: - Network summary: create or update an existing network-policy - description: 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 @@ -23443,12 +30372,52 @@ paths: description: UUID representing unique key to this instance required: true type: string + example: __NETWORK-POLICY-ID__ - name: body in: body - description: network-policy object that needs to be created or updated + description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 + example: __NETWORK-POLICY-ID__ + - name: body + in: body + description: network-policy object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/network-policy" delete: tags: - Network @@ -23470,6 +30439,7 @@ paths: description: UUID representing unique key to this instance required: true type: string + example: __NETWORK-POLICY-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -23489,7 +30459,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/network-policies" + $ref: "#/getDefinitions/network-policies" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: @@ -23513,9 +30483,10 @@ paths: 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/v9/NetworkGenericVnfsGenericVnf.json) required: true schema: $ref: "#/definitions/relationship" @@ -23540,6 +30511,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + 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: @@ -23561,19 +30533,22 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -23598,16 +30573,19 @@ 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: vlan-interface in: path description: String that identifies the interface required: true 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: @@ -23629,24 +30607,28 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -23671,21 +30653,25 @@ 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: 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/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: @@ -23700,7 +30686,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: @@ -23709,21 +30695,25 @@ 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: 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: vnf-name in: query description: Name of VNF. @@ -23833,7 +30823,10 @@ paths: tags: - Network 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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -23850,27 +30843,88 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -23892,21 +30946,25 @@ 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: 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 @@ -23933,24 +30991,28 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -23975,21 +31037,25 @@ 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: 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/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: @@ -24004,7 +31070,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: @@ -24013,21 +31079,25 @@ 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: 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: vnf-name in: query description: Name of VNF. @@ -24137,7 +31207,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -24154,27 +31227,88 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -24196,21 +31330,25 @@ 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: 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 @@ -24230,7 +31368,7 @@ 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: @@ -24239,16 +31377,19 @@ 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: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: vnf-name in: query description: Name of VNF. @@ -24342,7 +31483,10 @@ paths: tags: - Network summary: create or update an existing vlan - description: 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 @@ -24359,28 +31503,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 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/vlan" - delete: + patch: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan + 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 @@ -24396,170 +31554,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 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 - required: true - type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: - get: - tags: - - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans - 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: - - 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 - 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - 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: 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}/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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship - 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-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 - 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 created or updated. required: true schema: - $ref: "#/definitions/relationship" + $ref: "#/patchDefinitions/vlan" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -24575,23 +31594,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 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/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + example: __VLAN-INTERFACE__ + - 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: get: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -24599,7 +31626,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -24608,16 +31635,13 @@ 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 - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string + example: __INTERFACE-NAME__ - name: vnf-name in: query description: Name of VNF. @@ -24696,32 +31720,12 @@ paths: 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 + /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: 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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -24737,28 +31741,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 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.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: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -24774,28 +31781,26 @@ 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: pci-id in: path description: PCI ID used to identify the sriov-vf 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}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + 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 sriov-vfs - description: returns sriov-vfs - operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs + summary: returns sriov-vf + description: returns sriov-vf + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf produces: - application/json - application/xml @@ -24803,7 +31808,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vfs" + $ref: "#/getDefinitions/sriov-vf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -24812,11 +31817,280 @@ 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: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - 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: persona-model-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: persona-model-version + 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: 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 + 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 + example: __VNF-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. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" + delete: + tags: + - Network + summary: delete an existing sriov-vf + description: delete an existing sriov-vf + operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf + 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 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}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + get: + tags: + - Network + summary: returns sriov-vfs + description: returns sriov-vfs + operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs + 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: 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 given to the interface + required: true + type: string + example: __INTERFACE-NAME__ - name: vnf-name in: query description: Name of VNF. @@ -24916,14 +32190,16 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -24948,11 +32224,13 @@ 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__ /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: @@ -24974,19 +32252,22 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -25011,16 +32292,19 @@ 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: l3-interface-ipv4-address in: path description: IP address required: true type: string + 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: @@ -25035,7 +32319,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: @@ -25044,16 +32328,19 @@ 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: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: vnf-name in: query description: Name of VNF. @@ -25152,7 +32439,10 @@ paths: tags: - Network 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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -25169,22 +32459,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 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -25206,16 +32550,19 @@ 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: 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 @@ -25242,19 +32589,22 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -25279,16 +32629,19 @@ 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: l3-interface-ipv6-address in: path description: IP address required: true type: string + 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: @@ -25303,7 +32656,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: @@ -25312,16 +32665,19 @@ 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: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: vnf-name in: query description: Name of VNF. @@ -25420,7 +32776,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -25437,22 +32796,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 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.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: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -25474,16 +32887,19 @@ 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: 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 @@ -25503,7 +32919,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: @@ -25512,11 +32928,13 @@ 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: vnf-name in: query description: Name of VNF. @@ -25599,7 +33017,10 @@ paths: tags: - Network summary: create or update an existing l-interface - description: 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 @@ -25616,17 +33037,64 @@ 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: 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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.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: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network @@ -25648,11 +33116,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -25672,7 +33142,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: @@ -25681,6 +33151,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -25765,14 +33236,16 @@ 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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -25797,11 +33270,13 @@ 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 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: @@ -25823,24 +33298,28 @@ 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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -25865,21 +33344,25 @@ 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 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/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: @@ -25901,29 +33384,34 @@ 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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -25948,26 +33436,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 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/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: @@ -25982,7 +33475,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: @@ -25991,26 +33484,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 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: vnf-name in: query description: Name of VNF. @@ -26130,7 +33628,10 @@ paths: tags: - Network 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: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -26147,38 +33648,54 @@ 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 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + patch: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 @@ -26194,37 +33711,43 @@ 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 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: 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 created or updated. 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: - put: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" + delete: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: delete an existing l3-interface-ipv4-address-list + description: delete an existing l3-interface-ipv4-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json - application/xml @@ -26240,38 +33763,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 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: body - in: body - description: relationship object that needs to be created or updated + example: __L3-INTERFACE-IPV4-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency required: true - schema: - $ref: "#/definitions/relationship" - delete: + 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: + put: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -26287,190 +33814,43 @@ 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 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/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: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - 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: 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 - in: path - description: IP address + 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - 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: 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-id - 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 - put: + 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: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -26486,45 +33866,46 @@ 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 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: body - in: body - description: l3-interface-ipv6-address-list object that needs to be created or updated - required: true - schema: - $ref: "#/definitions/l3-interface-ipv6-address-list" - delete: + 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: delete an existing l3-interface-ipv6-address-list - description: delete an existing l3-interface-ipv6-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - consumes: - - application/json - - application/xml + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList 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: @@ -26533,69 +33914,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 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: 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}: - get: - tags: - - Network - summary: returns vlan - description: returns vlan - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan - 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: - - 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 + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: vnf-name in: query description: Name of VNF. @@ -26695,12 +34038,31 @@ paths: 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 put: tags: - Network - summary: create or update an existing vlan - description: create or update an existing vlan - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + 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 @@ -26716,33 +34078,106 @@ 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 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: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/vlan" + $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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: delete an existing l3-interface-ipv6-address-list + description: delete an existing l3-interface-ipv6-address-list + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList consumes: - application/json - application/xml @@ -26758,33 +34193,43 @@ 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 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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/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/vlan/{vlan-interface}: get: tags: - Network - summary: returns vlans - description: returns vlans - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans + summary: returns vlan + description: returns vlan + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -26792,7 +34237,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlans" + $ref: "#/getDefinitions/vlan" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -26801,16 +34246,25 @@ 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 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: vnf-name in: query description: Name of VNF. @@ -26899,12 +34353,26 @@ paths: 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: + - name: vlan-id-inner + in: query + description: Inner VLAN tag + required: false + type: integer + format: int64 + - name: vpn-id + in: query + description: This indicates the customers VPN ID associated with this vlan + required: false + type: string put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + 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 @@ -26920,33 +34388,94 @@ 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 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: relationship 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/relationship" + $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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -26962,28 +34491,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 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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: + 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/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network - summary: returns sriov-vf - description: returns sriov-vf - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: returns vlans + description: returns vlans + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -26991,7 +34529,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/sriov-vf" + $ref: "#/getDefinitions/vlans" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -27000,21 +34538,19 @@ 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 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 - in: path - description: PCI ID used to identify the sriov-vf - required: true - type: string + example: __INTERFACE-NAME__ - name: vnf-name in: query description: Name of VNF. @@ -27103,32 +34639,12 @@ paths: 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 + /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: 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: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -27144,27 +34660,327 @@ 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 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - Network + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + 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: 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}/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: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + 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: 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: pci-id + in: path + description: PCI ID used to identify the sriov-vf + required: true + type: string + example: __PCI-ID__ + - 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: persona-model-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: persona-model-version + 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: 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 + type: string + 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 + 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. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network @@ -27186,21 +35002,25 @@ 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 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 @@ -27220,7 +35040,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: @@ -27229,16 +35049,19 @@ 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 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: vnf-name in: query description: Name of VNF. @@ -27348,19 +35171,22 @@ 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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -27385,16 +35211,19 @@ 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 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/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: @@ -27416,24 +35245,28 @@ 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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -27458,21 +35291,25 @@ 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 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/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: @@ -27487,7 +35324,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: @@ -27496,21 +35333,25 @@ 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 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: vnf-name in: query description: Name of VNF. @@ -27619,7 +35460,10 @@ paths: tags: - Network 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: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -27636,33 +35480,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 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + patch: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 @@ -27678,21 +35537,71 @@ 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 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. + 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: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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: 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 @@ -27719,24 +35628,28 @@ 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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -27761,21 +35674,25 @@ 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 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/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: @@ -27790,7 +35707,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: @@ -27799,21 +35716,25 @@ 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 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: vnf-name in: query description: Name of VNF. @@ -27922,7 +35843,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -27939,27 +35863,88 @@ 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 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -27981,21 +35966,25 @@ 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 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 @@ -28015,7 +36004,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: @@ -28024,16 +36013,19 @@ 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 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: vnf-name in: query description: Name of VNF. @@ -28126,7 +36118,10 @@ paths: tags: - Network summary: create or update an existing l-interface - description: 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: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface consumes: - application/json @@ -28143,28 +36138,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 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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/l-interface" - delete: + patch: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + 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 @@ -28180,36 +36189,38 @@ 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 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: body + in: body + description: l-interface object that needs to be created or updated. required: true - type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: - get: + schema: + $ref: "#/patchDefinitions/l-interface" + delete: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface + 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: @@ -28218,91 +36229,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 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - 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: 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 + example: __INTERFACE-NAME__ + - 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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - Network - summary: returns lag-interface - description: returns lag-interface - operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces produces: - application/json - application/xml @@ -28310,7 +36261,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interface" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -28319,11 +36270,13 @@ 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 required: true type: string + example: __INTERFACE-NAME__ - name: vnf-name in: query description: Name of VNF. @@ -28397,51 +36350,21 @@ paths: description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. required: false type: string - put: + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: + get: tags: - Network - summary: create or update an existing lag-interface - description: create or update an existing lag-interface - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface - consumes: - - application/json - - application/xml + summary: returns lag-interface + description: returns lag-interface + operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface 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-name - in: path - description: Name that identifies the link aggregate interface - required: true - type: string - - name: body - in: body - description: lag-interface object that needs to be created or updated - required: true + "200": + description: successful operation schema: - $ref: "#/definitions/lag-interface" - delete: - tags: - - Network - summary: delete an existing lag-interface - description: delete an existing lag-interface - operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: + $ref: "#/getDefinitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -28450,39 +36373,13 @@ 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 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: - get: - tags: - - Network - summary: returns lag-interfaces - description: returns lag-interfaces - operationId: getNetworkGenericVnfsGenericVnfLagInterfaces - produces: - - application/json - - application/xml - responses: - "200": - description: successful operation - schema: - $ref: "#/definitions/lag-interfaces" - "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: __INTERFACE-NAME__ - name: vnf-name in: query description: Name of VNF. @@ -28546,12 +36443,25 @@ paths: 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 - /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: + - 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 put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + 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 @@ -28567,23 +36477,70 @@ 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 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) required: true schema: - $ref: "#/definitions/relationship" + $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: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface + 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: body + in: body + description: lag-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" delete: tags: - Network - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship + summary: delete an existing lag-interface + description: delete an existing lag-interface + operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface consumes: - application/json - application/xml @@ -28599,18 +36556,25 @@ 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 that identifies the link aggregate interface required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: + example: __INTERFACE-NAME__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces: get: tags: - Network - summary: returns vf-module - description: returns vf-module - operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule + summary: returns lag-interfaces + description: returns lag-interfaces + operationId: getNetworkGenericVnfsGenericVnfLagInterfaces produces: - application/json - application/xml @@ -28618,7 +36582,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vf-module" + $ref: "#/getDefinitions/lag-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -28627,11 +36591,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: vf-module-id - in: path - description: Unique ID of vf-module. - required: true - type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -28695,47 +36655,12 @@ paths: 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: 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: persona-model-id - in: query - description: the ASDC model id for this resource or service model. - required: false - type: string - - name: persona-model-version - 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: contrail-service-instance-fqdn - in: query - description: the Contrail unique ID for a service-instance - 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: create or update an existing vf-module - description: create or update an existing vf-module - operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship consumes: - application/json - application/xml @@ -28751,23 +36676,25 @@ paths: 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: vf-module 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/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) required: true schema: - $ref: "#/definitions/vf-module" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing vf-module - description: delete an existing vf-module - operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship consumes: - application/json - application/xml @@ -28783,23 +36710,20 @@ paths: 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 - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: + example: __VF-MODULE-ID__ + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: get: tags: - Network - summary: returns vf-modules - description: returns vf-modules - operationId: getNetworkGenericVnfsGenericVnfVfModules + summary: returns vf-module + description: returns vf-module + operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule produces: - application/json - application/xml @@ -28807,7 +36731,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vf-modules" + $ref: "#/getDefinitions/vf-module" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -28816,6 +36740,13 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -28879,12 +36810,50 @@ paths: 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 - /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: + - 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: persona-model-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: persona-model-version + 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: contrail-service-instance-fqdn + in: query + description: the Contrail unique ID for a service-instance + required: false + type: string put: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + 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 @@ -28900,28 +36869,70 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: vf-module-id in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Unique ID of vf-module. required: true type: string - - name: resource-uuid + 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/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) + required: true + schema: + $ref: "#/definitions/vf-module" + patch: + tags: + - Network + 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 + 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 a license resource. + 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: vf-module object that needs to be created or 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: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship + summary: delete an existing vf-module + description: delete an existing vf-module + operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule consumes: - application/json - application/xml @@ -28937,23 +36948,25 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid + example: __VNF-ID__ + - name: vf-module-id in: path - description: Unique ID for the license group the resource belongs to, should be uuid. + description: Unique ID of vf-module. required: true type: string - - name: resource-uuid - in: path - description: Unique ID of a license resource. + example: __VF-MODULE-ID__ + - name: resource-version + in: query + description: resource-version for concurrency required: true type: string - /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: get: tags: - Network - summary: returns license - description: returns license - operationId: getNetworkGenericVnfsGenericVnfLicensesLicense + summary: returns vf-modules + description: returns vf-modules + operationId: getNetworkGenericVnfsGenericVnfVfModules produces: - application/json - application/xml @@ -28961,7 +36974,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/license" + $ref: "#/getDefinitions/vf-modules" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -28970,16 +36983,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string - - name: group-uuid - in: path - description: Unique ID for the license group the resource belongs to, should be uuid. - required: true - type: string - - name: resource-uuid - in: path - description: Unique ID of a license resource. - required: true - type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -29043,12 +37047,12 @@ paths: 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 + /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 license - description: create or update an existing license - operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship consumes: - application/json - application/xml @@ -29064,28 +37068,31 @@ paths: 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: license 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/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json) required: true schema: - $ref: "#/definitions/license" + $ref: "#/definitions/relationship" delete: tags: - Network - summary: delete an existing license - description: delete an existing license - operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship consumes: - application/json - application/xml @@ -29101,16 +37108,246 @@ paths: 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__ + /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: + get: + tags: + - Network + summary: returns license + description: returns license + operationId: getNetworkGenericVnfsGenericVnfLicensesLicense + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/license" + "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: 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: 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: persona-model-id + in: query + description: the ASDC model id for this resource or service model. + required: false + type: string + - name: persona-model-version + 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: + 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: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense + 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: 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: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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: 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: license object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/license" + delete: + tags: + - Network + summary: delete an existing license + description: delete an existing license + operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense + 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: 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: resource-version in: query description: resource-version for concurrency @@ -29130,7 +37367,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/licenses" + $ref: "#/getDefinitions/licenses" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29139,6 +37376,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -29223,19 +37461,22 @@ paths: 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 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: 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/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) required: true schema: $ref: "#/definitions/relationship" @@ -29260,16 +37501,19 @@ paths: 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 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__ /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: get: tags: @@ -29284,7 +37528,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlement" + $ref: "#/getDefinitions/entitlement" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29293,16 +37537,19 @@ paths: 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 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: vnf-name in: query description: Name of VNF. @@ -29370,7 +37617,10 @@ paths: tags: - Network summary: create or update an existing entitlement - description: 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 @@ -29387,22 +37637,76 @@ paths: 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 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: entitlement 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/v9/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: 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 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: entitlement object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/entitlement" delete: tags: - Network @@ -29424,16 +37728,19 @@ paths: 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 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: resource-version in: query description: resource-version for concurrency @@ -29453,7 +37760,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/entitlements" + $ref: "#/getDefinitions/entitlements" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29462,6 +37769,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -29539,7 +37847,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/generic-vnf" + $ref: "#/getDefinitions/generic-vnf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29548,6 +37856,7 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: vnf-name in: query description: Name of VNF. @@ -29615,7 +37924,10 @@ paths: tags: - Network summary: create or update an existing generic-vnf - description: 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 @@ -29632,12 +37944,52 @@ paths: description: Unique id of VNF. This is unique across the graph. required: true type: string + example: __VNF-ID__ - name: body in: body - description: generic-vnf 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/v9/NetworkGenericVnfsGenericVnf.json) required: true schema: $ref: "#/definitions/generic-vnf" + patch: + tags: + - Network + 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 + 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: generic-vnf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/generic-vnf" delete: tags: - Network @@ -29659,6 +38011,7 @@ paths: 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 @@ -29678,7 +38031,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/generic-vnfs" + $ref: "#/getDefinitions/generic-vnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/lag-links/lag-link/{link-name}/relationship-list/relationship: @@ -29702,9 +38055,10 @@ paths: description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-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/v9/NetworkLagLinksLagLink.json) required: true schema: $ref: "#/definitions/relationship" @@ -29729,6 +38083,7 @@ paths: description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ /network/lag-links/lag-link/{link-name}: get: tags: @@ -29743,7 +38098,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-link" + $ref: "#/getDefinitions/lag-link" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -29752,11 +38107,15 @@ paths: description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ put: tags: - Network summary: create or update an existing lag-link - description: 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 @@ -29773,12 +38132,52 @@ paths: description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ - name: body in: body - description: lag-link object that needs to be created or updated + description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json) required: true 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: Alphabetical concatenation of lag-interface names + required: true + type: string + example: __LINK-NAME__ + - name: body + in: body + description: lag-link object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-link" delete: tags: - Network @@ -29800,6 +38199,7 @@ paths: description: Alphabetical concatenation of lag-interface names required: true type: string + example: __LINK-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -29819,7 +38219,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-links" + $ref: "#/getDefinitions/lag-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: @@ -29843,9 +38243,10 @@ paths: 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/v9/NetworkNewvcesNewvce.json) required: true schema: $ref: "#/definitions/relationship" @@ -29870,6 +38271,7 @@ paths: 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__ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship: put: tags: @@ -29891,19 +38293,22 @@ paths: 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: 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/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -29928,16 +38333,19 @@ paths: 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: vlan-interface in: path description: String that identifies the interface required: true 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: @@ -29959,24 +38367,28 @@ paths: 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: 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/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -30001,21 +38413,25 @@ paths: 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: 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/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: @@ -30030,7 +38446,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: @@ -30039,21 +38455,25 @@ paths: 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: 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: vnf-name in: query description: Name of VNF. @@ -30125,7 +38545,10 @@ paths: tags: - Network 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: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -30142,27 +38565,88 @@ paths: 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 + example: __VNF-ID2__ + - 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -30184,21 +38668,25 @@ paths: 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: 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 @@ -30225,24 +38713,28 @@ paths: 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: 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/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -30267,21 +38759,25 @@ paths: 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: 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/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: @@ -30296,7 +38792,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: @@ -30305,21 +38801,25 @@ paths: 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: 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: vnf-name in: query description: Name of VNF. @@ -30391,7 +38891,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -30408,27 +38911,88 @@ paths: 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + 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 + example: __VNF-ID2__ + - 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -30450,21 +39014,25 @@ paths: 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: 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 @@ -30484,7 +39052,7 @@ 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: @@ -30493,16 +39061,19 @@ paths: 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: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: vnf-name in: query description: Name of VNF. @@ -30558,7 +39129,10 @@ paths: tags: - Network summary: create or update an existing vlan - description: 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 @@ -30575,22 +39149,76 @@ paths: 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.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: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan + 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 + example: __VNF-ID2__ + - 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. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - Network @@ -30612,16 +39240,19 @@ paths: 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: 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 @@ -30641,7 +39272,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: @@ -30650,11 +39281,13 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -30716,19 +39349,22 @@ paths: 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: 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/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -30753,16 +39389,19 @@ paths: 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: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: @@ -30777,7 +39416,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: @@ -30786,16 +39425,19 @@ paths: 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: pci-id in: path description: PCI ID used to identify the sriov-vf required: true type: string + example: __PCI-ID__ - name: vnf-name in: query description: Name of VNF. @@ -30860,7 +39502,10 @@ paths: tags: - Network summary: create or update an existing sriov-vf - description: 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 @@ -30877,22 +39522,76 @@ paths: 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf + 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 + 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: 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. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network @@ -30914,16 +39613,19 @@ paths: 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: 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 @@ -30943,7 +39645,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: @@ -30952,11 +39654,13 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -31018,14 +39722,16 @@ paths: 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: 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/v9/NetworkNewvcesNewvceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -31050,11 +39756,13 @@ paths: 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__ /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: @@ -31076,19 +39784,22 @@ paths: 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-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/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -31113,16 +39824,19 @@ paths: 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-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: @@ -31137,7 +39851,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: @@ -31146,16 +39860,19 @@ paths: 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-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: vnf-name in: query description: Name of VNF. @@ -31216,7 +39933,10 @@ paths: tags: - Network 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: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -31233,22 +39953,76 @@ paths: 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-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/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 + example: __VNF-ID2__ + - 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -31270,16 +40044,19 @@ paths: 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-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 @@ -31306,19 +40083,22 @@ paths: 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -31343,16 +40123,19 @@ paths: 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__ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: @@ -31367,7 +40150,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: @@ -31376,16 +40159,19 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -31446,7 +40232,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -31463,22 +40252,76 @@ paths: 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: l3-interface-ipv6-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/v9/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: 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: l3-interface-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -31500,16 +40343,19 @@ paths: 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: resource-version in: query description: resource-version for concurrency @@ -31529,7 +40375,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: @@ -31538,11 +40384,13 @@ paths: 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: vnf-name in: query description: Name of VNF. @@ -31587,7 +40435,10 @@ paths: tags: - Network summary: create or update an existing l-interface - description: 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 @@ -31604,23 +40455,36 @@ paths: 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: 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/v9/NetworkNewvcesNewvceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/l-interface" - delete: + patch: tags: - Network - summary: delete an existing l-interface - description: delete an existing l-interface - operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface + 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 @@ -31636,31 +40500,32 @@ paths: 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: body + in: body + description: l-interface object that needs to be created or updated. required: true - type: string - /network/newvces/newvce/{vnf-id2}/l-interfaces: - get: + schema: + $ref: "#/patchDefinitions/l-interface" + delete: tags: - Network - summary: returns l-interfaces - description: returns l-interfaces - operationId: getNetworkNewvcesNewvceLInterfaces + summary: delete an existing l-interface + description: delete an existing l-interface + operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface + 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: @@ -31669,38 +40534,25 @@ paths: description: Unique id of VNF, can't use same attribute name right now until we promote this new object 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 + example: __VNF-ID2__ + - name: interface-name + in: path + description: Name given to the interface + required: true type: string - - name: heat-stack-id + example: __INTERFACE-NAME__ + - 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/newvces/newvce/{vnf-id2}: + /network/newvces/newvce/{vnf-id2}/l-interfaces: get: tags: - Network - summary: returns newvce - description: returns newvce - operationId: getNetworkNewvcesNewvce + summary: returns l-interfaces + description: returns l-interfaces + operationId: getNetworkNewvcesNewvceLInterfaces produces: - application/json - application/xml @@ -31708,7 +40560,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/newvce" + $ref: "#/getDefinitions/l-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -31717,6 +40569,56 @@ paths: 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: 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 + /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__ - name: vnf-name in: query description: Name of VNF. @@ -31746,7 +40648,10 @@ paths: tags: - Network summary: create or update an existing newvce - description: 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 @@ -31763,12 +40668,52 @@ paths: 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: newvce object that needs to be created or updated + description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json) required: true 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: 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: newvce object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/newvce" delete: tags: - Network @@ -31790,6 +40735,7 @@ paths: 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 @@ -31809,7 +40755,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/newvces" + $ref: "#/getDefinitions/newvces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: @@ -31833,9 +40779,10 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-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/v9/NetworkPnfsPnf.json) required: true schema: $ref: "#/definitions/relationship" @@ -31860,6 +40807,7 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: put: tags: @@ -31881,14 +40829,16 @@ 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: 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/v9/NetworkPnfsPnfPInterfacesPInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -31913,11 +40863,13 @@ 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__ /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: @@ -31939,24 +40891,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 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -31981,21 +40937,25 @@ 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: 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: @@ -32017,29 +40977,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 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -32064,26 +41029,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 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__ /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: @@ -32098,7 +41068,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: @@ -32107,26 +41077,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 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -32183,7 +41158,10 @@ paths: tags: - Network 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: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -32200,32 +41178,100 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -32247,26 +41293,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 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 @@ -32293,29 +41344,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 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -32340,26 +41396,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 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__ /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: @@ -32374,7 +41435,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: @@ -32383,26 +41444,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 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -32459,7 +41525,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -32476,32 +41545,100 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -32523,26 +41660,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 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 @@ -32562,7 +41704,7 @@ 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: @@ -32571,21 +41713,25 @@ 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: vlan-interface in: path description: String that identifies the interface required: true type: string + example: __VLAN-INTERFACE__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -32626,7 +41772,10 @@ paths: tags: - Network summary: create or update an existing vlan - description: 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 @@ -32643,27 +41792,88 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan + 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 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: vlan object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - Network @@ -32685,21 +41895,25 @@ 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: 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 @@ -32719,7 +41933,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: @@ -32728,16 +41942,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -32784,24 +42001,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 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true schema: $ref: "#/definitions/relationship" @@ -32826,21 +42047,25 @@ 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__ /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: @@ -32855,7 +42080,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: @@ -32864,21 +42089,25 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -32928,7 +42157,10 @@ paths: tags: - Network summary: create or update an existing sriov-vf - description: 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 @@ -32945,27 +42177,88 @@ 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: sriov-vf 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf + 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 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: sriov-vf object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/sriov-vf" delete: tags: - Network @@ -32987,21 +42280,25 @@ 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 @@ -33021,7 +42318,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: @@ -33030,16 +42327,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33086,19 +42386,22 @@ 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: 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -33123,16 +42426,19 @@ 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__ /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: @@ -33154,24 +42460,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 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -33196,21 +42506,25 @@ 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: 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: @@ -33225,7 +42539,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: @@ -33234,21 +42548,25 @@ 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: l3-interface-ipv4-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV4-ADDRESS__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33294,7 +42612,10 @@ paths: tags: - Network 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: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -33311,27 +42632,88 @@ 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: 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList + 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 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: l3-interface-ipv4-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -33353,21 +42735,25 @@ 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: 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 @@ -33394,24 +42780,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 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -33436,21 +42826,25 @@ 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: 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: @@ -33465,7 +42859,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: @@ -33474,21 +42868,25 @@ 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: l3-interface-ipv6-address in: path description: IP address required: true type: string + example: __L3-INTERFACE-IPV6-ADDRESS__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33534,7 +42932,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -33551,27 +42952,88 @@ 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: 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList + 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 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. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -33593,21 +43055,25 @@ 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: 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 @@ -33627,7 +43093,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: @@ -33636,16 +43102,19 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33675,7 +43144,10 @@ paths: tags: - Network summary: create or update an existing l-interface - description: 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 @@ -33692,22 +43164,76 @@ 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: 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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface + 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 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: l-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network @@ -33729,16 +43255,19 @@ 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: resource-version in: query description: resource-version for concurrency @@ -33758,7 +43287,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: @@ -33767,11 +43296,13 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33796,7 +43327,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interface" + $ref: "#/getDefinitions/p-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -33805,11 +43336,13 @@ 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33824,7 +43357,10 @@ paths: tags: - Network summary: create or update an existing p-interface - description: 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 @@ -33841,17 +43377,64 @@ 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: body in: body - description: p-interface object that needs to be created or updated + description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json) required: true schema: $ref: "#/definitions/p-interface" + patch: + tags: + - Network + 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 + 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 physical interface + required: true + type: string + example: __INTERFACE-NAME__ + - name: body + in: body + description: p-interface object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/p-interface" delete: tags: - Network @@ -33873,11 +43456,13 @@ 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: resource-version in: query description: resource-version for concurrency @@ -33897,7 +43482,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/p-interfaces" + $ref: "#/getDefinitions/p-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -33906,6 +43491,7 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -33932,14 +43518,16 @@ 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 + 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/v9/NetworkPnfsPnfLagInterfacesLagInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -33964,11 +43552,13 @@ 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 + 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: @@ -33990,24 +43580,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 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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: $ref: "#/definitions/relationship" @@ -34032,21 +43626,25 @@ 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 + 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: @@ -34068,29 +43666,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 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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -34115,26 +43718,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 + 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: @@ -34149,7 +43757,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: @@ -34158,26 +43766,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -34239,7 +43852,10 @@ paths: tags: - Network 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: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList consumes: - application/json @@ -34256,38 +43872,54 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/l3-interface-ipv4-address-list" - delete: + patch: tags: - Network - summary: delete an existing l3-interface-ipv4-address-list - description: delete an existing l3-interface-ipv4-address-list - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList + 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 @@ -34303,84 +43935,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 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: 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}/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 - - 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 - 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. 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: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship + 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 @@ -34396,132 +43987,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 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 - 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}: - get: - tags: - - Network - summary: returns l3-interface-ipv6-address-list - description: returns l3-interface-ipv6-address-list - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList - 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 - 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 + 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 - 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-id - 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/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: create or update an existing l3-interface-ipv6-address-list - description: create or update an existing l3-interface-ipv6-address-list - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: see node definition for valid relationships + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -34537,38 +44038,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 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.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: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship consumes: - application/json - application/xml @@ -34584,38 +44090,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 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: 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}: + 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 vlan - description: returns vlan - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + summary: returns l3-interface-ipv6-address-list + description: returns l3-interface-ipv6-address-list + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList produces: - application/json - application/xml @@ -34623,7 +44129,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vlan" + $ref: "#/getDefinitions/l3-interface-ipv6-address-list" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -34632,21 +44138,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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -34688,12 +44204,31 @@ paths: 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 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 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 @@ -34709,33 +44244,54 @@ 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 + 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: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true schema: - $ref: "#/definitions/vlan" - delete: + $ref: "#/definitions/l3-interface-ipv6-address-list" + patch: tags: - Network - summary: delete an existing vlan - description: delete an existing vlan - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan + 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 @@ -34751,95 +44307,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 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 - 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: "#/definitions/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 + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path - description: Name that identifies the link aggregate interface + description: IP address required: true type: string - - name: interface-name - in: path - description: Name given to the interface + example: __L3-INTERFACE-IPV6-ADDRESS__ + - name: body + in: body + description: l3-interface-ipv6-address-list object that needs to be created or updated. 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 - /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: + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" + delete: tags: - Network - summary: see node definition for valid relationships - operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship + 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 @@ -34855,70 +44359,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 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 - in: path - description: PCI ID used to identify the sriov-vf - 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: - 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 - - name: interface-name + example: __INTERFACE-NAME__ + - name: vlan-interface in: path - description: Name that identifies the link aggregate interface + description: String that identifies the interface required: true type: string - - name: interface-name + example: __VLAN-INTERFACE__ + - name: l3-interface-ipv6-address in: path - description: Name given to the interface + description: IP address required: true type: string - - name: pci-id - in: path - description: PCI ID used to identify the sriov-vf + 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}/sriov-vfs/sriov-vf/{pci-id}: + /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 sriov-vf - description: returns sriov-vf - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: returns vlan + description: returns vlan + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan produces: - application/json - application/xml @@ -34926,7 +44403,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: @@ -34935,21 +44412,25 @@ 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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -34980,32 +44461,26 @@ paths: 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 + - name: vlan-id-inner 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. + description: Inner VLAN tag required: false - type: boolean - - name: neutron-network-id + type: integer + format: int64 + - name: vpn-id in: query - description: Neutron network id of the interface + description: This indicates the customers VPN ID associated with this vlan required: false type: string 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 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 @@ -35021,33 +44496,94 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true schema: - $ref: "#/definitions/sriov-vf" + $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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vlan" delete: tags: - Network - summary: delete an existing sriov-vf - description: delete an existing sriov-vf - operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf + summary: delete an existing vlan + description: delete an existing vlan + operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan consumes: - application/json - application/xml @@ -35063,33 +44599,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 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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: + /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network - summary: returns sriov-vfs - description: returns sriov-vfs - operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs + summary: returns vlans + description: returns vlans + operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans produces: - application/json - application/xml @@ -35097,7 +44637,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: @@ -35106,16 +44646,19 @@ 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 + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -35146,12 +44689,12 @@ paths: description: Name of the network 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}/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: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship + operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship consumes: - application/json - application/xml @@ -35167,19 +44710,417 @@ 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 + 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/v9/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__ + - 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: 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 + 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/v9/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 created or 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: 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 + /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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true schema: $ref: "#/definitions/relationship" @@ -35204,16 +45145,19 @@ 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 + 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: @@ -35235,24 +45179,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 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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -35277,21 +45225,25 @@ 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 + 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: @@ -35306,7 +45258,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: @@ -35315,21 +45267,25 @@ 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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -35380,7 +45336,10 @@ paths: tags: - Network 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: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList consumes: - application/json @@ -35397,27 +45356,88 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv4-address-list" delete: tags: - Network @@ -35439,21 +45459,25 @@ 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 + 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 @@ -35480,24 +45504,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 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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true schema: $ref: "#/definitions/relationship" @@ -35522,21 +45550,25 @@ 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 + 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: @@ -35551,7 +45583,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: @@ -35560,21 +45592,25 @@ 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 + 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: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -35625,7 +45661,10 @@ paths: tags: - Network summary: create or update an existing l3-interface-ipv6-address-list - description: 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 @@ -35642,27 +45681,88 @@ 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 + 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 created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l3-interface-ipv6-address-list" delete: tags: - Network @@ -35684,21 +45784,25 @@ 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 + 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 @@ -35718,7 +45822,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: @@ -35727,16 +45831,19 @@ 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 + example: __INTERFACE-NAME__ - name: interface-name in: path description: Name given to the interface required: true type: string + example: __INTERFACE-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -35771,7 +45878,10 @@ paths: tags: - Network summary: create or update an existing l-interface - description: 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 @@ -35788,22 +45898,76 @@ 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 + 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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/l-interface" delete: tags: - Network @@ -35825,16 +45989,19 @@ 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 + 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 @@ -35854,7 +46021,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: @@ -35863,11 +46030,13 @@ 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 + example: __INTERFACE-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -35897,7 +46066,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interface" + $ref: "#/getDefinitions/lag-interface" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -35906,11 +46075,13 @@ 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 + example: __INTERFACE-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -35930,7 +46101,10 @@ paths: tags: - Network summary: create or update an existing lag-interface - description: 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 @@ -35947,17 +46121,64 @@ 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 + example: __INTERFACE-NAME__ - name: body in: body - description: lag-interface 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/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/lag-interface" delete: tags: - Network @@ -35979,11 +46200,13 @@ 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 + example: __INTERFACE-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -36003,7 +46226,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/lag-interfaces" + $ref: "#/getDefinitions/lag-interfaces" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36012,6 +46235,7 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -36031,7 +46255,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/pnf" + $ref: "#/getDefinitions/pnf" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36040,6 +46264,7 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: inv-status in: query description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. @@ -36049,7 +46274,10 @@ paths: tags: - Network summary: create or update an existing pnf - description: 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 @@ -36066,12 +46294,52 @@ paths: 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 + description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/pnf" delete: tags: - Network @@ -36093,6 +46361,7 @@ paths: description: unique name of Physical Network Function. required: true type: string + example: __PNF-NAME__ - name: resource-version in: query description: resource-version for concurrency @@ -36112,7 +46381,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/pnfs" + $ref: "#/getDefinitions/pnfs" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/physical-links/physical-link/{link-name}/relationship-list/relationship: @@ -36136,9 +46405,10 @@ paths: 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 + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json) required: true schema: $ref: "#/definitions/relationship" @@ -36163,6 +46433,7 @@ paths: 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: @@ -36177,7 +46448,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/physical-link" + $ref: "#/getDefinitions/physical-link" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36186,6 +46457,7 @@ paths: description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true type: string + example: __LINK-NAME__ - name: circuit-id in: query description: Circuit it @@ -36195,7 +46467,10 @@ paths: tags: - Network summary: create or update an existing physical-link - description: 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 @@ -36212,12 +46487,52 @@ paths: 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 + description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/physical-link" delete: tags: - Network @@ -36239,6 +46554,7 @@ paths: 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 @@ -36258,7 +46574,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/physical-links" + $ref: "#/getDefinitions/physical-links" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: @@ -36282,9 +46598,10 @@ paths: 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 + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json) required: true schema: $ref: "#/definitions/relationship" @@ -36309,6 +46626,7 @@ paths: 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: @@ -36330,14 +46648,16 @@ paths: 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 + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) required: true schema: $ref: "#/definitions/relationship" @@ -36362,11 +46682,13 @@ paths: 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: @@ -36381,7 +46703,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vig-server" + $ref: "#/getDefinitions/vig-server" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36390,16 +46712,21 @@ paths: 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 + 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 @@ -36416,17 +46743,64 @@ paths: 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 + description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vig-server" delete: tags: - Network @@ -36448,11 +46822,13 @@ paths: 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 @@ -36472,7 +46848,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/vig-servers" + $ref: "#/getDefinitions/vig-servers" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36481,6 +46857,7 @@ paths: description: UUID of this configuration required: true type: string + example: __IPSEC-CONFIGURATION-ID__ /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: get: tags: @@ -36495,7 +46872,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ipsec-configuration" + $ref: "#/getDefinitions/ipsec-configuration" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36504,11 +46881,15 @@ paths: 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 + 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 @@ -36525,12 +46906,52 @@ paths: 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 + description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/ipsec-configuration" delete: tags: - Network @@ -36552,6 +46973,7 @@ paths: description: UUID of this configuration required: true type: string + example: __IPSEC-CONFIGURATION-ID__ - name: resource-version in: query description: resource-version for concurrency @@ -36571,7 +46993,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/ipsec-configurations" + $ref: "#/getDefinitions/ipsec-configurations" "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: @@ -36595,9 +47017,10 @@ paths: 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 + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json) required: true schema: $ref: "#/definitions/relationship" @@ -36622,6 +47045,7 @@ paths: 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: @@ -36636,7 +47060,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/route-table-reference" + $ref: "#/getDefinitions/route-table-reference" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36645,6 +47069,7 @@ paths: description: Route Table Reference id, UUID assigned to this instance. required: true type: string + example: __ROUTE-TABLE-REFERENCE-ID__ - name: route-table-reference-fqdn in: query description: FQDN entry in the route table. @@ -36654,7 +47079,10 @@ paths: tags: - Network summary: create or update an existing route-table-reference - description: 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 @@ -36671,12 +47099,52 @@ paths: 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 + description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/route-table-reference" delete: tags: - Network @@ -36698,6 +47166,7 @@ paths: 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 @@ -36717,7 +47186,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/route-table-references" + $ref: "#/getDefinitions/route-table-references" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/instance-groups/instance-group/{id}/relationship-list/relationship: @@ -36741,9 +47210,10 @@ paths: 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 + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json) required: true schema: $ref: "#/definitions/relationship" @@ -36768,6 +47238,7 @@ paths: description: Instance Group ID, UUID assigned to this instance. required: true type: string + example: __ID__ /network/instance-groups/instance-group/{id}: get: tags: @@ -36782,7 +47253,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/instance-group" + $ref: "#/getDefinitions/instance-group" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36791,6 +47262,7 @@ paths: description: Instance Group ID, UUID assigned to this instance. required: true type: string + example: __ID__ - name: description in: query description: Descriptive text to help identify the usage of this instance-group @@ -36810,7 +47282,10 @@ paths: tags: - Network summary: create or update an existing instance-group - description: 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 @@ -36827,12 +47302,52 @@ paths: 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 + description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/instance-group" delete: tags: - Network @@ -36854,6 +47369,7 @@ paths: 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 @@ -36873,7 +47389,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/instance-groups" + $ref: "#/getDefinitions/instance-groups" "default": description: Response codes found in [response codes](https://wiki.onap.org/). /network/zones/zone/{zone-id}/relationship-list/relationship: @@ -36897,9 +47413,10 @@ paths: 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 + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json) required: true schema: $ref: "#/definitions/relationship" @@ -36924,6 +47441,7 @@ paths: description: Code assigned by AIC to the zone required: true type: string + example: __ZONE-ID__ /network/zones/zone/{zone-id}: get: tags: @@ -36938,7 +47456,7 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/zone" + $ref: "#/getDefinitions/zone" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -36947,6 +47465,7 @@ paths: description: Code assigned by AIC to the zone required: true type: string + example: __ZONE-ID__ - name: design-type in: query description: Design of zone [Medium/Large?] @@ -36961,7 +47480,10 @@ paths: tags: - Network summary: create or update an existing zone - description: 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 @@ -36978,12 +47500,52 @@ paths: 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 + description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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 created or updated. + required: true + schema: + $ref: "#/patchDefinitions/zone" delete: tags: - Network @@ -37005,6 +47567,7 @@ paths: 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 @@ -37024,24 +47587,30 @@ paths: "200": description: successful operation schema: - $ref: "#/definitions/zones" + $ref: "#/getDefinitions/zones" "default": description: Response codes found in [response codes](https://wiki.onap.org/). definitions: - search: + aai-internal: 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" + property-name: + type: string + property-value: + type: string + 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). @@ -37052,103 +47621,291 @@ definitions: notify: type: object $ref: "#/definitions/notify" - relationship-data: + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT 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: - properties: - property-key: + description: The descriptive information assigned to this allotted resource instance + selflink: type: string - description: Key part of a key/value pair - property-value: + description: Link back to more information in the controller + persona-model-id: type: string - description: Value part of a key/value pair - relationship: - properties: - related-to: + description: the ASDC model id for this resource or service model. + persona-model-version: type: string - description: A keyword provided by A&AI to indicate type of node. - related-link: + description: the ASDC model version for this resource or service model. + model-version-id: type: string - description: URL to the object in A&AI. - relationship-data: + description: the ASDC model version for this resource or service model. + persona-model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + resource-version: + type: string + description: Concurrency value + tunnel-xconnects: type: array - items: - $ref: "#/definitions/relationship-data" - related-to-property: + 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/related-to-property" - relationship-list: + $ref: "#/definitions/allotted-resource" + availability-zone: + description: | + Availability zone, a collection of compute hosts/pservers + ###### Related Nodes + - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE + required: + - availability-zone-name + - hypervisor-type properties: - relationship: + 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-state: + 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" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + 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" - ctag-pool: + classes-of-service: description: | - A collection of C tags (vlan tags) grouped for a specific purpose. - ###### Default Delete Scope - THIS_NODE_ONLY + 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 availability-zone (Many2Many) - - FROM complex (is composed of ctag-pool) - - FROM vpls-pe + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE required: - - target-pe - - availability-zone-name - - ctag-pool-purpose + - cloud-owner + - cloud-region-id 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. 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" - ctag-pools: + cloud-regions: properties: - ctag-pool: + cloud-region: type: array items: - $ref: "#/definitions/ctag-pool" + $ref: "#/definitions/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 + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL required: - physical-location-id - physical-location-type @@ -37214,43 +47971,59 @@ definitions: type: array items: $ref: "#/definitions/complex" - volume-group: + 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 org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - CONFIGURATION is DELETED when these are DELETED METADATUM + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK 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: Name of the volume group. - heat-stack-id: + 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: Heat stack id corresponding to this volume-group - vnf-type: + description: Name of the configuration. + configuration-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. + 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 this volume-group - persona-model-customization-id: + description: Orchestration status of the configuration. + operational-status: type: string - description: captures the id of all the configuration used to customize the resource for the service. - vf-module-persona-model-customization-id: + description: Indicator for whether the resource is considered operational. + configuration-selflink: type: string - description: helps relate the volume group to the vf-module whose components will require the volume group + 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. @@ -37258,456 +48031,634 @@ definitions: type: array items: $ref: "#/definitions/relationship" - volume-groups: + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + configurations: description: | - Collection of persistent block-level storage. + Collection of configurations properties: - volume-group: + configuration: type: array items: - $ref: "#/definitions/volume-group" - volume: + $ref: "#/definitions/configuration" + connector: description: | - Ephemeral Block storage volume. - ###### Default Delete Scope - THIS_NODE_ONLY + Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - - FROM vserver (is composed of volume) + - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM required: - - volume-id - - volume-selflink + - resource-instance-id properties: - volume-id: - type: string - description: Unique ID of block storage volume relative to the vserver. - volume-selflink: + resource-instance-id: type: string - description: URL to endpoint where AAI can get more details + 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. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + 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" - volumes: + metadata: + type: array + items: + $ref: "#/definitions/metadatum" + connectors: description: | - Collection of ephemeral Block storage volumes. + Collection of resource instances used to connect a variety of disparate inventory widgets properties: - volume: + connector: type: array items: - $ref: "#/definitions/volume" - l3-interface-ipv4-address-list: + $ref: "#/definitions/connector" + constrained-element-set: description: | - IPv4 Address Range - ###### Default Delete Scope - THIS_NODE_ONLY + This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - - 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) + - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET required: - - l3-interface-ipv4-address + - constrained-element-set-uuid + - constraint-type + - check-type properties: - l3-interface-ipv4-address: + constrained-element-set-uuid: 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: + constraint-type: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - neutron-network-id: + check-type: type: string - description: Neutron network id of the interface that address belongs to - neutron-subnet-id: + resource-version: type: string - description: Neutron id of subnet that address belongs to + element-choice-sets: + type: array + items: + $ref: "#/definitions/element-choice-set" relationship-list: type: array items: $ref: "#/definitions/relationship" - l3-interface-ipv6-address-list: + constrained-element-sets: + properties: + constrained-element-set: + type: array + items: + $ref: "#/definitions/constrained-element-set" + ctag-assignment: description: | - IPv6 Address Range - ###### Default Delete Scope - THIS_NODE_ONLY ###### Related Nodes - - 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 l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) required: - - l3-interface-ipv6-address + - vlan-id-inner 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 + description: id. 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" - vlan: + ctag-assignments: + properties: + ctag-assignment: + type: array + items: + $ref: "#/definitions/ctag-assignment" + ctag-pool: description: | - Definition of vlan - ###### Default Delete Scope - CASCADE_TO_CHILDREN + A collection of C tags (vlan tags) grouped for a specific purpose. ###### 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 + - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) required: - - vlan-interface + - target-pe + - availability-zone-name + - ctag-pool-purpose properties: - vlan-interface: + target-pe: 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: The Target provider edge router + availability-zone-name: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - speed-value: + description: Name of the availability zone + ctag-pool-purpose: type: string - description: Captures the numeric part of the speed - speed-units: + description: Describes what the intended purpose of this pool is. + ctag-values: type: string - description: Captures the units corresponding to the speed - vlan-description: + description: Comma separated list of ctags + resource-version: type: string - description: Used to describe (the service associated with) the vlan - backdoor-connection: + 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + required: + - global-customer-id + - subscriber-name + - subscriber-type + properties: + global-customer-id: type: string - description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. - vpn-id: + description: Global customer id used across ECOMP to uniquely identify customer. + subscriber-name: type: string - description: This indicates the customers VPN ID associated with this vlan - orchestration-status: + description: Subscriber name, an alternate way to retrieve a customer. + subscriber-type: type: string - description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. + 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" - l3-interface-ipv4-address-list: + customers: + description: | + Collection of customer identifiers to provide linkage back to BSS information. + properties: + customer: type: array items: - $ref: "#/definitions/l3-interface-ipv4-address-list" - l3-interface-ipv6-address-list: + $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/l3-interface-ipv6-address-list" - vlans: + items: + $ref: "#/definitions/relationship" + cvlan-tags: properties: - vlan: + cvlan-tag-entry: type: array items: - $ref: "#/definitions/vlan" - sriov-vf: + $ref: "#/definitions/cvlan-tag-entry" + dvs-switch: description: | - SR-IOV Virtual Function (not to be confused with virtual network function) - ###### Default Delete Scope - THIS_NODE_ONLY + 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 - - FROM l-interface (is composed of sriov-vf) + - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) required: - - pci-id + - switch-name + - vcenter-url 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: + switch-name: 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: + description: DVS switch name + vcenter-url: type: string - description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. + 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. - neutron-network-id: - type: string - description: Neutron network id of the interface relationship-list: type: array items: $ref: "#/definitions/relationship" - sriov-vfs: + dvs-switches: description: | - Collection of SR-IOV Virtual Functions. + Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. properties: - sriov-vf: + dvs-switch: type: array items: - $ref: "#/definitions/sriov-vf" - l-interface: + $ref: "#/definitions/dvs-switch" + edge-prop-names: description: | - Logical interfaces, e.g., a vnic. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many) - - TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many) - - 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) - required: - - interface-name + Internal map to define the properties of an edge and interpret the map EdgeRules properties: - interface-name: + edgeLabel: type: string - description: Name given to the interface - interface-role: + direction: type: string - description: E.g., CUSTOMER, UPLINK, etc. - v6-wan-link-ip: + multiplicityRule: type: string - description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. - selflink: + isParent: + type: boolean + usesResource: + type: boolean + hasDelTarget: + type: boolean + SVC-INFRA: + type: boolean + SVC-INFRA-REV: + type: boolean + edge-tag-query-request: + properties: + edge-tag: type: string - description: URL to endpoint where AAI can get more details - interface-id: + result-detail: type: string - description: ID of interface - macaddr: + start-node-type: type: string - description: MAC address for the interface - network-name: + 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 org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + required: + - element-choice-set-uuid + - element-choice-set-name + properties: + element-choice-set-uuid: type: string - description: Name of the network - management-option: + element-choice-set-name: type: string - description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER - interface-description: + cardinality: 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. - vlans: - type: array - items: - $ref: "#/definitions/vlan" - sriov-vfs: + model-elements: type: array items: - $ref: "#/definitions/sriov-vf" + $ref: "#/definitions/model-element" relationship-list: type: array items: $ref: "#/definitions/relationship" - l3-interface-ipv4-address-list: + element-choice-sets: + properties: + element-choice-set: type: array items: - $ref: "#/definitions/l3-interface-ipv4-address-list" - l3-interface-ipv6-address-list: + $ref: "#/definitions/element-choice-set" + entitlement: + description: | + Metadata for entitlement group. + ###### Related Nodes + - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + 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/l3-interface-ipv6-address-list" - l-interfaces: + $ref: "#/definitions/entitlement" + esr-ems: description: | - Collection of logical interfaces. + Persist EMS address information used by EMS driver. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - ems-id properties: - l-interface: + 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/l-interface" - vserver: + $ref: "#/definitions/esr-ems" + esr-system-info: 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 + Persist common address information of external systems. + ###### Related Nodes + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) required: - - vserver-id - - vserver-name - - vserver-selflink - - in-maint - - is-closed-loop-disabled + - esr-system-info-id + - user-name + - password + - system-type properties: - vserver-id: + esr-system-info-id: type: string - description: Unique identifier for this vserver relative to its tenant - vserver-name: + description: Unique ID of esr system info. + system-name: type: string - description: Name of vserver - vserver-name2: + description: name of external system. + type: type: string - description: Alternative name of vserver - prov-status: + description: type of external systems. + vendor: type: string - description: Trigger for operational monitoring of this resource by Service Assurance systems. - vserver-selflink: + description: vendor of external systems. + version: type: string - description: URL to endpoint where AAI can get more details - in-maint: + 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 - is-closed-loop-disabled: + 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. - 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: + esr-system-info-list: description: | - Collection of virtual Servers, aka virtual machines or VMs. + Collection of persistent block-level external system auth info. properties: - vserver: + esr-system-info: type: array items: - $ref: "#/definitions/vserver" - tenant: + $ref: "#/definitions/esr-system-info" + esr-thirdparty-sdnc: description: | - Openstack tenant - ###### Default Delete Scope - THIS_NODE_ONLY + Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - - TO l3-network (Many2Many) - - TO service-subscription (Many2Many) - - TO vserver (comprises tenant, One2Many) - - FROM cloud-region (is composed of tenant) - - FROM group-assignment - - FROM volume-group + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: - - tenant-id - - tenant-name + - thirdparty-sdnc-id properties: - tenant-id: + thirdparty-sdnc-id: type: string - description: Unique id relative to the cloud-region. - tenant-name: + description: Unique ID of SDNC. + location: type: string - description: Readable name of tenant + 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. - vservers: - type: array - items: - $ref: "#/definitions/vserver" + 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/relationship" - tenants: + items: + $ref: "#/definitions/esr-thirdparty-sdnc" + esr-vnfm: description: | - Collection of openstack tenants. + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + required: + - vnfm-id properties: - tenant: + 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/tenant" + $ref: "#/definitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + 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 + extra-property: + properties: + property-name: + type: string flavor: description: | Openstack flavor. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES ###### Related Nodes - - FROM cloud-region (is composed of flavor) - - FROM vserver + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked to VSERVER required: - flavor-id - flavor-name @@ -37762,143 +48713,376 @@ definitions: type: array items: $ref: "#/definitions/flavor" - group-assignment: + forwarder: description: | - Openstack group-assignment used to store exclusivity groups (EG). - ###### Default Delete Scope - THIS_NODE_ONLY + Entity describing a sequenced segment of forwarding path ###### Related Nodes - - TO tenant (Many2Many) - - TO pserver (One2Many) - - FROM cloud-region (is composed of group-assignment) + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION required: - - group-id - - group-type - - group-name + - sequence properties: - group-id: + sequence: + type: integer + format: int32 + description: Unique ID of this segmentation + forwarder-role: type: string - description: Group id, expected to be unique across cloud-region. - group-type: + description: ingress, intermediate, egress + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + resource-version: type: string - description: Group type - the type of group this instance refers to - group-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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + required: + - forwarder-evc-id + properties: + forwarder-evc-id: type: string - description: Group name - name assigned to the group - group-description: + description: Key for forwarder-evc object + circuit-id: type: string - description: Group description - description of the group - resource-version: + 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: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + 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" - group-assignments: + 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: | - Collection of openstack group assignments + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + required: + - forwarding-path-id + - forwarding-path-name properties: - group-assignment: + 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/group-assignment" - snapshot: + $ref: "#/definitions/forwarding-path" + generic-vnf: description: | - Openstack snapshot - ###### Default Delete Scope - THIS_NODE_ONLY + General purpose VNF ###### Related Nodes - - FROM cloud-region (is composed of snapshot) - - FROM vserver + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE required: - - snapshot-id + - vnf-id + - vnf-name + - vnf-type + - in-maint + - is-closed-loop-disabled properties: - snapshot-id: + vnf-id: type: string - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. - snapshot-name: + description: Unique id of VNF. This is unique across the graph. + vnf-name: type: string - description: Snapshot name - snapshot-architecture: + description: Name of VNF. + vnf-name2: type: string - description: Operating system architecture - snapshot-os-distro: + description: Alternate name of VNF. + vnf-type: type: string - description: The common name of the operating system distribution in lowercase - snapshot-os-version: + 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: The operating system version as specified by the distributor. - application: + description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED + regional-resource-zone: type: string - description: The application that the image instantiates. - application-vendor: + description: Regional way of organizing pservers, source of truth should define values + prov-status: type: string - description: The vendor of the application. - application-version: + description: Trigger for operational monitoring of this resource by Service Assurance systems. + operational-state: type: string - description: The version of the application. - snapshot-selflink: + 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: URL to endpoint where AAI can get more details - prev-snapshot-id: + description: OBSOLETE - do not use + equipment-role: type: string - description: This field contains the UUID of the previous snapshot (if any). + description: Client should send valid enumerated value + 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 company 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 in some usecases + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases + 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 in some usecases + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases + 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 in some usecases + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean 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 + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-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 + selflink: + type: string + description: Path to the controller object. relationship-list: type: array items: $ref: "#/definitions/relationship" - snapshots: + 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 openstack snapshots + Collection of VNFs properties: - snapshot: + generic-vnf: type: array items: - $ref: "#/definitions/snapshot" - metadatum: + $ref: "#/definitions/generic-vnf" + group-assignment: description: | - Key/value pairs - ###### Default Delete Scope - THIS_NODE_ONLY + Openstack group-assignment used to store exclusivity groups (EG). ###### 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 cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) required: - - metaname - - metaval + - group-id + - group-type + - group-name properties: - metaname: + group-id: type: string - metaval: + 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. - metadata: + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + group-assignments: description: | - Collection of metadatum (key/value pairs) - ###### Default Delete Scope - THIS_NODE_ONLY + Collection of openstack group assignments properties: - metadatum: + group-assignment: type: array items: - $ref: "#/definitions/metadatum" + $ref: "#/definitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + 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" 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM required: - image-id - image-name @@ -37952,327 +49136,522 @@ definitions: 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 + 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: "#/definitions/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 org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) required: - - network-uuid - - network-name - - cvlan-tag + - id + - description + - type properties: - network-uuid: + id: type: string - description: UUID of the network. Unique across a cloud-region - network-name: + description: Instance Group ID, UUID assigned to this instance. + description: type: string - description: Name of the network. - cvlan-tag: - type: integer - format: int64 - description: cvlan-id - ipv4-oam-gateway-address: + description: Descriptive text to help identify the usage of this instance-group + type: 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: 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: + 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: "#/definitions/instance-group" + inventory: properties: - availability-zone-name: + 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/aai-internal" + 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-state: + 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 - 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: "#/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/availability-zone" - cloud-region: + $ref: "#/definitions/inventory-response-item" + ipsec-configuration: 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 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 + 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 org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER required: - - cloud-owner - - cloud-region-id + - ipsec-configuration-id properties: - cloud-owner: + ipsec-configuration-id: type: string - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - cloud-region-id: + description: UUID of this configuration + requested-vig-address-type: type: string - description: Identifier used by the vendor for the region. Second part of composite key - cloud-type: + description: Indicate the type of VIG server like AVPN, INTERNET, BOTH + requested-encryption-strength: type: string - description: Type of the cloud (e.g., openstack) - owner-defined-type: + description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc + requested-dmz-type: type: string - description: Cloud-owner defined type indicator (e.g., dcp, lcp) - cloud-region-version: + description: can offer a shared DMZ or a DMZ specific to a customer + shared-dmz-network-address: type: string - description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. - identity-url: + description: Network address of shared DMZ + requested-customer-name: type: string - description: URL of the keystone identity service - cloud-zone: + description: If the DMZ is a custom DMZ, this field will indicate the customer information + ike-version: type: string - description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. - complex-name: + description: can be 1 or 2 + ikev1-authentication: type: string - description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. + 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, ,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. - 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: + relationship-list: type: array items: - $ref: "#/definitions/snapshot" - images: + $ref: "#/definitions/relationship" + vig-servers: type: array items: - $ref: "#/definitions/image" - dvs-switches: + $ref: "#/definitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: type: array - items: - $ref: "#/definitions/dvs-switch" - oam-networks: + 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + 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. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vlans: type: array items: - $ref: "#/definitions/oam-network" - availability-zones: + $ref: "#/definitions/vlan" + sriov-vfs: type: array items: - $ref: "#/definitions/availability-zone" + $ref: "#/definitions/sriov-vf" relationship-list: type: array items: $ref: "#/definitions/relationship" - cloud-regions: + 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: - cloud-region: + l-interface: type: array items: - $ref: "#/definitions/cloud-region" - network-profile: + $ref: "#/definitions/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 l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) 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: + l3-interface-ipv6-address-list: description: | - Collection of network profiles + IPv6 Address Range + ###### Related Nodes + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + required: + - l3-interface-ipv6-address properties: - network-profile: + 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/network-profile" - p-interface: + items: + $ref: "#/definitions/relationship" + l3-network: description: | - Physical interface (e.g., nic) - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Generic network definition ###### Related Nodes - - TO l-interface (comprises p-interface, Many2Many) - - TO physical-link (Many2Many) - - TO logical-link (Many2One) - - 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) + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET required: - - interface-name + - 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 + 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. - relationship-list: + 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 + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-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 + is-shared-network: + type: boolean + is-external-network: + type: boolean + selflink: + type: string + description: Path to the controller object. + subnets: type: array items: - $ref: "#/definitions/relationship" - l-interfaces: + $ref: "#/definitions/subnet" + ctag-assignments: type: array items: - $ref: "#/definitions/l-interface" - p-interfaces: - description: | - Collection of physical interfaces. + $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: - p-interface: + l3-network: type: array items: - $ref: "#/definitions/p-interface" + $ref: "#/definitions/l3-network" lag-interface: description: | Link aggregate interface - ###### Default Delete Scope - CASCADE_TO_CHILDREN ###### Related Nodes - - 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) + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK required: - interface-name properties: @@ -38316,361 +49695,132 @@ definitions: type: array items: $ref: "#/definitions/lag-interface" - pserver: + 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 tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) 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] 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: + 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: "#/definitions/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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) 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: + 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: "#/definitions/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 org.onap.relationships.inventory.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. - persona-model-id: - type: string - description: the ASDC model id for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - model-version-id: - 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: + 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: "#/definitions/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 - ###### 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 + Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - - TO generic-vnf (Many2Many) - - TO l3-network (Many2Many) - - TO instance-group (Many2Many) - - TO vlan (Many2Many) - - TO tunnel-xconnect (comprises allotted-resource, One2One) - - FROM service-instance (is composed of allotted-resource) - - FROM service-instance + - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) required: - - id + - link-name + - link-type properties: - id: - type: string - description: Allotted Resource id UUID assigned to this instance. - description: + link-name: type: string - description: The descriptive information assigned to this allotted resource instance - selflink: + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + link-type: type: string - description: Link back to more information in the controller - persona-model-id: + description: Type of logical link, e.g., evc + speed-value: type: string - description: the ASDC model id for this resource or service model. - persona-model-version: + description: Captures the numeric part of the speed + speed-units: type: string - description: the ASDC model version for this resource or service model. - model-version-id: + description: Captures the units corresponding to the speed + ip-version: type: string - description: the ASDC model version for this resource or service model. - persona-model-customization-id: + description: v4, v6, or ds for dual stack + routing-protocol: type: string - description: captures the id of all the configuration used to customize the resource for the service. + description: For example, static or BGP resource-version: type: string - description: Concurrency value - 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 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 - 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. + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. persona-model-id: type: string description: the ASDC model id for this resource or service model. @@ -38686,334 +49836,122 @@ 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: - 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: + operational-status: type: string - description: An identifier that customers assign to the location where this service is being used. - resource-version: + description: Indication of operational status of the logical link. + prov-status: type: string - description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - selflink: + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + link-role: type: string - description: Path to the controller object. - orchestration-status: + description: Indication of the network use of the logical link. + link-name2: 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. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO service-instance (comprises service-subscription, Many2Many) - - FROM customer (is composed of service-subscription) - - FROM tenant - required: - - service-type - properties: - service-type: + description: Alias or alternate name (CLCI or D1 name). + link-id: type: string - description: Value defined by orchestration to identify this service across ECOMP. - temp-ub-sub-account-id: + description: UUID of the logical-link, SDNC generates this. + circuit-id: type: string - description: This property will be deleted from A&AI in the near future. Only stop gap solution. - resource-version: + description: Circuit id + purpose: 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" + description: Reason for this entity, role it is playing relationship-list: type: array items: $ref: "#/definitions/relationship" - service-subscriptions: + logical-links: description: | - Collection of objects that group service instances. + Collection of logical connections properties: - service-subscription: + logical-link: type: array items: - $ref: "#/definitions/service-subscription" - customer: - description: | - customer identifiers to provide linkage back to BSS information. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO service-subscription (comprises customer, Many2Many) - 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: + $ref: "#/definitions/logical-link" + metadata: description: | - Collection of customer identifiers to provide linkage back to BSS information. + Collection of metadatum (key/value pairs) properties: - customer: + metadatum: type: array items: - $ref: "#/definitions/customer" - business: - description: | - Namespace for business related constructs - properties: - connectors: - type: array - items: - $ref: "#/definitions/connector" - customers: - type: array - items: - $ref: "#/definitions/customer" - vnf-image: + $ref: "#/definitions/metadatum" + metadatum: 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 + Key/value pairs ###### Related Nodes - - FROM 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" - 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. - ###### Default Delete Scope - ERROR_IF_ANY_IN_EDGES + - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) required: - - service-id - - service-description + - metaname + - metaval 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: + metaname: type: string - description: Description of the service - service-selflink: + metaval: 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" - 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" - service-capability: + model: 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 + Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - - FROM availability-zone - - FROM oam-network + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER required: - - service-type - - vnf-type + - model-invariant-id + - model-type properties: - service-type: + model-invariant-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: Unique identifier corresponding to the main definition of a model in ASDC + model-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. + 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. - 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" - element-choice-set: - description: | - This is how we would capture constraints defining allowed sets of elements. - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO model-element (comprises element-choice-set, One2Many) - - FROM constrained-element-set (is composed of element-choice-set) - 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: + model-vers: type: array items: - $ref: "#/definitions/model-element" + $ref: "#/definitions/model-ver" relationship-list: type: array items: $ref: "#/definitions/relationship" - element-choice-sets: - properties: - element-choice-set: - type: array - items: - $ref: "#/definitions/element-choice-set" - constrained-element-set: + model-and-named-query-search: 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 + ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query properties: - constrained-element-set-uuid: - type: string - constraint-type: - type: string - check-type: + 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 - resource-version: + secondary-filter-cut-point: 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" model-constraint: description: | This is how we would capture constraints defining allowed sets of elements. - ###### Default Delete Scope - CASCADE_TO_CHILDREN ###### Related Nodes - - TO constrained-element-set (comprises model-constraint, One2Many) - - FROM model-element (is composed of model-constraint) + - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET required: - model-constraint-uuid - constrained-element-set-uuid-to-replace @@ -39038,16 +49976,15 @@ definitions: model-element: description: | Defines how other models combine to make up a higher-level model. - ###### Default Delete Scope - CASCADE_TO_CHILDREN ###### 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 element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT required: - model-element-uuid - new-data-del-flag @@ -39089,13 +50026,13 @@ definitions: model-ver: 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 + - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM required: - model-version-id - model-name @@ -39134,37 +50071,6 @@ definitions: type: array items: $ref: "#/definitions/model-ver" - model: - 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 - ###### Related Nodes - - TO model-ver (comprises model, One2Many) - - FROM named-query - - FROM named-query-element - - FROM instance-group - 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" models: description: | Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models @@ -39173,85 +50079,89 @@ definitions: type: array items: $ref: "#/definitions/model" - related-lookup: + multicast-configuration: description: | - TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN ###### Related Nodes - - FROM named-query-element (is composed of related-lookup) + - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) required: - - related-lookup-uuid - - source-node-type - - source-node-property - - target-node-type - - target-node-property + - multicast-configuration-id + - multicast-protocol + - rp-type properties: - related-lookup-uuid: - type: string - source-node-type: - type: string - source-node-property: - type: string - target-node-type: + multicast-configuration-id: type: string - target-node-property: + description: Unique id of multicast configuration. + multicast-protocol: type: string - property-collect-list: + 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" - related-lookups: + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address properties: - related-lookup: + multicast-configuration: type: array items: - $ref: "#/definitions/related-lookup" - property-constraint: + $ref: "#/definitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/definitions/named-query" + named-query: description: | TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN ###### Related Nodes - - FROM named-query-element (is composed of property-constraint) + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT required: - - property-constraint-uuid - - constraint-type - - property-name - - property-value + - named-query-uuid + - named-query-name + - named-query-version properties: - property-constraint-uuid: + named-query-uuid: type: string - constraint-type: + named-query-name: type: string - property-name: + named-query-version: type: string - property-value: + required-input-param: + type: string + description: type: string resource-version: type: string - property-constraints: - properties: - property-constraint: + named-query-elements: type: array - items: - $ref: "#/definitions/property-constraint" + items: + $ref: "#/definitions/named-query-element" + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" 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) + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP required: - named-query-element-uuid properties: @@ -39287,179 +50197,289 @@ definitions: type: array items: $ref: "#/definitions/named-query-element" - named-query: + network: description: | - TBD - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO model (One2Many) - - TO named-query-element (comprises named-query, One2One) - required: - - named-query-uuid - - named-query-name - - named-query-version + Namespace for network inventory resources. 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: + logical-links: type: array items: - $ref: "#/definitions/named-query-element" - relationship-list: + $ref: "#/definitions/logical-link" + site-pair-sets: type: array items: - $ref: "#/definitions/relationship" - named-queries: - properties: - named-query: + $ref: "#/definitions/site-pair-set" + vpn-bindings: type: array - items: - $ref: "#/definitions/named-query" - service-design-and-creation: - description: | - Namespace for objects managed by ASDC - properties: - vnf-images: + items: + $ref: "#/definitions/vpn-binding" + vpls-pes: type: array items: - $ref: "#/definitions/vnf-image" - services: + $ref: "#/definitions/vpls-pe" + multicast-configurations: type: array items: - $ref: "#/definitions/service" - service-capabilities: + $ref: "#/definitions/multicast-configuration" + vces: type: array items: - $ref: "#/definitions/service-capability" - models: + $ref: "#/definitions/vce" + vnfcs: type: array items: - $ref: "#/definitions/model" - named-queries: + $ref: "#/definitions/vnfc" + l3-networks: type: array items: - $ref: "#/definitions/named-query" - logical-link: + $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" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/definitions/network-policy" + network-policy: 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 p-interface - - FROM service-instance - - FROM virtual-data-center - - FROM vlan - - FROM logical-link + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) required: - - link-name - - link-type + - network-policy-id properties: - link-name: + network-policy-id: type: string - description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ - link-type: + description: UUID representing unique key to this instance + network-policy-fqdn: type: string - description: Type of logical link, e.g., evc - speed-value: + description: Contrail FQDN for the policy + heat-stack-id: type: string - description: Captures the numeric part of the speed - speed-units: + description: ID for the openStack Heat instance + resource-version: type: string - description: Captures the units corresponding to the speed - ip-version: + 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 org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + required: + - nm-profile-name + properties: + nm-profile-name: type: string - description: v4, v6, or ds for dual stack - routing-protocol: + description: Unique name of network profile. + community-string: type: string - description: For example, static or BGP + description: Encrypted SNMP community string resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - persona-model-id: - type: string - description: the ASDC model id for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - model-version-id: + 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 org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + required: + - vnf-id2 + - vnf-name + - vnf-type + properties: + vnf-id2: type: string - description: the ASDC model version for this resource or service model. - widget-model-id: + description: Unique id of VNF, can't use same attribute name right now until we promote this new object + vnf-name: type: string - description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. - widget-model-version: + description: Name of VNF. + vnf-name2: 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: Alternate name of VNF. + vnf-type: type: string - description: Indication of operational status of the logical link. + 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. - link-role: + operational-state: type: string - description: Indication of the network use of the logical link. - link-name2: + description: Indicator for whether the resource is considered operational + license-key: type: string - description: Alias or alternate name (CLCI or D1 name). - link-id: + description: OBSOLETE - do not use + ipv4-oam-address: type: string - description: UUID of the logical-link, SDNC generates this. - circuit-id: + description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address). + equipment-role: type: string - description: Circuit id - purpose: + description: Client should send valid enumerated value. + resource-version: type: string - description: Reason for this entity, role it is playing + 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" - logical-links: + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + newvces: description: | - Collection of logical connections + This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. properties: - logical-link: + newvce: type: array items: - $ref: "#/definitions/logical-link" - class-of-service: + $ref: "#/definitions/newvce" + 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: | - ###### Default Delete Scope - THIS_NODE_ONLY + OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - - FROM site-pair (is composed of class-of-service) + - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) required: - - cos + - network-uuid + - network-name + - cvlan-tag properties: - cos: + network-uuid: type: string - description: unique identifier of probe - probe-id: + description: UUID of the network. Unique across a cloud-region + network-name: type: string - description: identifier of probe - probe-type: + description: Name of the network. + cvlan-tag: + type: integer + format: int64 + description: cvlan-id + ipv4-oam-gateway-address: type: string - description: type of probe + 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. @@ -39467,164 +50487,172 @@ definitions: type: array items: $ref: "#/definitions/relationship" - classes-of-service: + oam-networks: description: | - class-of-service of probe + Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. properties: - class-of-service: + oam-network: type: array items: - $ref: "#/definitions/class-of-service" - site-pair: + $ref: "#/definitions/oam-network" + operational-environment: description: | - ###### 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 class-of-service (comprises site-pair, Many2Many) - - FROM routing-instance (is composed of site-pair) + - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) required: - - site-pair-id + - operational-environment-id + - operational-environment-name + - operational-environment-type + - operational-environment-status + - tenant-context + - workload-context properties: - site-pair-id: + operational-environment-id: type: string - description: unique identifier of probe - source-ip: + description: UUID of an operational environment + operational-environment-name: type: string - description: Prefix address - destination-ip: + description: Operational Environment name + operational-environment-type: type: string - description: Prefix address - ip-version: + description: Operational Environment Type. + operational-environment-status: type: string - description: ip version, v4, v6 - destination-hostname: + description: Status + tenant-context: type: string - description: Hostname of the destination equipment to which SLAs are measured against. - destination-equip-type: + description: Tenant Context. + workload-context: type: string - description: The type of destinatination equipment. Could be Router, etc. + description: Workload Context. 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: + operational-environments: description: | - probe within a set + a logical partition of the cloud which allows to have multiple environments in the production AIC. properties: - site-pair: + operational-environment: type: array items: - $ref: "#/definitions/site-pair" - routing-instance: + $ref: "#/definitions/operational-environment" + overloaded-model: description: | - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO site-pair (comprises routing-instance, Many2Many) - - FROM site-pair-set (is composed of routing-instance) + Allows for legacy POST of old-style and new-style models required: - - routing-instance-id + - model-invariant-id + - model-name-version-id + - model-type + - model-name + - model-id + - model-version properties: - routing-instance-id: + model-invariant-id: type: string - description: Unique id of routing instance - rpm-owner: + description: Unique identifier corresponding to the main definition of a model in ASDC + model-name-version-id: type: string - description: rpm owner + 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. - site-pairs: - type: array - items: - $ref: "#/definitions/site-pair" + model-vers: + type: object + $ref: "#/definitions/model-vers" relationship-list: - type: array - items: - $ref: "#/definitions/relationship" - routing-instances: + type: object + $ref: "#/definitions/relationship-list" + owning-entities: description: | - set of probes related to generic-vnf routing instance + Collection of owning-entities properties: - routing-instance: + owning-entity: type: array items: - $ref: "#/definitions/routing-instance" - site-pair-set: + $ref: "#/definitions/owning-entity" + owning-entity: description: | - Set of instances for probes used to measure service level agreements - ###### Default Delete Scope - CASCADE_TO_CHILDREN + describes an owning-entity ###### Related Nodes - - TO routing-instance (comprises site-pair-set, Many2Many) - - FROM generic-vnf + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE) required: - - site-pair-set-id + - owning-entity-id + - owning-entity-name properties: - site-pair-set-id: + owning-entity-id: type: string - description: Unique id of site pair set. + 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. - 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" - vpn-binding: + p-interface: description: | - VPN binding - ###### Default Delete Scope - ERROR_4_IN_EDGES_OR_CASCADE + Physical interface (e.g., nic) ###### Related Nodes - - FROM l3-network - - FROM logical-link + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK required: - - vpn-id - - vpn-name - - global-route-target - - route-target-role + - interface-name properties: - vpn-id: + interface-name: type: string - description: VPN ID, globally unique within A&AI - vpn-name: + description: Name that identifies the physical interface + speed-value: type: string - description: VPN Name - global-route-target: + description: Captures the numeric part of the speed + speed-units: type: string - description: Number used to identify a VPN, globally unique in the network - vpn-platform: + description: Captures the units corresponding to the speed + port-description: type: string - description: the platform associated with the VPN example AVPN, Mobility - vpn-type: + description: Nature of the services and connectivity on this port. + equipment-identifier: type: string - description: Type of the vpn, should be taken from enumerated/valid values - route-distinguisher: + description: CLEI or other specification for p-interface hardware. + interface-role: type: string - description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. - route-target-role: + description: Role specification for p-interface hardware. + interface-type: type: string - description: Role assigned to this route target + description: Indicates the physical properties of the interface. + prov-status: + type: string + description: Trigger for operational monitoring of this resource by Service Assurance systems. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -39632,41 +50660,47 @@ definitions: type: array items: $ref: "#/definitions/relationship" - description: l3-networks relate to vpn-bindings - vpn-bindings: + l-interfaces: + type: array + items: + $ref: "#/definitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. properties: - vpn-binding: + p-interface: type: array items: - $ref: "#/definitions/vpn-binding" - vpls-pe: + $ref: "#/definitions/p-interface" + physical-link: description: | - VPLS Provider Edge routers. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Collection of physical connections, typically between p-interfaces ###### Related Nodes - - TO complex (Many2Many) - - TO ctag-pool (Many2Many) - - TO p-interface (comprises vpls-pe, Many2Many) - - TO lag-interface (comprises vpls-pe, Many2Many) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) required: - - equipment-name + - link-name properties: - equipment-name: + link-name: type: string - prov-status: + description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ + speed-value: type: string - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - ipv4-oam-address: + description: Captures the numeric part of the speed + speed-units: type: string - description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address). - equipment-role: + description: Captures the units corresponding to the speed + circuit-id: 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: 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. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -39674,86 +50708,148 @@ definitions: 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: + physical-links: description: | - Collection of VPLS Provider Edge routers + Collection of physical connections, typically between p-interfaces properties: - vpls-pe: + physical-link: type: array items: - $ref: "#/definitions/vpls-pe" - multicast-configuration: + $ref: "#/definitions/physical-link" + platform: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + describes a platform ###### Related Nodes - - FROM vlan + - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY) required: - - multicast-configuration-id - - multicast-protocol - - rp-type + - platform-name properties: - multicast-configuration-id: - type: string - description: Unique id of multicast configuration. - multicast-protocol: + platform-name: type: string - description: protocol of multicast configuration - rp-type: - type: string - description: rp type of multicast configuration - resource-version: + 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" - multicast-configurations: + platforms: description: | - multicast configuration of generic-vnf ip-address + Collection of platforms properties: - multicast-configuration: + platform: type: array items: - $ref: "#/definitions/multicast-configuration" - cvlan-tag-entry: + $ref: "#/definitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE required: - - cvlan-tag + - pnf-name + - in-maint properties: - cvlan-tag: - type: integer - format: int64 - description: See mis-na-virtualization-platform.yang + 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 company 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: + 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" - cvlan-tags: + 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: - cvlan-tag-entry: + pnf: type: array items: - $ref: "#/definitions/cvlan-tag-entry" + $ref: "#/definitions/pnf" port-group: 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) + - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG required: - interface-id - orchestration-status @@ -39805,297 +50901,348 @@ definitions: type: array items: $ref: "#/definitions/port-group" - license: + project: description: | - Metadata for license group. - ###### Default Delete Scope - THIS_NODE_ONLY + describes the project ###### Related Nodes - - FROM generic-vnf (is composed of license) - - FROM vce (is composed of license) + - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY) required: - - group-uuid - - resource-uuid + - project-name properties: - group-uuid: - type: string - description: Unique ID for the license group the resource belongs to, should be uuid. - resource-uuid: + project-name: type: string - description: Unique ID of a license resource. + description: Name of the project deploying a service 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" - licenses: + projects: description: | - Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management + Collection of projects properties: - license: + project: type: array items: - $ref: "#/definitions/license" - entitlement: + $ref: "#/definitions/project" + properties: description: | - Metadata for entitlement group. - ###### Default Delete Scope - THIS_NODE_ONLY + Property holder for query properties or instance properties + properties: + property-name: + type: string + property-value: + type: string + property-constraint: + description: | + TBD ###### Related Nodes - - FROM generic-vnf (is composed of entitlement) - - FROM vce (is composed of entitlement) + - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) required: - - group-uuid - - resource-uuid + - property-constraint-uuid + - constraint-type + - property-name + - property-value properties: - group-uuid: + property-constraint-uuid: type: string - description: Unique ID for the entitlement group the resource comes from, should be uuid. - resource-uuid: + constraint-type: + type: string + property-name: + type: string + property-value: 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 + property-constraints: properties: - entitlement: + property-constraint: type: array items: - $ref: "#/definitions/entitlement" - vce: + $ref: "#/definitions/property-constraint" + pserver: description: | - Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. - ###### 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 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 group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT required: - - vnf-id - - vnf-name - - vnf-type + - hostname + - in-maint properties: - vnf-id: + hostname: type: string - description: Unique id of VNF. This is unique across the graph. - vnf-name: + description: Value from executing hostname on the compute node. + ptnii-equip-name: type: string - description: Name of VNF. - vnf-name2: + 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: Alternate name of VNF. - vnf-type: + description: Equipment type. Source of truth should define valid values. + equip-vendor: 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: Equipment vendor. Source of truth should define valid values. + equip-model: type: string - description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. - regional-resource-zone: + description: Equipment model. Source of truth should define valid values. + fqdn: type: string - description: Regional way of organizing pservers, source of truth should define values - prov-status: + description: Fully-qualified domain name + pserver-selflink: type: string - description: Trigger for operational monitoring of this resource by Service Assurance systems. - operational-state: + description: URL to endpoint where AAI can get more details + ipv4-oam-address: type: string - description: Indicator for whether the resource is considered operational - license-key: + description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. + serial-number: type: string - description: OBSOLETE - do not use - equipment-role: + description: Serial number, may be queried + ipaddress-v4-loopback-0: type: string - description: Network role being played by this VNF - orchestration-status: + description: IPV4 Loopback 0 address + ipaddress-v6-loopback-0: type: string - description: Orchestration status of this VNF, mastered by MSO - heat-stack-id: + description: IPV6 Loopback 0 address + ipaddress-v4-aim: type: string - description: Heat stack id corresponding to this instance, managed by MSO - mso-catalog-key: + description: IPV4 AIM address + ipaddress-v6-aim: type: string - description: Corresponds to the SDN-C catalog id used to configure this VCE - vpe-id: + description: IPV6 AIM address + ipaddress-v6-oam: type: string - description: Unique ID of VPE connected to this VCE. - v6-vce-wan-address: + description: IPV6 OAM address + inv-status: type: string - description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. - ipv4-oam-address: + description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. + pserver-id: type: string - description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. + description: ID of Pserver + internet-topology: + type: string + description: internet topology of Pserver + in-maint: + type: boolean resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - ipv4-loopback0-address: + pserver-name2: type: string - description: Loopback0 address - entitlement-resource-uuid: + description: alternative pserver name + purpose: type: string - description: OBSOLETE - see child relationships - port-groups: - type: array - items: - $ref: "#/definitions/port-group" - licenses: + description: purpose of pserver + prov-status: + type: string + description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] + relationship-list: type: array items: - $ref: "#/definitions/license" - entitlements: + $ref: "#/definitions/relationship" + p-interfaces: type: array items: - $ref: "#/definitions/entitlement" - relationship-list: + $ref: "#/definitions/p-interface" + lag-interfaces: type: array items: - $ref: "#/definitions/relationship" - vces: + $ref: "#/definitions/lag-interface" + pservers: description: | - Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + Collection of compute hosts. properties: - vce: + pserver: type: array items: - $ref: "#/definitions/vce" - vnfc: + $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: | - ###### Default Delete Scope - THIS_NODE_ONLY + TBD ###### Related Nodes - - FROM vserver - - FROM vf-module - - FROM generic-vnf + - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) required: - - vnfc-name - - vnfc-function-code - - vnfc-type - - in-maint - - is-closed-loop-disabled + - related-lookup-uuid + - source-node-type + - source-node-property + - target-node-type + - target-node-property properties: - vnfc-name: - type: string - description: Unique ID of vnfc. - vnfc-function-code: + related-lookup-uuid: type: string - description: function code - vnfc-type: + source-node-type: type: string - description: type - prov-status: + source-node-property: type: string - description: prov status of this vnfc - orchestration-status: + target-node-type: type: string - description: Orchestration status of this VNF, mastered by APP-C - ipaddress-v4-oam-vip: + target-node-property: type: string - description: Oam V4 vip address of this vnfc - in-maint: - type: boolean - is-closed-loop-disabled: - type: boolean - group-notation: + property-collect-list: type: string - description: Group notation of VNFC 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" - vnfcs: - description: | - virtual network components associated with a vserver from application controller. + related-lookups: properties: - vnfc: + related-lookup: type: array items: - $ref: "#/definitions/vnfc" - subnet: - 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) + $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: - - subnet-id - - dhcp-enabled + - relationship-key + - relationship-value properties: - subnet-id: + relationship-key: type: string - description: Subnet ID, should be UUID. - subnet-name: + description: A keyword provided by A&AI to indicate an attribute. + relationship-value: type: string - description: Name associated with the subnet. - neutron-subnet-id: + 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 - description: Neutron id of this subnet - gateway-address: + aai-node-type: type: string - description: gateway ip address - network-start-address: + aai-created-ts: + type: integer + format: int64 + aai-unique-key: type: string - description: network start address - cidr-mask: + aai-last-mod-ts: + type: integer + format: int64 + source-of-truth: type: string - description: cidr mask - ip-version: + aai-uri: type: string - description: ip version - orchestration-status: + 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: Orchestration status of this VNF, mastered by MSO - dhcp-enabled: - type: boolean - dhcp-start: + description: The specific type of node in the A&AI graph + resource-link: type: string - description: the start address reserved for use by dhcp - dhcp-end: + description: The URL to the specific resource + route-table-reference: + description: | + Openstack route table reference. + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + required: + - route-table-reference-id + - route-table-reference-fqdn + properties: + route-table-reference-id: type: string - description: the last address reserved for use by dhcp + 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. + description: Concurrency value relationship-list: type: array items: $ref: "#/definitions/relationship" - subnets: + route-table-references: + description: | + Collection of openstack route table references properties: - subnet: + route-table-reference: type: array items: - $ref: "#/definitions/subnet" - ctag-assignment: + $ref: "#/definitions/route-table-reference" + route-target: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + Route target information ###### Related Nodes - - FROM l3-network (is composed of ctag-assignment) - - FROM service-instance + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) required: - - vlan-id-inner + - global-route-target + - route-target-role properties: - vlan-id-inner: - type: integer - format: int64 - description: id. + 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. @@ -40103,389 +51250,235 @@ definitions: type: array items: $ref: "#/definitions/relationship" - ctag-assignments: + route-targets: + description: | + Collection of route target information properties: - ctag-assignment: + route-target: type: array items: - $ref: "#/definitions/ctag-assignment" - segmentation-assignment: + $ref: "#/definitions/route-target" + routing-instance: description: | - Openstack segmentation assignment. - ###### Default Delete Scope - THIS_NODE_ONLY ###### Related Nodes - - FROM l3-network (is composed of segmentation-assignment) + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR required: - - segmentation-id + - routing-instance-id properties: - segmentation-id: + routing-instance-id: type: string - description: Route Table Reference id, UUID assigned to this instance. + description: Unique id of routing instance + rpm-owner: + type: string + description: rpm owner resource-version: type: string - description: Concurrency value + 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" - segmentation-assignments: + routing-instances: description: | - Collection of openstack segmentation assignments + set of probes related to generic-vnf routing instance properties: - segmentation-assignment: + routing-instance: type: array items: - $ref: "#/definitions/segmentation-assignment" - l3-network: - description: | - Generic network definition - ###### Default Delete Scope - CASCADE_TO_CHILDREN - ###### Related Nodes - - TO vpn-binding (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 - required: - - network-id - - network-name - - is-bound-to-vpn - - is-provider-network - - is-shared-network - - is-external-network + $ref: "#/definitions/routing-instance" + sdn-zone-response: 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: - 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 - persona-model-id: - type: string - description: the ASDC model id for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - model-version-id: - type: string - description: the ASDC model version for this resource or service model. - persona-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: + 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 - description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. - physical-network-name: + filter-type: 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: + property-value: type: string - description: Path to the controller object. - 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: + secondary-filts: + description: | + SecondaryFilts for performing a named-query or model query properties: - l3-network: + secondary-filt: type: array items: - $ref: "#/definitions/l3-network" - network-policy: + $ref: "#/definitions/secondary-filt" + segmentation-assignment: description: | - ###### Default Delete Scope - THIS_NODE_ONLY + Openstack segmentation assignment. ###### Related Nodes - - FROM l3-network + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) required: - - network-policy-id + - segmentation-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: + segmentation-id: type: string - description: ID for the openStack Heat instance + description: Route Table Reference id, UUID assigned to this instance. 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" - network-policies: + segmentation-assignments: + description: | + Collection of openstack segmentation assignments properties: - network-policy: + segmentation-assignment: type: array items: - $ref: "#/definitions/network-policy" - vf-module: + $ref: "#/definitions/segmentation-assignment" + service: description: | - a deployment unit of VNFCs - ###### Default Delete Scope - THIS_NODE_ONLY - ###### Related Nodes - - TO volume-group (One2One) - - TO l3-network (Many2Many) - - TO vnfc (One2Many) - - FROM vserver - - FROM generic-vnf (is composed of vf-module) + Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. required: - - vf-module-id - - is-base-vf-module + - service-id + - service-description properties: - vf-module-id: - type: string - description: Unique ID of vf-module. - vf-module-name: + service-id: type: string - description: Name of vf-module - heat-stack-id: + description: This gets defined by others to provide a unique ID for the service, we accept what is sent. + service-description: type: string - description: Heat stack id corresponding to this instance. - orchestration-status: + description: Description of the service + service-selflink: type: string - description: orchestration status of this vf-module, mastered by MSO - is-base-vf-module: - type: boolean + 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. - persona-model-id: - type: string - description: the ASDC model id for this resource or service model. - persona-model-version: - type: string - description: the ASDC model version for this resource or service model. - model-version-id: - type: string - description: the ASDC model version for this resource or service model. - persona-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: + service-version: type: string - description: Path to the controller object. + description: service version relationship-list: type: array items: $ref: "#/definitions/relationship" - vf-modules: + service-capabilities: description: | - Collection of vf-modules, a deployment unit of VNFCs + Collection of service capabilities. properties: - vf-module: + service-capability: type: array items: - $ref: "#/definitions/vf-module" - generic-vnf: + $ref: "#/definitions/service-capability" + service-capability: 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 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) - - FROM virtual-data-center - - FROM logical-link - - FROM allotted-resource + 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 org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK required: - - vnf-id - - vnf-name + - service-type - 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-name: - type: string - description: Name of VNF. - vnf-name2: + service-type: type: string - description: Alternate name of VNF. + 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-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-state: - 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. - 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 company 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 in some usecases - vcpu-units: - type: string - description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases - 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 in some usecases - vmemory-units: - type: string - description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases - 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 in some usecases - vdisk-units: - type: string - description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases - in-maint: - type: boolean - is-closed-loop-disabled: - type: boolean resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. - summary-status: + 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 org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - service-instance-id + properties: + service-instance-id: 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 + 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. persona-model-id: type: string description: the ASDC model id for this resource or service model. @@ -40495,288 +51488,223 @@ definitions: model-version-id: type: string description: the ASDC model version for this resource or service model. - persona-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: + bandwidth-total: type: string - description: as-number of the VNF - regional-resource-subzone: + description: Indicates the total bandwidth to be used for this service. + bandwidth-up-wan1: type: string - description: represents sub zone of the rr plane + 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" - 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: + metadata: type: array items: - $ref: "#/definitions/license" - entitlements: + $ref: "#/definitions/metadatum" + allotted-resources: type: array items: - $ref: "#/definitions/entitlement" - generic-vnfs: + $ref: "#/definitions/allotted-resource" + service-instances: description: | - Collection of VNFs + Collection of service instances properties: - generic-vnf: + service-instance: type: array items: - $ref: "#/definitions/generic-vnf" - lag-link: + $ref: "#/definitions/service-instance" + service-subscription: description: | - LAG links can connect lag-interfaces - ###### Default Delete Scope - THIS_NODE_ONLY + Object that group service instances. ###### Related Nodes - - FROM lag-interface - - FROM logical-link + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE required: - - link-name + - service-type properties: - link-name: + service-type: type: string - description: Alphabetical concatenation of lag-interface names + 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" - lag-links: + service-subscriptions: description: | - Collection of link aggregation connections + Collection of objects that group service instances. properties: - lag-link: + service-subscription: type: array items: - $ref: "#/definitions/lag-link" - newvce: + $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: | - 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 ###### Related Nodes - - TO l-interface (comprises newvce, Many2Many) + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE required: - - vnf-id2 - - vnf-name - - vnf-type + - site-pair-id 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: + site-pair-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. - prov-status: + description: unique identifier of probe + source-ip: type: string - description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. - operational-state: + description: Prefix address + destination-ip: type: string - description: Indicator for whether the resource is considered operational - license-key: + description: Prefix address + ip-version: type: string - description: OBSOLETE - do not use - ipv4-oam-address: + description: ip version, v4, v6 + destination-hostname: type: string - description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address). - equipment-role: + description: Hostname of the destination equipment to which SLAs are measured against. + destination-equip-type: type: string - description: Client should send valid enumerated value. + description: The type of destinatination equipment. Could be Router, etc. 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: + classes-of-service: type: array items: - $ref: "#/definitions/relationship" - l-interfaces: + $ref: "#/definitions/class-of-service" + relationship-list: 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: + $ref: "#/definitions/relationship" + site-pair-set: description: | - PNF represents a physical network function. typically equipment used in the D1 world. - ###### Default Delete Scope - CASCADE_TO_CHILDREN + Set of instances for probes used to measure service level agreements ###### 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 logical-link - - FROM service-instance + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE required: - - pnf-name - - in-maint + - site-pair-set-id properties: - pnf-name: + site-pair-set-id: 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 company 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: - 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: + 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. - 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: + routing-instances: type: array items: - $ref: "#/definitions/relationship" - p-interfaces: + $ref: "#/definitions/routing-instance" + relationship-list: type: array items: - $ref: "#/definitions/p-interface" - lag-interfaces: + $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/lag-interface" - pnfs: + items: + $ref: "#/definitions/site-pair-set" + site-pairs: description: | - Collection of Physical Network Functions. + probe within a set properties: - pnf: + site-pair: type: array items: - $ref: "#/definitions/pnf" - physical-link: + $ref: "#/definitions/site-pair" + snapshot: description: | - Collection of physical connections, typically between p-interfaces - ###### Default Delete Scope - THIS_NODE_ONLY + Openstack snapshot ###### Related Nodes - - FROM p-interface + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) required: - - link-name + - snapshot-id properties: - link-name: + snapshot-id: type: string - description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ - speed-value: + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + snapshot-name: type: string - description: Captures the numeric part of the speed - speed-units: + description: Snapshot name + snapshot-architecture: type: string - description: Captures the units corresponding to the speed - circuit-id: + description: Operating system architecture + snapshot-os-distro: type: string - description: Circuit it - dual-mode: + description: The common name of the operating system distribution in lowercase + snapshot-os-version: type: string - description: Dual access mode (e.g., primary, secondary - management-option: + description: The operating system version as specified by the distributor. + application: type: string - description: To provide information on who manages this circuit. A&AI or 3rd party transport provider - service-provider-name: + description: The application that the image instantiates. + application-vendor: type: string - description: Name of the service Provider on this link. + 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. @@ -40784,33 +51712,26 @@ definitions: type: array items: $ref: "#/definitions/relationship" - physical-links: + snapshots: description: | - Collection of physical connections, typically between p-interfaces + Collection of openstack snapshots properties: - physical-link: + snapshot: type: array items: - $ref: "#/definitions/physical-link" - vig-server: + $ref: "#/definitions/snapshot" + sriov-pf: 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 + SR-IOV Physical Function ###### Related Nodes - - FROM ipsec-configuration (is composed of vig-server) + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) required: - - vig-address-type + - pf-pci-id 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: + pf-pci-id: type: string - description: v6 IP of the vig server + 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. @@ -40818,86 +51739,125 @@ definitions: type: array items: $ref: "#/definitions/relationship" - vig-servers: + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. properties: - vig-server: + sriov-pf: type: array items: - $ref: "#/definitions/vig-server" - ipsec-configuration: + $ref: "#/definitions/sriov-pf" + sriov-vf: 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 + SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - - TO vig-server (comprises ipsec-configuration, One2Many) - - FROM generic-vnf + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) required: - - ipsec-configuration-id + - pci-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: + pci-id: type: string - description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc - requested-dmz-type: + description: PCI ID used to identify the sriov-vf + vf-vlan-filter: type: string - description: can offer a shared DMZ or a DMZ specific to a customer - shared-dmz-network-address: + 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: Network address of shared DMZ - requested-customer-name: + 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: If the DMZ is a custom DMZ, this field will indicate the customer information - ike-version: + 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: can be 1 or 2 - ikev1-authentication: + 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: Contains values like md5, sha1, sha256, sha384 - ikev1-encryption: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + neutron-network-id: type: string - description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc - ikev1-dh-group: + 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 - description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 - ikev1-am-group-id: + property-value: type: string - description: Group name defined in VIG for clients using aggressive mode - ikev1-am-password: + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + required: + - subnet-id + - dhcp-enabled + properties: + subnet-id: type: string - description: pre-shared key for the above group name - ikev1-sa-lifetime: + description: Subnet ID, should be UUID. + subnet-name: type: string - description: Lifetime for IKEv1 SA - ipsec-authentication: + description: Name associated with the subnet. + neutron-subnet-id: type: string - description: md5, sha1, sha256, sha384 - ipsec-encryption: + description: Neutron id of this subnet + gateway-address: type: string - description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc - ipsec-sa-lifetime: + description: gateway ip address + network-start-address: type: string - description: Life time for IPSec SA - ipsec-pfs: + description: network start address + cidr-mask: type: string - description: enable PFS or not - xauth-userid: + description: cidr mask + ip-version: type: string - description: user ID for xAuth, sm-user, ,nmteHostName - xauth-user-password: + description: ip version + orchestration-status: type: string - description: Encrypted using the Juniper $9$ algorithm - dpd-interval: + description: Orchestration status of this VNF, mastered by MSO + dhcp-enabled: + type: boolean + dhcp-start: type: string - description: The time between DPD probe - dpd-frequency: + description: the start address reserved for use by dhcp + dhcp-end: type: string - description: Maximum number of DPD before claiming the tunnel is down + description: the last address reserved for use by dhcp resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -40905,76 +51865,85 @@ definitions: type: array items: $ref: "#/definitions/relationship" - vig-servers: + subnets: + properties: + subnet: type: array - items: - $ref: "#/definitions/vig-server" - ipsec-configurations: + items: + $ref: "#/definitions/subnet" + tagged-inventory-item-list: properties: - ipsec-configuration: + inventory-item: type: array items: - $ref: "#/definitions/ipsec-configuration" - route-table-reference: + $ref: "#/definitions/inventory-item" + tenant: description: | - Openstack route table reference. - ###### Default Delete Scope - THIS_NODE_ONLY + Openstack tenant ###### Related Nodes - - FROM l3-network + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked to VSERVER required: - - route-table-reference-id - - route-table-reference-fqdn + - tenant-id + - tenant-name properties: - route-table-reference-id: + tenant-id: type: string - description: Route Table Reference id, UUID assigned to this instance. - route-table-reference-fqdn: + description: Unique id relative to the cloud-region. + tenant-name: type: string - description: FQDN entry in the route table. + description: Readable name of tenant resource-version: type: string - description: Concurrency value + 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" - route-table-references: + tenants: description: | - Collection of openstack route table references + Collection of openstack tenants. properties: - route-table-reference: + tenant: type: array items: - $ref: "#/definitions/route-table-reference" - instance-group: + $ref: "#/definitions/tenant" + tunnel-xconnect: description: | - General mechanism for grouping instances - ###### Default Delete Scope - THIS_NODE_ONLY + Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - - TO model (Many2Many) - - FROM pnf - - FROM allotted-resource - - FROM generic-vnf - - FROM service-instance + - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) required: - id - - description - - type + - bandwidth-up-wan1 + - bandwidth-down-wan1 + - bandwidth-up-wan2 + - bandwidth-down-wan2 properties: id: type: string - description: Instance Group ID, UUID assigned to this instance. - description: + description: Allotted Resource id UUID assigned to this instance. + bandwidth-up-wan1: type: string - description: Descriptive text to help identify the usage of this instance-group - type: + description: The WAN uplink bandwidth for WAN1 + bandwidth-down-wan1: type: string - description: Only valid value today is lower case ha for high availability - sub-type: + description: The WAN downlink bandwidth for WAN1 + bandwidth-up-wan2: type: string - description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby] + 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 @@ -40982,537 +51951,9925 @@ definitions: type: array items: $ref: "#/definitions/relationship" - instance-groups: + tunnel-xconnects: description: | - Collection of openstack route table references + This object is used to store the specific tunnel cross connect aspects of an allotted resource properties: - instance-group: + tunnel-xconnect: type: array items: - $ref: "#/definitions/instance-group" - zone: + $ref: "#/definitions/tunnel-xconnect" + update: 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 + 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 complex (Many2One) - - FROM cloud-region - - FROM pserver - - FROM pnf + - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP required: - - zone-id - - zone-name - - design-type - - zone-context + - vnf-id + - vnf-name + - vnf-type properties: - zone-id: + vnf-id: type: string - description: Code assigned by AIC to the zone - zone-name: + description: Unique id of VNF. This is unique across the graph. + vnf-name: type: string - description: English name associated with the zone - design-type: + description: Name of VNF. + vnf-name2: type: string - description: Design of zone [Medium/Large?] - zone-context: + description: Alternate name of VNF. + vnf-type: type: string - description: Context of zone [production/test] - status: + 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: Status of a zone. + 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-state: + 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: 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: + 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/site-pair-set" - vpn-bindings: + $ref: "#/definitions/port-group" + licenses: type: array items: - $ref: "#/definitions/vpn-binding" - vpls-pes: + $ref: "#/definitions/license" + entitlements: type: array items: - $ref: "#/definitions/vpls-pe" - multicast-configurations: + $ref: "#/definitions/entitlement" + relationship-list: type: array items: - $ref: "#/definitions/multicast-configuration" - vces: + $ref: "#/definitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. + properties: + vce: type: array - items: + 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: + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - VF-MODULE cannot be deleted if linked 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 + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-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 org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + 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-id: + 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. + 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 org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + required: + - vnfc-name + - vnfc-function-code + - vnfc-type + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + vnfc-function-code: + type: string + description: function code + vnfc-type: + type: string + description: type + 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 + 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" + 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 tosca.relationships.AttachesTo volume) + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.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 + persona-model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-persona-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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + 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 VPE (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 l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK + required: + - vpn-id + - vpn-name + - global-route-target + - route-target-role + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + global-route-target: + type: string + description: Number used to identify a VPN, globally unique in the network + 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 + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS 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" + 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 org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + 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 + is-closed-loop-disabled: + type: boolean + 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.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: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + 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 generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + 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 + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked 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-state: + 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" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + required: + - cloud-owner + - cloud-region-id + 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. + 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 org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + 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 org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - CONFIGURATION is DELETED when these are DELETED METADATUM + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + 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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + 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 org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + 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 org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.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 + isParent: + type: boolean + usesResource: + type: boolean + hasDelTarget: + type: boolean + SVC-INFRA: + type: boolean + SVC-INFRA-REV: + type: boolean + 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 org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + 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 + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + 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 esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + 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 + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + 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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + 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 + extra-property: + properties: + property-name: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked 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 org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + 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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + 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 org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + 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 org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + 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-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-state: + 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. + 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 company 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 in some usecases + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases + 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 in some usecases + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases + 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 in some usecases + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + 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" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + 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 org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - id + - description + - type + properties: + 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" + business: + type: object + $ref: "#/patchDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/patchDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/patchDefinitions/network" + aai-internal: + type: object + $ref: "#/patchDefinitions/aai-internal" + nodes: + type: array + items: + $ref: "#/patchDefinitions/aai-internal" + 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 org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + 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: 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, ,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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + 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. + 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 l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + 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 l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + 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 network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + 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 + 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + required: + - interface-name + 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 tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + required: + - link-name + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + 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 connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + 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 org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + 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 org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + 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 org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + 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 org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + 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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + 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" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/patchDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + 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-state: + 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 VPE (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" + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.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 org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.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 org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + 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. + 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 tosca.relationships.network.LinksTo physical-link, MANY2ONE) + 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. + 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 org.onap.relationships.inventory.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. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + 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 company 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: + 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 org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + 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 org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to 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 + 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 org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + 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 org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + 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 org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + 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 org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked 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 org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + 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. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + 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 org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + 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, etc. + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + 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 org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-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 + 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 + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked 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 + 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 org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + 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 org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + 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-state: + 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - VF-MODULE cannot be deleted if linked 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 + 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 org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.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 + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.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 tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + 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 org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + required: + - vnfc-name + - vnfc-function-code + - vnfc-type + - in-maint + - is-closed-loop-disabled + properties: + vnfc-name: + type: string + description: Unique ID of vnfc. + vnfc-function-code: + type: string + description: function code + vnfc-type: + type: string + description: type + 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 + 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 tosca.relationships.AttachesTo volume) + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.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 + persona-model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + vf-module-persona-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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + 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 VPE (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 l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK + required: + - vpn-id + - vpn-name + - global-route-target + - route-target-role + properties: + vpn-id: + type: string + description: VPN ID, globally unique within A&AI + vpn-name: + type: string + description: VPN Name + global-route-target: + type: string + description: Number used to identify a VPN, globally unique in the network + 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 + route-distinguisher: + type: string + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + route-target-role: + type: string + description: Role assigned to this route target + 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 org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + 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 + is-closed-loop-disabled: + type: boolean + 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.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: + aai-internal: + properties: + property-name: + type: string + property-value: + type: string + 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: "#/getDefinitions/update" + notify: + type: object + $ref: "#/getDefinitions/notify" + allotted-resource: + description: | + Represents a slice or partial piece of a resource that gets separately allotted + ###### Related Nodes + - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT + 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 + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-model-customization-id: + type: string + description: captures the id of all the configuration used to customize the resource for the service. + resource-version: + type: string + description: Concurrency value + 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: + 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 org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - AVAILABILITY-ZONE cannot be deleted if linked 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-state: + 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: + 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" + class-of-service: + description: | + ###### Related Nodes + - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + 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: "#/getDefinitions/relationship" + classes-of-service: + description: | + class-of-service of probe + properties: + class-of-service: + type: array + items: + $ref: "#/getDefinitions/class-of-service" + cloud-infrastructure: + description: | + Namespace for cloud infrastructure. + properties: + complexes: + type: array + 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: | + cloud-region designates an installation of a cloud cluster or region or instantiation. + ###### Related Nodes + - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP + - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE + required: + - cloud-owner + - cloud-region-id + 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. + 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: "#/getDefinitions/relationship" + cloud-regions: + properties: + cloud-region: + type: array + items: + $ref: "#/getDefinitions/cloud-region" + complex: + description: | + Collection of physical locations that can house cloud-regions. + ###### Related Nodes + - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE + - COMPLEX is DELETED when these are DELETED CTAG-POOL + 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: "#/getDefinitions/ctag-pool" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + complexes: + description: | + Collection of physical locations that can house cloud-regions. + properties: + complex: + type: array + items: + $ref: "#/getDefinitions/complex" + configuration: + description: | + Port Mirror Configuration. + ###### Related Nodes + - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE) + - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY) + - CONFIGURATION is DELETED when these are DELETED METADATUM + - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK + 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: "#/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 org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - CONNECTOR is DELETED when these are DELETED METADATUM + 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. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + 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 org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET + 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 org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + 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 org.onap.relationships.inventory.BelongsTo complex, MANY2ONE) + - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY) + - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + 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 org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO availability-zone( dvs-switch org.onap.relationships.inventory.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 + isParent: + type: boolean + usesResource: + type: boolean + hasDelTarget: + type: boolean + SVC-INFRA: + type: boolean + SVC-INFRA-REV: + type: boolean + 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 org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT + 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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + 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 + - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many) + - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + 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 + - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info) + - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info) + - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info) + - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info) + 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: "#/getDefinitions/relationship" + esr-system-info-list: + description: | + Collection of persistent block-level external system auth info. + properties: + esr-system-info: + type: array + items: + $ref: "#/getDefinitions/esr-system-info" + esr-thirdparty-sdnc: + description: | + Persist SDNC address information used by ONAP SDNC. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One) + - TO pnf( esr-thirdparty-sdnc has pnf, One2Many) + - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + 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: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-thirdparty-sdnc-list: + properties: + esr-thirdparty-sdnc: + type: array + items: + $ref: "#/getDefinitions/esr-thirdparty-sdnc" + esr-vnfm: + description: | + Persist VNFM address information used by VF-C. + ###### Related Nodes + - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One) + - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO + 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: "#/getDefinitions/esr-system-info-list" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + esr-vnfm-list: + properties: + esr-vnfm: + type: array + items: + $ref: "#/getDefinitions/esr-vnfm" + evc: + description: | + evc object is an optional child object of the Configuration object. + ###### Related Nodes + - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + 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: "#/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: "#/getDefinitions/evc" + external-system: + description: | + Namespace for external system. + properties: + 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 + extra-property: + properties: + property-name: + type: string + flavor: + description: | + Openstack flavor. + ###### Related Nodes + - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - FLAVOR cannot be deleted if linked 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: "#/getDefinitions/relationship" + flavors: + description: | + Collection of openstack flavors. + properties: + flavor: + type: array + items: + $ref: "#/getDefinitions/flavor" + forwarder: + description: | + Entity describing a sequenced segment of forwarding path + ###### Related Nodes + - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE) + - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE) + - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE) + - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION + 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: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE) + 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: "#/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: "#/getDefinitions/forwarder-evc" + forwarders: + properties: + forwarder: + type: array + items: + $ref: "#/getDefinitions/forwarder" + forwarding-path: + description: | + Entity that describes the sequenced forwarding path between interfaces of services or resources + ###### Related Nodes + - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE) + - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE) + - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE) + - FORWARDING-PATH is DELETED when these are DELETED FORWARDER + - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION + 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: "#/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: "#/getDefinitions/forwarding-path" + generic-vnf: + description: | + General purpose VNF + ###### Related Nodes + - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY) + - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE + 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-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-state: + 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. + 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 company 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 in some usecases + vcpu-units: + type: string + description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases + 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 in some usecases + vmemory-units: + type: string + description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases + 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 in some usecases + vdisk-units: + type: string + description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + 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 + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-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 + selflink: + type: string + description: Path to the controller object. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + vf-modules: + type: array + items: + $ref: "#/getDefinitions/vf-module" + licenses: + type: array + items: + $ref: "#/getDefinitions/license" + entitlements: + type: array + items: + $ref: "#/getDefinitions/entitlement" + generic-vnfs: + description: | + Collection of VNFs + properties: + generic-vnf: + type: array + items: + $ref: "#/getDefinitions/generic-vnf" + group-assignment: + description: | + Openstack group-assignment used to store exclusivity groups (EG). + ###### Related Nodes + - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + group-assignments: + description: | + Collection of openstack group assignments + properties: + group-assignment: + type: array + items: + $ref: "#/getDefinitions/group-assignment" + host-route: + description: | + ###### Related Nodes + - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE) + 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: "#/getDefinitions/relationship" + host-routes: + properties: + host-route: + type: array + items: + $ref: "#/getDefinitions/host-route" + image: + description: | + Openstack image. + ###### Related Nodes + - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - IMAGE cannot be deleted if linked to VSERVER + - IMAGE is DELETED when these are DELETED METADATUM + 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: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + images: + description: | + Collectio of Openstack images. + properties: + image: + type: array + items: + $ref: "#/getDefinitions/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: "#/getDefinitions/instance-filter" + instance-group: + description: | + General mechanism for grouping instances + ###### Related Nodes + - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + required: + - id + - description + - type + properties: + 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: "#/getDefinitions/relationship" + instance-groups: + description: | + Collection of openstack route table references + properties: + instance-group: + type: array + items: + $ref: "#/getDefinitions/instance-group" + inventory: + properties: + search: + type: object + $ref: "#/getDefinitions/search" + actions: + type: object + $ref: "#/getDefinitions/actions" + cloud-infrastructure: + type: object + $ref: "#/getDefinitions/cloud-infrastructure" + business: + type: object + $ref: "#/getDefinitions/business" + service-design-and-creation: + type: object + $ref: "#/getDefinitions/service-design-and-creation" + network: + type: object + $ref: "#/getDefinitions/network" + aai-internal: + type: object + $ref: "#/getDefinitions/aai-internal" + nodes: + type: array + items: + $ref: "#/getDefinitions/aai-internal" + inventory-item: + properties: + inventory-item-type: + type: string + inventory-item-link: + type: string + 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 + property-value: + type: string + inventory-response-item: + description: | + Inventory item for response list + properties: + 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: "#/getDefinitions/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 org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE) + - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER + 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: 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, ,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: "#/getDefinitions/relationship" + vig-servers: + type: array + items: + $ref: "#/getDefinitions/vig-server" + ipsec-configurations: + properties: + ipsec-configuration: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN + - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - interface-name + 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. + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + vlans: + type: array + items: + $ref: "#/getDefinitions/vlan" + sriov-vfs: + type: array + items: + $ref: "#/getDefinitions/sriov-vf" + relationship-list: + type: array + items: + $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: + l-interface: + type: array + items: + $ref: "#/getDefinitions/l-interface" + l3-interface-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + 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: "#/getDefinitions/relationship" + l3-interface-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE) + - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + 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: "#/getDefinitions/relationship" + l3-network: + description: | + Generic network definition + ###### Related Nodes + - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY) + - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY) + - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY) + - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET + 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 + 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 + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-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 + is-shared-network: + type: boolean + is-external-network: + type: boolean + selflink: + type: string + description: Path to the controller object. + subnets: + type: array + items: + $ref: "#/getDefinitions/subnet" + ctag-assignments: + type: array + items: + $ref: "#/getDefinitions/ctag-assignment" + segmentation-assignments: + type: array + items: + $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: + l3-network: + type: array + items: + $ref: "#/getDefinitions/l3-network" + lag-interface: + description: | + Link aggregate interface + ###### Related Nodes + - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE) + - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE + - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK + required: + - interface-name + 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. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + lag-interfaces: + description: | + Collection of link aggregate interfaces. + properties: + lag-interface: + type: array + items: + $ref: "#/getDefinitions/lag-interface" + lag-link: + description: | + LAG links can connect lag-interfaces + ###### Related Nodes + - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + 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: "#/getDefinitions/relationship" + lag-links: + description: | + Collection of link aggregation connections + properties: + lag-link: + type: array + items: + $ref: "#/getDefinitions/lag-link" + license: + description: | + Metadata for license group. + ###### Related Nodes + - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + 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: "#/getDefinitions/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: "#/getDefinitions/license" + line-of-business: + description: | + describes a line-of-business + ###### Related Nodes + - TO generic-vnf( line-of-business org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + lines-of-business: + description: | + Collection of lines-of-business + properties: + line-of-business: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY) + - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY) + - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY) + - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY) + - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + required: + - link-name + - link-type + properties: + link-name: + type: string + description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ + 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. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + 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: "#/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 connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE) + - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE) + - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + 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 org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY) + - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT + - MODEL is DELETED when these are DELETED MODEL-VER + 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: "#/getDefinitions/model-ver" + relationship-list: + type: array + items: + $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 org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE) + - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET + 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: "#/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: + model-constraint: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE) + - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE) + - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT + 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: "#/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: "#/getDefinitions/relationship" + model-elements: + properties: + model-element: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo model, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE) + - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE) + - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT + - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM + 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: "#/getDefinitions/model-element" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + model-vers: + properties: + model-ver: + type: array + items: + $ref: "#/getDefinitions/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: "#/getDefinitions/model" + multicast-configuration: + description: | + ###### Related Nodes + - FROM vlan( vlan org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + multicast-configurations: + description: | + multicast configuration of generic-vnf ip-address + properties: + multicast-configuration: + type: array + items: + $ref: "#/getDefinitions/multicast-configuration" + named-queries: + properties: + named-query: + type: array + items: + $ref: "#/getDefinitions/named-query" + named-query: + description: | + TBD + ###### Related Nodes + - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT + 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: "#/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 org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE) + - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE) + - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP + 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: "#/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: "#/getDefinitions/relationship" + named-query-elements: + properties: + named-query-element: + type: array + items: + $ref: "#/getDefinitions/named-query-element" + network: + description: | + Namespace for network inventory resources. + properties: + 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" + network-policies: + properties: + network-policy: + type: array + items: + $ref: "#/getDefinitions/network-policy" + network-policy: + description: | + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + network-profile: + description: | + Network profile populated by SDN-GP for SNMP + ###### Related Nodes + - TO generic-vnf( network-profile org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + network-profiles: + description: | + Collection of network profiles + properties: + network-profile: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE) + - NEWVCE is DELETED when these are DELETED L-INTERFACE + 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-state: + 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 VPE (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: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $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: + newvce: + type: array + items: + $ref: "#/getDefinitions/newvce" + notification-event: + properties: + cambria.partition: + type: string + notification-event-header: + type: object + $ref: "#/getDefinitions/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: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY) + - TO service-capability( oam-network org.onap.relationships.inventory.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: "#/getDefinitions/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: "#/getDefinitions/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 org.onap.relationships.inventory.Uses operational-environment, ONE2ONE) + - FROM operational-environment( operational-environment org.onap.relationships.inventory.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: "#/getDefinitions/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: "#/getDefinitions/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: "#/getDefinitions/model-vers" + relationship-list: + type: object + $ref: "#/getDefinitions/relationship-list" + owning-entities: + description: | + Collection of owning-entities + properties: + owning-entity: + type: array + items: + $ref: "#/getDefinitions/owning-entity" + owning-entity: + description: | + describes an owning-entity + ###### Related Nodes + - FROM service-instance( service-instance org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + p-interface: + description: | + Physical interface (e.g., nic) + ###### Related Nodes + - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE) + - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE) + - P-INTERFACE is DELETED when these are DELETED L-INTERFACE + - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK + required: + - interface-name + 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. + 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" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + p-interfaces: + description: | + Collection of physical interfaces. + properties: + p-interface: + type: array + items: + $ref: "#/getDefinitions/p-interface" + physical-link: + description: | + Collection of physical connections, typically between p-interfaces + ###### Related Nodes + - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE) + 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. + 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" + physical-links: + description: | + Collection of physical connections, typically between p-interfaces + properties: + physical-link: + type: array + items: + $ref: "#/getDefinitions/physical-link" + platform: + description: | + describes a platform + ###### Related Nodes + - TO generic-vnf( platform org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + platforms: + description: | + Collection of platforms + properties: + platform: + type: array + items: + $ref: "#/getDefinitions/platform" + pnf: + description: | + PNF represents a physical network function. typically equipment used in the D1 world. + ###### Related Nodes + - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + 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 company 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: + 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: "#/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 org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE) + - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG + 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: "#/getDefinitions/cvlan-tag-entry" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + port-groups: + properties: + port-group: + type: array + items: + $ref: "#/getDefinitions/port-group" + project: + description: | + describes the project + ###### Related Nodes + - TO service-instance( project org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + projects: + description: | + Collection of projects + properties: + project: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + 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: "#/getDefinitions/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 org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE) + - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE) + - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE) + - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE) + - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER + - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + - PSERVER cannot be deleted if linked to 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 + 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] + 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" + pservers: + description: | + Collection of compute hosts. + properties: + pserver: + type: array + items: + $ref: "#/getDefinitions/pserver" + query-parameters: + description: | + 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 named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE) + 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: "#/getDefinitions/relationship" + related-lookups: + properties: + related-lookup: + type: array + items: + $ref: "#/getDefinitions/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: "#/getDefinitions/relationship-data" + related-to-property: + type: array + items: + $ref: "#/getDefinitions/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. + relationship-list: + properties: + relationship: + type: array + items: + $ref: "#/getDefinitions/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: "#/getDefinitions/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 org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + route-table-references: + description: | + Collection of openstack route table references + properties: + route-table-reference: + type: array + items: + $ref: "#/getDefinitions/route-table-reference" + route-target: + description: | + Route target information + ###### Related Nodes + - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE) + 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: "#/getDefinitions/relationship" + route-targets: + description: | + Collection of route target information + properties: + route-target: + type: array + items: + $ref: "#/getDefinitions/route-target" + routing-instance: + description: | + ###### Related Nodes + - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR + 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: "#/getDefinitions/site-pair" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + routing-instances: + description: | + set of probes related to generic-vnf routing instance + properties: + routing-instance: + type: array + items: + $ref: "#/getDefinitions/routing-instance" + sdn-zone-response: + properties: + oam-networks: + type: object + $ref: "#/getDefinitions/oam-networks" + az-and-dvs-switches: + type: array + items: + $ref: "#/getDefinitions/az-and-dvs-switches" + search: + properties: + 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: "#/getDefinitions/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: "#/getDefinitions/secondary-filt" + segmentation-assignment: + description: | + Openstack segmentation assignment. + ###### Related Nodes + - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + 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: "#/getDefinitions/relationship" + segmentation-assignments: + description: | + Collection of openstack segmentation assignments + properties: + segmentation-assignment: + type: array + items: + $ref: "#/getDefinitions/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: "#/getDefinitions/relationship" + service-capabilities: + description: | + Collection of service capabilities. + properties: + service-capability: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY) + - SERVICE-CAPABILITY cannot be deleted if linked 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: "#/getDefinitions/relationship" + service-design-and-creation: + description: | + Namespace for objects managed by ASDC + properties: + vnf-images: + type: array + 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: | + Instance of a service + ###### Related Nodes + - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY) + - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY) + - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY) + - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY) + - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY) + - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY) + - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY) + - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY) + - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY) + - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM + - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK + 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. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + 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: "#/getDefinitions/relationship" + metadata: + type: array + items: + $ref: "#/getDefinitions/metadatum" + allotted-resources: + type: array + items: + $ref: "#/getDefinitions/allotted-resource" + service-instances: + description: | + Collection of service instances + properties: + service-instance: + type: array + items: + $ref: "#/getDefinitions/service-instance" + service-subscription: + description: | + Object that group service instances. + ###### Related Nodes + - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE) + - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE) + - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE + 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: "#/getDefinitions/service-instance" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + service-subscriptions: + description: | + Collection of objects that group service instances. + properties: + service-subscription: + type: array + items: + $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: | + ###### Related Nodes + - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE) + - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE) + - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE + 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, 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: "#/getDefinitions/class-of-service" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + site-pair-set: + description: | + Set of instances for probes used to measure service level agreements + ###### Related Nodes + - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY) + - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE) + - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE + 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: "#/getDefinitions/routing-instance" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + site-pair-sets: + description: | + Collection of sets of instances for probes related to generic-vnf + properties: + site-pair-set: + type: array + items: + $ref: "#/getDefinitions/site-pair-set" + site-pairs: + description: | + probe within a set + properties: + site-pair: + type: array + items: + $ref: "#/getDefinitions/site-pair" + snapshot: + description: | + Openstack snapshot + ###### Related Nodes + - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM vserver( vserver org.onap.relationships.inventory.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: "#/getDefinitions/relationship" + snapshots: + description: | + Collection of openstack snapshots + properties: + snapshot: + type: array + items: + $ref: "#/getDefinitions/snapshot" + sriov-pf: + description: | + SR-IOV Physical Function + ###### Related Nodes + - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE) + - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE) + 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: "#/getDefinitions/relationship" + sriov-pfs: + description: | + Collection of SR-IOV Physical Functions. + properties: + sriov-pf: + type: array + items: + $ref: "#/getDefinitions/sriov-pf" + sriov-vf: + description: | + SR-IOV Virtual Function (not to be confused with virtual network function) + ###### Related Nodes + - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE) + 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/generic-vnf" - lag-links: + $ref: "#/getDefinitions/relationship" + sriov-vfs: + description: | + Collection of SR-IOV Virtual Functions. + properties: + sriov-vf: + type: array + items: + $ref: "#/getDefinitions/sriov-vf" + start-node-filter: + properties: + property-name: + type: string + property-value: + type: string + subnet: + description: | + ###### Related Nodes + - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY) + - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-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 + 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 + 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/lag-link" - newvces: + $ref: "#/getDefinitions/relationship" + subnets: + properties: + subnet: + type: array + items: + $ref: "#/getDefinitions/subnet" + tagged-inventory-item-list: + properties: + inventory-item: + type: array + items: + $ref: "#/getDefinitions/inventory-item" + tenant: + description: | + Openstack tenant + ###### Related Nodes + - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY) + - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY) + - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY) + - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TENANT cannot be deleted if linked 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 + 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/newvce" - pnfs: + $ref: "#/getDefinitions/vserver" + relationship-list: type: array items: - $ref: "#/definitions/pnf" - physical-links: + $ref: "#/getDefinitions/relationship" + tenants: + description: | + Collection of openstack tenants. + properties: + tenant: + type: array + items: + $ref: "#/getDefinitions/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 org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE) + 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/physical-link" - ipsec-configurations: + $ref: "#/getDefinitions/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: "#/getDefinitions/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: "#/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 availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY) + - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY) + - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY) + - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP + 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-state: + 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/ipsec-configuration" - route-table-references: + $ref: "#/getDefinitions/port-group" + licenses: type: array items: - $ref: "#/definitions/route-table-reference" - instance-groups: + $ref: "#/getDefinitions/license" + entitlements: type: array items: - $ref: "#/definitions/instance-group" - zones: + $ref: "#/getDefinitions/entitlement" + relationship-list: type: array items: - $ref: "#/definitions/zone" - inventory: + $ref: "#/getDefinitions/relationship" + vces: + description: | + Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. 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: + vce: + type: array + items: + $ref: "#/getDefinitions/vce" + vf-module: + description: | + a deployment unit of VNFCs + ###### Related Nodes + - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY) + - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - VF-MODULE cannot be deleted if linked 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 + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + persona-model-id: + type: string + description: the ASDC model id for this resource or service model. + persona-model-version: + type: string + description: the ASDC model version for this resource or service model. + model-version-id: + type: string + description: the ASDC model version for this resource or service model. + persona-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/" - edge-tag-query-result: + $ref: "#/getDefinitions/relationship" + vf-modules: + description: | + Collection of vf-modules, a deployment unit of VNFCs properties: - tagged-inventory-item-list: + vf-module: type: array items: - $ref: "#/definitions/tagged-inventory-item-list" - tagged-inventory-item-list: + $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 + ###### Related Nodes + - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE) + required: + - vig-address-type properties: - inventory-item: + 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: "#/getDefinitions/relationship" + vig-servers: + properties: + vig-server: type: array items: - $ref: "#/definitions/inventory-item" - inventory-item: + $ref: "#/getDefinitions/vig-server" + vip-ipv4-address-list: + description: | + IPv4 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY) + required: + - vip-ipv4-address properties: - inventory-item-type: + vip-ipv4-address: type: string - inventory-item-link: + 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 - inventory-item-data: + 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/inventory-item-data" - tagged-inventory-item-list: + items: + $ref: "#/getDefinitions/relationship" + vip-ipv6-address-list: + description: | + IPv6 Address Range + ###### Related Nodes + - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY) + - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY) + - FROM vnfc( vnfc org.onap.relationships.inventory.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/tagged-inventory-item-list" - inventory-item-data: + items: + $ref: "#/getDefinitions/relationship" + virtual-data-center: + description: | + Virtual organization of cloud infrastructure elements in a data center context + ###### Related Nodes + - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY) + required: + - vdc-id + - vdc-name properties: - property-name: + vdc-id: type: string - property-value: + description: Unique ID of the vdc + vdc-name: type: string - edge-tag-query-request: + 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: "#/getDefinitions/relationship" + virtual-data-centers: + description: | + Virtual organization of cloud infrastructure elements in a data center context properties: - edge-tag: + virtual-data-center: + type: array + items: + $ref: "#/getDefinitions/virtual-data-center" + vlan: + description: | + Definition of vlan + ###### Related Nodes + - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE) + - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY) + - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY) + - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY) + - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY) + - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE) + - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST + - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK + required: + - vlan-interface + properties: + vlan-interface: type: string - result-detail: + 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 - start-node-type: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + speed-value: type: string - start-node-filter: + 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-id: + 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. + 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 org.onap.relationships.inventory.Uses vnf-image, MANY2ONE) + - VNF-IMAGE cannot be deleted if linked 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: - properties: - oam-networks: - type: object - $ref: "#/definitions/oam-networks" - az-and-dvs-switches: + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: 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: + items: + $ref: "#/getDefinitions/relationship" + vnf-images: description: | - Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. - required: - - update-node-type + Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. properties: - update-node-type: - type: string - update-node-key: - type: array - items: - $ref: "#/definitions/update-node-key" - update-node-uri: - type: string - action: + vnf-image: type: array items: - $ref: "#/definitions/action" - action: + $ref: "#/getDefinitions/vnf-image" + vnfc: + description: | + ###### Related Nodes + - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE) + - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY) + required: + - vnfc-name + - vnfc-function-code + - vnfc-type + - in-maint + - is-closed-loop-disabled properties: - action-type: + vnfc-name: type: string - action-data: - type: array - items: - $ref: "#/definitions/action-data" - action-data: - properties: - property-name: + description: Unique ID of vnfc. + vnfc-function-code: type: string - property-value: + description: function code + vnfc-type: type: string - update-node-key: - properties: - key-name: + description: type + prov-status: type: string - key-value: + description: prov status of this vnfc + orchestration-status: type: string - notify: - required: - - event-id - properties: - event-id: + description: Orchestration status of this VNF, mastered by APP-C + ipaddress-v4-oam-vip: type: string - node-type: + description: Oam V4 vip address of this vnfc + in-maint: + type: boolean + is-closed-loop-disabled: + type: boolean + group-notation: type: string - event-trigger: + description: Group notation of VNFC + 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" + vnfcs: + description: | + virtual network components associated with a vserver from application controller. + properties: + vnfc: type: array items: - $ref: "#/definitions/key-data" - selflink: - type: string - key-data: + $ref: "#/getDefinitions/vnfc" + volume: + description: | + Ephemeral Block storage volume. + ###### Related Nodes + - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume) + required: + - volume-id + - volume-selflink properties: - key-name: + volume-id: type: string - key-value: + description: Unique ID of block storage volume relative to the vserver. + volume-selflink: type: string - notification-event: - properties: - cambria.partition: + description: URL to endpoint where AAI can get more details + resource-version: type: string - notification-event-header: - type: object - $ref: "#/definitions/notification-event-header" - notification-event-header: + 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 org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE) + - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY) + required: + - volume-group-id + - volume-group-name + - vnf-type properties: - id: - type: string - timestamp: - type: string - source-name: - type: string - domain: - type: string - sequence-number: - type: string - severity: + 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 + persona-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-persona-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: - 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 - edge-prop-names: + volume-group: + type: array + items: + $ref: "#/getDefinitions/volume-group" + volumes: description: | - Internal map to define the properties of an edge and interpret the map EdgeRules + Collection of ephemeral Block storage volumes. properties: - edgeLabel: + volume: + type: array + items: + $ref: "#/getDefinitions/volume" + vpls-pe: + description: | + VPLS Provider Edge routers. + ###### Related Nodes + - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY) + - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE) + - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE + required: + - equipment-name + properties: + equipment-name: type: string - direction: + prov-status: type: string - multiplicityRule: + description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. + ipv4-oam-address: type: string - isParent: - type: boolean - usesResource: - type: boolean - hasDelTarget: - type: boolean - SVC-INFRA: - type: boolean - SVC-INFRA-REV: - type: boolean - 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: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address). + equipment-role: type: string - secondary-filter-cut-point: + 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 - query-parameters: + 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: | - QueryParameters for performing a named-query or model query + Collection of VPLS Provider Edge routers properties: - named-query: - type: object - $ref: "#/definitions/named-query" - overloaded-model: - type: object - $ref: "#/definitions/overloaded-model" - overloaded-model: + vpls-pe: + type: array + items: + $ref: "#/getDefinitions/vpls-pe" + vpn-binding: description: | - Allows for legacy POST of old-style and new-style models + VPN binding + ###### Related Nodes + - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY) + - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK required: - - model-invariant-id - - model-name-version-id - - model-type - - model-name - - model-id - - model-version + - vpn-id + - vpn-name + - global-route-target + - route-target-role properties: - model-invariant-id: + vpn-id: type: string - description: Unique identifier corresponding to the main definition of a model in ASDC - model-name-version-id: + description: VPN ID, globally unique within A&AI + vpn-name: type: string - description: Unique identifier corresponding to one version of a model in ASDC - model-type: + description: VPN Name + global-route-target: type: string - description: Type of the model, e.g., service, resource, widget, etc. - model-name: + description: Number used to identify a VPN, globally unique in the network + vpn-platform: type: string - description: Name of the model, which can change from version to version. - model-id: + description: the platform associated with the VPN example AVPN, Mobility + vpn-type: type: string - description: Invariant unique ID which does not change from version to version - model-version: + description: Type of the vpn, should be taken from enumerated/valid values + route-distinguisher: type: string - description: Version - model-description: + description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. + route-target-role: type: string - description: Description + 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. - model-vers: - type: object - $ref: "#/definitions/model-vers" 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: - description: | - SecondaryFilts for performing a named-query or model query + items: + $ref: "#/getDefinitions/relationship" + description: l3-networks relate to vpn-bindings + vpn-bindings: properties: - secondary-filt: + vpn-binding: type: array items: - $ref: "#/definitions/secondary-filt" - secondary-filt: - description: | - SecondaryFilt for performing a named-query or model query - properties: + $ref: "#/getDefinitions/vpn-binding" + vserver: description: | - Property holder for query properties or instance properties + Virtual Servers, aka virtual machine or VM. + ###### Related Nodes + - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE) + - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) + - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE) + - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE) + - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE) + - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY) + - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY) + - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE) + - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY) + - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY) + - VSERVER is DELETED when these are DELETED L-INTERFACE + - VSERVER deletion means associated objects of these types are also DELETED:VOLUME + required: + - vserver-id + - vserver-name + - vserver-selflink + - in-maint + - is-closed-loop-disabled properties: - property-name: + vserver-id: type: string - property-value: + description: Unique identifier for this vserver relative to its tenant + vserver-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: 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 + is-closed-loop-disabled: + type: boolean + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + volumes: + type: array + items: + $ref: "#/getDefinitions/volume" + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + l-interfaces: + type: array + items: + $ref: "#/getDefinitions/l-interface" + vservers: description: | - Container for inventory items in response list + Collection of virtual Servers, aka virtual machines or VMs. properties: - inventory-response-item: + vserver: type: array items: - $ref: "#/definitions/inventory-response-item" - inventory-response-item: + $ref: "#/getDefinitions/vserver" + zone: description: | - Inventory item for response list + A zone is a grouping of assets in a location homing to the same connections into the CBB + ###### Related Nodes + - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE) + - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE) + required: + - zone-id + - zone-name + - design-type + - zone-context properties: - model-name: + zone-id: 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 - extra-property: - properties: - property-name: + description: Code assigned by AIC to the zone + zone-name: type: string - vnf: + 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: "#/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"