From: Kajur, Harish (vk250x) Date: Fri, 9 Mar 2018 00:35:31 +0000 (-0500) Subject: Update the yaml and html for hpa X-Git-Tag: v1.2.1~12 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=1ab23228aa006a0ad8d25ab488d5952cf5182593;p=aai%2Faai-common.git Update the yaml and html for hpa Issue-ID: AAI-838 Change-Id: I2fb543d4e6345faada8ec8fb73ed8ef8f2dd4645 Signed-off-by: Kajur, Harish (vk250x) --- diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html index d039441c..cb7b5f33 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html @@ -169,6 +169,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

delete an existing flavor

+ + + + GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities +

returns hpa-capabilities

+ + + + GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

returns hpa-capability

+ + + + PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

create or update an existing hpa-capability

+ + + + PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

update an existing hpa-capability

+ + + + DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

delete an existing hpa-capability

+ + + + GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute +

returns hpa-feature-attribute

+ + + + PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship +

see node definition for valid relationships

+ + + + DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship +

delete an existing relationship

+ + + + PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship +

see node definition for valid relationships

+ + + + DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship +

delete an existing relationship

@@ -214,6 +264,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

delete an existing relationship

+ + + + GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities +

returns hpa-capabilities

+ + + + GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

returns hpa-capability

+ + + + PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

create or update an existing hpa-capability

+ + + + PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

update an existing hpa-capability

+ + + + DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} +

delete an existing hpa-capability

+ + + + GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute +

returns hpa-feature-attribute

+ + + + PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship +

see node definition for valid relationships

+ + + + DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship +

delete an existing relationship

+ + + + PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship +

see node definition for valid relationships

+ + + + DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship +

delete an existing relationship

@@ -18282,7 +18382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen flavor-name -

Flavor name

+

Cloud region Flavor name

query @@ -18713,36 +18813,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+
returns hpa-capabilities
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns hpa-capabilities

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

-

-
-
-
-
- /relationship -
-
-
-
@@ -18803,6 +18886,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ flavor-name + +

Cloud region Flavor name

+ 		query + string + + +
@@ -18812,6 +18940,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /hpa-capabilities +
+
+
+ +
default @@ -18834,24 +18985,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+
returns hpa-capability
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns hpa-capability

-
- -

application/json application/xml -

-
@@ -18912,68 +19058,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns group-assignments
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

- Tags: - CloudInfrastructure -
-
-
-

returns group-assignments

- -
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- cloud-owner + hpa-capability-id -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

UUID to uniquely identify a HPA capability

 path @@ -18986,26 +19076,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + cloud-type -

Identifier used by the vendor for the region. Second part of composite key

+

Type of the cloud (e.g., openstack)

pathquery string -
- cloud-type + owner-defined-type -

Type of the cloud (e.g., openstack)

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -19017,10 +19106,1568 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + flavor-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Cloud region Flavor name

+ 		query + string + + +
+ hpa-feature + +

Name of the HPACapability

+ 		query + string + + +
+ hpa-hw-arch + +

Hardware architecture

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /hpa-capability +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing hpa-capability
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing hpa-capability

+ +
+
+ +

application/json application/xml +

+
+
+

hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)

+

+
+
+
+
+ /hpa-capability +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing hpa-capability
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing hpa-capability

+ +
+
+ +

application/json application/xml +

+
+
+

hpa-capability object that needs to be created or updated.

+

+
+
+
+
+ /hpa-capability +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing hpa-capability
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing hpa-capability

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns hpa-feature-attribute
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute

+ Tags: + CloudInfrastructure +
+
+
+

returns hpa-feature-attribute

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ flavor-name + +

Cloud region Flavor name

+ 		query + string + + +
+ hpa-feature + +

Name of the HPACapability

+ 		query + string + + +
+ hpa-hw-arch + +

Hardware architecture

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /hpa-feature-attribute +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns group-assignments
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

+ Tags: + CloudInfrastructure +
+
+
+

returns group-assignments

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -214,6 +264,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -18282,7 +18382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen flavor-name
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -19084,19 +20731,699 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
+
+
returns group-assignment
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns group-assignment

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ group-type + +

Group type - the type of group this instance refers to

+ 		query + string + + +
+ group-name + +

Group name - name assigned to the group

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /group-assignment +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing group-assignment
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+
+ /group-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing group-assignment
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be created or updated.

+

+
+
+
+
+ /group-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing group-assignment
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing group-assignment

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
-
returns group-assignment
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns group-assignment

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -19157,6 +21484,94 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns hpa-capabilities
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities

+ Tags: + CloudInfrastructure +
+
+
+

returns hpa-capabilities

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
cloud-type @@ -19187,12 +21602,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /hpa-capabilities +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns hpa-capability
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns hpa-capability

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
- group-type + cloud-owner -

Group type - the type of group this instance refers to

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

 query @@ -19204,10 +21746,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-name + owner-defined-type -

Group name - name assigned to the group

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ hpa-feature + +

Name of the HPACapability

+ 		query + string + + +
+ hpa-hw-arch + +

Hardware architecture

 query @@ -19243,7 +21815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /group-assignment + /hpa-capability
@@ -19271,17 +21843,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing group-assignment
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
create or update an existing hpa-capability
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure
-

create or update an existing group-assignment

+

create or update an existing hpa-capability

@@ -19290,13 +21862,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)

- /group-assignment + /hpa-capability
@@ -19347,10 +21919,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-id + hpa-capability-id -

Group id, expected to be unique across cloud-region.

+

UUID to uniquely identify a HPA capability

 path @@ -19392,17 +21964,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing group-assignment
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
update an existing hpa-capability
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure
-

update an existing group-assignment

+

update an existing hpa-capability

@@ -19411,13 +21983,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

group-assignment object that needs to be created or updated.

+

hpa-capability object that needs to be created or updated.

- /group-assignment + /hpa-capability
@@ -19468,10 +22040,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-id + hpa-capability-id -

Group id, expected to be unique across cloud-region.

+

UUID to uniquely identify a HPA capability

 path @@ -19513,17 +22085,450 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing group-assignment
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

+
delete an existing hpa-capability
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure
-

delete an existing group-assignment

+

delete an existing hpa-capability

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns hpa-feature-attribute
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute

+ Tags: + CloudInfrastructure +
+
+
+

returns hpa-feature-attribute

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ hpa-feature + +

Name of the HPACapability

+ 		query + string + + +
+ hpa-hw-arch + +

Hardware architecture

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /hpa-feature-attribute +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ hpa-capability-id + +

UUID to uniquely identify a HPA capability

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

@@ -19577,10 +22582,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-id + hpa-capability-id -

Group id, expected to be unique across cloud-region.

+

UUID to uniquely identify a HPA capability

 path @@ -19591,22 +22596,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -19638,11 +22627,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -19657,7 +22646,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)

@@ -19714,10 +22703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-id + hpa-capability-id -

Group id, expected to be unique across cloud-region.

+

UUID to uniquely identify a HPA capability

 path @@ -19759,11 +22748,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -19823,10 +22812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-id + hpa-capability-id -

Group id, expected to be unique across cloud-region.

+

UUID to uniquely identify a HPA capability

 path @@ -168515,6 +171504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
  • 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 hpa-capability( hpa-capability 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)
    • @@ -168525,7 +171515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
  • 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
    • +
  • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
  • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
  • CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    • @@ -168916,6 +171906,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + + +
    + hpa-capabilities: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    +
    @@ -172316,8 +175326,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    • TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
    • FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
      • -
    • FLAVOR cannot be deleted if linked to VSERVER
    +
  • FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
    • @@ -172344,7 +175355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Flavor name

    +

    Cloud region Flavor name

    @@ -172458,6 +175469,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + hpa-capabilities: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    + +
    +
    +
    relationship-list: object[] @@ -174152,6 +177183,251 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    +

    hpa-capabilities: + object + + + +

    +
    +
    +
    +

    Collection of HPA Capabilities

    + +
    + +
    +
    +
    + hpa-capability: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-capability: + object + + + +

    +
    +
    +
    +

    Represents a HPA capability

    + +
      +
    • TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
      • +
    • TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    + +
    + +
    +
    +
    + hpa-capability-id: + string + + + +
    +
    +

    UUID to uniquely identify a HPA capability

    +
    + +
    +
    +
    + hpa-feature: + string + + + +
    +
    +

    Name of the HPACapability

    +
    + +
    +
    +
    + hpa-version: + string + + +
    +
    +

    HPA schema version

    +
    + +
    +
    +
    + hpa-hw-arch: + string + + +
    +
    +

    Hardware architecture

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    + hpa-feature-attribute: + object[] + + +
    +
    + +
    + +
    + hpa-feature-attribute + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-feature-attribute: + object + + + +

    +
    +
    +
    +

    HPA Capability Feature attributes

    + +
    + +
    +
    +
    + hpa-attr-key: + string + + +
    +
    +

    name of the specific HPA attribute

    +
    + +
    +
    +
    + hpa-attr-value: + string + + +
    +
    +

    JSON string specifying the value, unit and type of the specific HPA attribute

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +

    image: diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html index a9d1c9fb..1fe7357c 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html @@ -169,6 +169,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    delete an existing flavor

    +
    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities

    returns hpa-capabilities

    +
    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    returns hpa-capability

    +
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    create or update an existing hpa-capability

    +
    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    update an existing hpa-capability

    +
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    delete an existing hpa-capability

    +
    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute

    returns hpa-feature-attribute

    +
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    see node definition for valid relationships

    +
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    delete an existing relationship

    +
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    see node definition for valid relationships

    +
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    delete an existing relationship
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    delete an existing relationship

    +
    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities

    returns hpa-capabilities

    +
    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    returns hpa-capability

    +
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    create or update an existing hpa-capability

    +
    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    update an existing hpa-capability

    +
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    delete an existing hpa-capability

    +
    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute

    returns hpa-feature-attribute

    +
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    see node definition for valid relationships

    +
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    delete an existing relationship

    +
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    see node definition for valid relationships

    +
    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    delete an existing relationship
    -

    Flavor name

    +

    Cloud Region Flavor name

    		 query @@ -18713,36 +18813,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    +
    returns hpa-capabilities
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    returns hpa-capabilities

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -18803,6 +18886,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + flavor-name + +

    Cloud Region Flavor name

    +     		query + string + + +
    @@ -18812,6 +18940,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /hpa-capabilities +
    +
    +
    + +
    default @@ -18834,24 +18985,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    +
    returns hpa-capability
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    returns hpa-capability

    -
    - -

    application/json application/xml -

    -
    @@ -18912,68 +19058,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns group-assignments
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns group-assignments

    - -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
    - cloud-owner + hpa-capability-id -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    UUID to uniquely identify a HPA capability

    		 path @@ -18986,26 +19076,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region-id + cloud-type -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - cloud-type + owner-defined-type -

    Type of the cloud (e.g., openstack)

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		 query @@ -19017,10 +19106,1568 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - owner-defined-type + flavor-name -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    Cloud Region Flavor name

    +     		query + string + + +
    + hpa-feature + +

    Name of the HPACapability

    +     		query + string + + +
    + hpa-hw-arch + +

    Hardware architecture

    +     		query + string + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /hpa-capability +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing hpa-capability
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    create or update an existing hpa-capability

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)

    +

    +
    +
    +
    +
    + /hpa-capability +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing hpa-capability
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    update an existing hpa-capability

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    hpa-capability object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /hpa-capability +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing hpa-capability
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing hpa-capability

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns hpa-feature-attribute
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns hpa-feature-attribute

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + flavor-name + +

    Cloud Region Flavor name

    +     		query + string + + +
    + hpa-feature + +

    Name of the HPACapability

    +     		query + string + + +
    + hpa-hw-arch + +

    Hardware architecture

    +     		query + string + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /hpa-feature-attribute +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + flavor-id + +

    Flavor id, expected to be unique across cloud-region.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns group-assignments
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns group-assignments

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		 query @@ -19084,19 +20731,699 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    returns group-assignment
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns group-assignment

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + group-id + +

    Group id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + group-type + +

    Group type - the type of group this instance refers to

    +     		query + string + + +
    + group-name + +

    Group name - name assigned to the group

    +     		query + string + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /group-assignment +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing group-assignment
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    create or update an existing group-assignment

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    +

    +
    +
    +
    +
    + /group-assignment +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + group-id + +

    Group id, expected to be unique across cloud-region.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing group-assignment
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    update an existing group-assignment

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    group-assignment object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /group-assignment +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + group-id + +

    Group id, expected to be unique across cloud-region.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing group-assignment
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing group-assignment

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + group-id + +

    Group id, expected to be unique across cloud-region.

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + group-id + +

    Group id, expected to be unique across cloud-region.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    -
    returns group-assignment
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns group-assignment

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -19157,6 +21484,94 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns hpa-capabilities
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns hpa-capabilities

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    cloud-type @@ -19187,12 +21602,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /hpa-capabilities +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns hpa-capability
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns hpa-capability

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
    - group-type + cloud-owner -

    Group type - the type of group this instance refers to

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    		 query @@ -19204,10 +21746,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-name + owner-defined-type -

    Group name - name assigned to the group

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + hpa-feature + +

    Name of the HPACapability

    +     		query + string + + +
    + hpa-hw-arch + +

    Hardware architecture

    		 query @@ -19243,7 +21815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignment + /hpa-capability
    @@ -19271,17 +21843,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing group-assignment
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    create or update an existing hpa-capability
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    Tags: CloudInfrastructure
    -

    create or update an existing group-assignment

    +

    create or update an existing hpa-capability

    @@ -19290,13 +21862,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    +

    hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)

    - /group-assignment + /hpa-capability
    @@ -19347,10 +21919,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-id + hpa-capability-id -

    Group id, expected to be unique across cloud-region.

    +

    UUID to uniquely identify a HPA capability

    		 path @@ -19392,17 +21964,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    update an existing group-assignment
    -

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    update an existing hpa-capability
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    Tags: CloudInfrastructure
    -

    update an existing group-assignment

    +

    update an existing hpa-capability

    @@ -19411,13 +21983,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    group-assignment object that needs to be created or updated.

    +

    hpa-capability object that needs to be created or updated.

    - /group-assignment + /hpa-capability
    @@ -19468,10 +22040,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-id + hpa-capability-id -

    Group id, expected to be unique across cloud-region.

    +

    UUID to uniquely identify a HPA capability

    		 path @@ -19513,17 +22085,450 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing group-assignment
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    delete an existing hpa-capability
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

    Tags: CloudInfrastructure
    -

    delete an existing group-assignment

    +

    delete an existing hpa-capability

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns hpa-feature-attribute
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns hpa-feature-attribute

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + hpa-feature + +

    Name of the HPACapability

    +     		query + string + + +
    + hpa-hw-arch + +

    Hardware architecture

    +     		query + string + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /hpa-feature-attribute +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-owner + +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +     		path + string + + + +
    + cloud-region-id + +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + hpa-capability-id + +

    UUID to uniquely identify a HPA capability

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    @@ -19577,10 +22582,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-id + hpa-capability-id -

    Group id, expected to be unique across cloud-region.

    +

    UUID to uniquely identify a HPA capability

    		 path @@ -19591,22 +22596,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -19638,11 +22627,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -19657,7 +22646,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)

    @@ -19714,10 +22703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-id + hpa-capability-id -

    Group id, expected to be unique across cloud-region.

    +

    UUID to uniquely identify a HPA capability

    		 path @@ -19759,11 +22748,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -19823,10 +22812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-id + hpa-capability-id -

    Group id, expected to be unique across cloud-region.

    +

    UUID to uniquely identify a HPA capability

    		 path @@ -168515,6 +171504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
  • 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 hpa-capability( hpa-capability 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)
    • @@ -168525,7 +171515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
  • 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
    • +
  • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
  • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
  • CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    • @@ -168916,6 +171906,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + + +
    + hpa-capabilities: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    +
    @@ -172316,8 +175326,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    • TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
    • FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
      • -
    • FLAVOR cannot be deleted if linked to VSERVER
    +
  • FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
    • @@ -172344,7 +175355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Flavor name

    +

    Cloud Region Flavor name

    @@ -172458,6 +175469,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + hpa-capabilities: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    + +
    +
    +
    relationship-list: object[] @@ -174152,6 +177183,251 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    +

    hpa-capabilities: + object + + + +

    +
    +
    +
    +

    Collection of HPA Capabilities

    + +
    + +
    +
    +
    + hpa-capability: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-capability: + object + + + +

    +
    +
    +
    +

    Represents a HPA capability

    + +
      +
    • TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
      • +
    • TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    + +
    + +
    +
    +
    + hpa-capability-id: + string + + + +
    +
    +

    UUID to uniquely identify a HPA capability

    +
    + +
    +
    +
    + hpa-feature: + string + + + +
    +
    +

    Name of the HPACapability

    +
    + +
    +
    +
    + hpa-version: + string + + +
    +
    +

    HPA schema version

    +
    + +
    +
    +
    + hpa-hw-arch: + string + + +
    +
    +

    Hardware architecture

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    + hpa-feature-attribute: + object[] + + +
    +
    + +
    + +
    + hpa-feature-attribute + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-feature-attribute: + object + + + +

    +
    +
    +
    +

    HPA Capability Feature attributes

    + +
    + +
    +
    +
    + hpa-attr-key: + string + + +
    +
    +

    name of the specific HPA attribute

    +
    + +
    +
    +
    + hpa-attr-value: + string + + +
    +
    +

    JSON string specifying the value, unit and type of the specific HPA attribute

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +

    image: diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml index b1d047e2..85226a40 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml @@ -5276,12 +5276,12 @@ paths: 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}/flavors/flavor/{flavor-id}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship consumes: - application/json - application/xml @@ -5310,9 +5310,15 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) required: true schema: $ref: "#/definitions/relationship" @@ -5321,7 +5327,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship consumes: - application/json - application/xml @@ -5350,13 +5356,105 @@ paths: required: true type: string example: __FLAVOR-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute: get: tags: - CloudInfrastructure - summary: returns flavor - description: returns flavor - operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + summary: returns hpa-feature-attribute + description: returns hpa-feature-attribute + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute produces: - application/json - application/xml @@ -5364,7 +5462,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/flavor" + $ref: "#/getDefinitions/hpa-feature-attribute" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5386,6 +5484,12 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5398,18 +5502,95 @@ paths: type: string - name: flavor-name in: query - description: Flavor name + description: Cloud region Flavor name + required: false + type: string + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capability + description: returns hpa-capability + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capability" + "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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-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 + - name: flavor-name + in: query + description: Cloud region Flavor name + required: false + type: string + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing flavor + summary: create or update an existing hpa-capability description: | - Create or update an existing flavor. + Create or update an existing hpa-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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability consumes: - application/json - application/xml @@ -5438,18 +5619,24 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: body in: body - description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) required: true schema: - $ref: "#/definitions/flavor" + $ref: "#/definitions/hpa-capability" patch: tags: - CloudInfrastructure - summary: update an existing flavor + summary: update an existing hpa-capability description: | - Update an existing flavor + Update an existing hpa-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. @@ -5460,7 +5647,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability consumes: - application/json - application/xml @@ -5489,18 +5676,24 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: body in: body - description: flavor object that needs to be created or updated. + description: hpa-capability object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/flavor" + $ref: "#/patchDefinitions/hpa-capability" delete: tags: - CloudInfrastructure - summary: delete an existing flavor - description: delete an existing flavor - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + summary: delete an existing hpa-capability + description: delete an existing hpa-capability + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability consumes: - application/json - application/xml @@ -5529,18 +5722,24 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - 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}/flavors: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities: get: tags: - CloudInfrastructure - summary: returns flavors - description: returns flavors - operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities produces: - application/json - application/xml @@ -5548,7 +5747,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/flavors" + $ref: "#/getDefinitions/hpa-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5564,6 +5763,12 @@ paths: 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) @@ -5574,12 +5779,17 @@ paths: 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}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: + - name: flavor-name + in: query + description: Cloud region Flavor name + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship consumes: - application/json - application/xml @@ -5602,15 +5812,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: $ref: "#/definitions/relationship" @@ -5619,7 +5829,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship consumes: - application/json - application/xml @@ -5642,19 +5852,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor 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}: + example: __FLAVOR-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: get: tags: - CloudInfrastructure - summary: returns group-assignment - description: returns group-assignment - operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + summary: returns flavor + description: returns flavor + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor produces: - application/json - application/xml @@ -5662,7 +5872,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/group-assignment" + $ref: "#/getDefinitions/flavor" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5678,12 +5888,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5694,25 +5904,20 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: group-type - in: query - description: Group type - the type of group this instance refers to - required: false - type: string - - name: group-name + - name: flavor-name in: query - description: Group name - name assigned to the group + description: Cloud region Flavor name required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing group-assignment + summary: create or update an existing flavor description: | - Create or update an existing group-assignment. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json - application/xml @@ -5735,24 +5940,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: body in: body - description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: - $ref: "#/definitions/group-assignment" + $ref: "#/definitions/flavor" patch: tags: - CloudInfrastructure - summary: update an existing group-assignment + summary: update an existing flavor description: | - Update an existing group-assignment + 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. @@ -5763,7 +5968,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json - application/xml @@ -5786,24 +5991,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: body in: body - description: group-assignment object that needs to be created or updated. + description: flavor object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/group-assignment" + $ref: "#/patchDefinitions/flavor" delete: tags: - CloudInfrastructure - summary: delete an existing group-assignment - description: delete an existing group-assignment - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + summary: delete an existing flavor + description: delete an existing flavor + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json - application/xml @@ -5826,24 +6031,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - 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}/group-assignments: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors: get: tags: - CloudInfrastructure - summary: returns group-assignments - description: returns group-assignments - operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments + summary: returns flavors + description: returns flavors + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors produces: - application/json - application/xml @@ -5851,7 +6056,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/group-assignments" + $ref: "#/getDefinitions/flavors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5877,12 +6082,12 @@ paths: 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}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -5905,15 +6110,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true schema: $ref: "#/definitions/relationship" @@ -5922,7 +6127,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -5945,19 +6150,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: + example: __GROUP-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}: get: tags: - CloudInfrastructure - summary: returns snapshot - description: returns snapshot - operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + summary: returns group-assignment + description: returns group-assignment + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment produces: - application/json - application/xml @@ -5965,7 +6170,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/snapshot" + $ref: "#/getDefinitions/group-assignment" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5981,12 +6186,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5997,40 +6202,25 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: snapshot-name - in: query - description: Snapshot name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version + - name: group-type in: query - description: The version of the application. + description: Group type - the type of group this instance refers to required: false type: string - - name: prev-snapshot-id + - name: group-name in: query - description: This field contains the UUID of the previous snapshot (if any). + description: Group name - name assigned to the group required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing snapshot + summary: create or update an existing group-assignment description: | - Create or update an existing snapshot. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -6053,24 +6243,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: body in: body - description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true schema: - $ref: "#/definitions/snapshot" + $ref: "#/definitions/group-assignment" patch: tags: - CloudInfrastructure - summary: update an existing snapshot + summary: update an existing group-assignment description: | - Update an existing snapshot + 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. @@ -6081,7 +6271,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -6104,24 +6294,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: body in: body - description: snapshot object that needs to be created or updated. + description: group-assignment object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/snapshot" + $ref: "#/patchDefinitions/group-assignment" delete: tags: - CloudInfrastructure - summary: delete an existing snapshot - description: delete an existing snapshot - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + summary: delete an existing group-assignment + description: delete an existing group-assignment + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -6144,24 +6334,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - 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}/snapshots: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments: get: tags: - CloudInfrastructure - summary: returns snapshots - description: returns snapshots - operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots + summary: returns group-assignments + description: returns group-assignments + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments produces: - application/json - application/xml @@ -6169,7 +6359,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/snapshots" + $ref: "#/getDefinitions/group-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6195,12 +6385,12 @@ paths: 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}/images/image/{image-id}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship consumes: - application/json - application/xml @@ -6223,15 +6413,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: image-id + - name: snapshot-id in: path - description: Image id, expected to be unique across cloud region + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string - example: __IMAGE-ID__ + example: __SNAPSHOT-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: $ref: "#/definitions/relationship" @@ -6240,7 +6430,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship consumes: - application/json - application/xml @@ -6263,19 +6453,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: image-id + - name: snapshot-id in: path - description: Image id, expected to be unique across cloud region + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. 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}: + example: __SNAPSHOT-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: get: tags: - CloudInfrastructure - summary: returns metadatum - description: returns metadatum - operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + summary: returns snapshot + description: returns snapshot + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot produces: - application/json - application/xml @@ -6283,7 +6473,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/metadatum" + $ref: "#/getDefinitions/snapshot" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6299,17 +6489,12 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -6320,9 +6505,9 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: image-name + - name: snapshot-name in: query - description: Image name + description: Snapshot name required: false type: string - name: application @@ -6340,15 +6525,20 @@ paths: description: The version of the application. required: false type: string + - name: prev-snapshot-id + in: query + description: This field contains the UUID of the previous snapshot (if any). + required: false + type: string put: tags: - CloudInfrastructure - summary: create or update an existing metadatum + summary: create or update an existing snapshot description: | - Create or update an existing metadatum. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json - application/xml @@ -6371,29 +6561,24 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - name: body in: body - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) + description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: - $ref: "#/definitions/metadatum" + $ref: "#/definitions/snapshot" patch: tags: - CloudInfrastructure - summary: update an existing metadatum + summary: update an existing snapshot description: | - Update an existing metadatum + 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. @@ -6404,7 +6589,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json - application/xml @@ -6427,29 +6612,24 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: snapshot object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/metadatum" + $ref: "#/patchDefinitions/snapshot" delete: tags: - CloudInfrastructure - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + summary: delete an existing snapshot + description: delete an existing snapshot + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json - application/xml @@ -6472,29 +6652,24 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - 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}/images/image/{image-id}/metadata: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots: get: tags: - CloudInfrastructure - summary: returns metadata - description: returns metadata - operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata + summary: returns snapshots + description: returns snapshots + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots produces: - application/json - application/xml @@ -6502,7 +6677,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/metadata" + $ref: "#/getDefinitions/snapshots" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6518,12 +6693,6 @@ paths: 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) @@ -6534,41 +6703,19 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: - get: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: + put: tags: - CloudInfrastructure - summary: returns image - description: returns image - operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6590,6 +6737,87 @@ paths: required: true type: string example: __IMAGE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - 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__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}: + get: + tags: + - CloudInfrastructure + summary: returns metadatum + description: returns metadatum + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -6623,12 +6851,12 @@ paths: put: tags: - CloudInfrastructure - summary: create or update an existing image + summary: create or update an existing metadatum description: | - Create or update an existing image. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json - application/xml @@ -6657,18 +6885,23 @@ paths: required: true type: string example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ - name: body in: body - description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) required: true schema: - $ref: "#/definitions/image" + $ref: "#/definitions/metadatum" patch: tags: - CloudInfrastructure - summary: update an existing image + summary: update an existing metadatum description: | - Update an existing image + 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. @@ -6679,7 +6912,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json - application/xml @@ -6708,18 +6941,23 @@ paths: required: true type: string example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ - name: body in: body - description: image object that needs to be created or updated. + description: metadatum object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/image" + $ref: "#/patchDefinitions/metadatum" delete: tags: - CloudInfrastructure - summary: delete an existing image - description: delete an existing image - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json - application/xml @@ -6748,18 +6986,23 @@ paths: 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 required: true type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata: get: tags: - CloudInfrastructure - summary: returns images - description: returns images - operationId: getCloudInfrastructureCloudRegionsCloudRegionImages + summary: returns metadata + description: returns metadata + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata produces: - application/json - application/xml @@ -6767,7 +7010,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/images" + $ref: "#/getDefinitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6783,6 +7026,12 @@ paths: 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) @@ -6793,87 +7042,33 @@ paths: 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}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: switch-name - in: path - description: DVS switch name - required: true + - name: image-name + in: query + description: Image name + required: false type: string - example: __SWITCH-NAME__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship - consumes: - - 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 + - name: application + in: query + description: The application that the image instantiates. + required: false type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true + - name: application-vendor + in: query + description: The vendor of the application. + required: false type: string - example: __CLOUD-REGION-ID__ - - name: switch-name - in: path - description: DVS switch name - required: true + - name: application-version + in: query + description: The version of the application. + required: false type: string - example: __SWITCH-NAME__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: get: tags: - CloudInfrastructure - summary: returns dvs-switch - description: returns dvs-switch - operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + summary: returns image + description: returns image + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage produces: - application/json - application/xml @@ -6881,7 +7076,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/dvs-switch" + $ref: "#/getDefinitions/image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6897,12 +7092,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -6913,20 +7108,35 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: vcenter-url + - name: image-name in: query - description: URL used to reach the vcenter + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing dvs-switch + summary: create or update an existing image description: | - Create or update an existing dvs-switch. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json - application/xml @@ -6949,24 +7159,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - name: body in: body - description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) + description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true schema: - $ref: "#/definitions/dvs-switch" + $ref: "#/definitions/image" patch: tags: - CloudInfrastructure - summary: update an existing dvs-switch + summary: update an existing image description: | - Update an existing dvs-switch + 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. @@ -6977,7 +7187,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json - application/xml @@ -7000,24 +7210,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - name: body in: body - description: dvs-switch object that needs to be created or updated. + description: image object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/dvs-switch" + $ref: "#/patchDefinitions/image" delete: tags: - CloudInfrastructure - summary: delete an existing dvs-switch - description: delete an existing dvs-switch - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + summary: delete an existing image + description: delete an existing image + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json - application/xml @@ -7040,24 +7250,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - 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: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: get: tags: - CloudInfrastructure - summary: returns dvs-switches - description: returns dvs-switches - operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches + summary: returns images + description: returns images + operationId: getCloudInfrastructureCloudRegionsCloudRegionImages produces: - application/json - application/xml @@ -7065,7 +7275,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/dvs-switches" + $ref: "#/getDefinitions/images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7091,12 +7301,12 @@ paths: 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: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship consumes: - application/json - application/xml @@ -7119,15 +7329,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: $ref: "#/definitions/relationship" @@ -7136,7 +7346,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship consumes: - application/json - application/xml @@ -7159,19 +7369,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: + example: __SWITCH-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: get: tags: - CloudInfrastructure - summary: returns oam-network - description: returns oam-network - operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + summary: returns dvs-switch + description: returns dvs-switch + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch produces: - application/json - application/xml @@ -7179,7 +7389,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/oam-network" + $ref: "#/getDefinitions/dvs-switch" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7195,12 +7405,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -7211,26 +7421,20 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: network-name + - name: vcenter-url in: query - description: Name of the network. + description: URL used to reach the vcenter required: false type: string - - name: cvlan-tag - in: query - description: cvlan-id - required: false - type: integer - format: int64 put: tags: - CloudInfrastructure - summary: create or update an existing oam-network + summary: create or update an existing dvs-switch description: | - Create or update an existing oam-network. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -7253,24 +7457,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: body in: body - description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: - $ref: "#/definitions/oam-network" + $ref: "#/definitions/dvs-switch" patch: tags: - CloudInfrastructure - summary: update an existing oam-network + summary: update an existing dvs-switch description: | - Update an existing oam-network + 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. @@ -7281,7 +7485,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -7304,24 +7508,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: body in: body - description: oam-network object that needs to be created or updated. + description: dvs-switch object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/oam-network" + $ref: "#/patchDefinitions/dvs-switch" delete: tags: - CloudInfrastructure - summary: delete an existing oam-network - description: delete an existing oam-network - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + summary: delete an existing dvs-switch + description: delete an existing dvs-switch + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -7344,24 +7548,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __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}/oam-networks: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches: get: tags: - CloudInfrastructure - summary: returns oam-networks - description: returns oam-networks - operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks + summary: returns dvs-switches + description: returns dvs-switches + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches produces: - application/json - application/xml @@ -7369,7 +7573,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/oam-networks" + $ref: "#/getDefinitions/dvs-switches" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7395,12 +7599,12 @@ paths: 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}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: + /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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship consumes: - application/json - application/xml @@ -7423,15 +7627,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: availability-zone-name + - name: network-uuid in: path - description: Name of the availability zone. Unique across a cloud region + description: UUID of the network. Unique across a cloud-region required: true type: string - example: __AVAILABILITY-ZONE-NAME__ + example: __NETWORK-UUID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) required: true schema: $ref: "#/definitions/relationship" @@ -7440,7 +7644,311 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + 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) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: network-name + in: query + description: Name of the network. + required: false + type: string + - name: cvlan-tag + in: query + description: cvlan-id + required: false + type: integer + format: int64 + put: + tags: + - CloudInfrastructure + summary: 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 + - 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. [Valid relationship examples shown here](apidocs/relations/v12/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 + summary: delete an existing oam-network + description: delete an existing oam-network + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - 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: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks: + get: + tags: + - CloudInfrastructure + summary: returns oam-networks + description: returns oam-networks + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-networks" + "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: 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}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + consumes: + - 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship consumes: - application/json - application/xml @@ -8087,19 +8595,607 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: vip-ipv6-address + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns vip-ipv6-address-list + description: returns vip-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-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: 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 vip-ipv6-address-list + description: | + Create or update an existing vip-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + 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: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing vip-ipv6-address-list + description: | + Update an existing vip-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + 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: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vip-ipv6-address-list + description: delete an existing vip-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - 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: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute: + get: + tags: + - CloudInfrastructure + summary: returns hpa-feature-attribute + description: returns hpa-feature-attribute + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-feature-attribute" + "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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-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 + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capability + description: returns hpa-capability + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capability" + "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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-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 + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing hpa-capability + description: | + Create or update an existing hpa-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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) + required: true + schema: + $ref: "#/definitions/hpa-capability" + patch: + tags: + - CloudInfrastructure + summary: update an existing hpa-capability + description: | + Update an existing hpa-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: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: hpa-capability object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/hpa-capability" + delete: + tags: + - CloudInfrastructure + summary: delete an existing hpa-capability + description: delete an existing hpa-capability + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + consumes: + - 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: hpa-capability-id in: path - description: IP address + description: UUID to uniquely identify a HPA capability required: true type: string - example: __VIP-IPV6-ADDRESS__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + example: __HPA-CAPABILITY-ID__ + - 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}/hpa-capabilities: get: tags: - CloudInfrastructure - summary: returns vip-ipv6-address-list - description: returns vip-ipv6-address-list - operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities produces: - application/json - application/xml @@ -8107,7 +9203,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/vip-ipv6-address-list" + $ref: "#/getDefinitions/hpa-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8123,12 +9219,6 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -8139,155 +9229,6 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) 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 vip-ipv6-address-list - description: | - Create or update an existing vip-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList - consumes: - - application/json - - application/xml - 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: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - - name: body - in: body - description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/vip-ipv6-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing vip-ipv6-address-list - description: | - Update an existing vip-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList - consumes: - - application/json - - application/xml - 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: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - - name: body - in: body - description: vip-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/vip-ipv6-address-list" - delete: - tags: - - CloudInfrastructure - summary: delete an existing vip-ipv6-address-list - description: delete an existing vip-ipv6-address-list - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList - consumes: - - 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: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: get: tags: @@ -53549,6 +54490,7 @@ definitions: - 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 hpa-capability( hpa-capability 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) @@ -53559,7 +54501,7 @@ definitions: - 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: @@ -53650,6 +54592,11 @@ definitions: type: array items: $ref: "#/definitions/vip-ipv6-address-list" + hpa-capabilities: + type: array + items: + $ref: "#/definitions/hpa-capability" + description: List of cloud-region specific HPA Capabilities cloud-regions: properties: cloud-region: @@ -54452,8 +55399,9 @@ definitions: Openstack flavor. ###### Related Nodes - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER required: - flavor-id - flavor-name @@ -54464,7 +55412,7 @@ definitions: description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string - description: Flavor name + description: Cloud region Flavor name flavor-vcpus: type: integer format: int32 @@ -54493,6 +55441,11 @@ definitions: flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled + hpa-capabilities: + type: array + items: + $ref: "#/definitions/hpa-capability" + description: List of flavor specific HPA Capabilities resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -54942,6 +55895,64 @@ definitions: type: array items: $ref: "#/definitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/definitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + hpa-hw-arch: + type: string + description: Hardware architecture + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + hpa-feature-attribute: + type: array + items: + $ref: "#/definitions/hpa-feature-attribute" + hpa-feature-attribute: + description: | + HPA Capability Feature attributes + properties: + hpa-attr-key: + type: string + description: name of the specific HPA attribute + hpa-attr-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" image: description: | Openstack image. @@ -59058,6 +60069,7 @@ patchDefinitions: - 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 hpa-capability( hpa-capability 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) @@ -59068,7 +60080,7 @@ patchDefinitions: - 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: @@ -59723,8 +60735,9 @@ patchDefinitions: Openstack flavor. ###### Related Nodes - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER required: - flavor-id - flavor-name @@ -59735,7 +60748,7 @@ patchDefinitions: description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string - description: Flavor name + description: Cloud region Flavor name flavor-vcpus: type: integer format: int32 @@ -59764,6 +60777,11 @@ patchDefinitions: flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled + hpa-capabilities: + type: array + items: + $ref: "#/patchDefinitions/hpa-capability" + description: List of flavor specific HPA Capabilities flavors: description: | Collection of openstack flavors. @@ -60066,6 +61084,46 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/patchDefinitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + hpa-hw-arch: + type: string + description: Hardware architecture + hpa-feature-attribute: + description: | + HPA Capability Feature attributes + properties: + hpa-attr-key: + type: string + description: name of the specific HPA attribute + hpa-attr-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute image: description: | Openstack image. @@ -63299,6 +64357,7 @@ getDefinitions: - 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 hpa-capability( hpa-capability 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) @@ -63309,7 +64368,7 @@ getDefinitions: - 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: @@ -63400,6 +64459,11 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/vip-ipv6-address-list" + hpa-capabilities: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + description: List of cloud-region specific HPA Capabilities cloud-regions: properties: cloud-region: @@ -64202,8 +65266,9 @@ getDefinitions: Openstack flavor. ###### Related Nodes - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER required: - flavor-id - flavor-name @@ -64214,7 +65279,7 @@ getDefinitions: description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string - description: Flavor name + description: Cloud region Flavor name flavor-vcpus: type: integer format: int32 @@ -64243,6 +65308,11 @@ getDefinitions: flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled + hpa-capabilities: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + description: List of flavor specific HPA Capabilities resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -64692,6 +65762,64 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + hpa-hw-arch: + type: string + description: Hardware architecture + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + hpa-feature-attribute: + type: array + items: + $ref: "#/getDefinitions/hpa-feature-attribute" + hpa-feature-attribute: + description: | + HPA Capability Feature attributes + properties: + hpa-attr-key: + type: string + description: name of the specific HPA attribute + hpa-attr-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" image: description: | Openstack image. diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml index 91ae2515..45033060 100644 --- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml +++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml @@ -5276,12 +5276,12 @@ paths: 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}/flavors/flavor/{flavor-id}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship consumes: - application/json - application/xml @@ -5310,9 +5310,15 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) required: true schema: $ref: "#/definitions/relationship" @@ -5321,7 +5327,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship consumes: - application/json - application/xml @@ -5350,13 +5356,105 @@ paths: required: true type: string example: __FLAVOR-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute: get: tags: - CloudInfrastructure - summary: returns flavor - description: returns flavor - operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + summary: returns hpa-feature-attribute + description: returns hpa-feature-attribute + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute produces: - application/json - application/xml @@ -5364,7 +5462,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/flavor" + $ref: "#/getDefinitions/hpa-feature-attribute" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5386,6 +5484,12 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5398,18 +5502,95 @@ paths: type: string - name: flavor-name in: query - description: Flavor name + description: Cloud Region Flavor name + required: false + type: string + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capability + description: returns hpa-capability + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capability" + "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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-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 + - name: flavor-name + in: query + description: Cloud Region Flavor name + required: false + type: string + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing flavor + summary: create or update an existing hpa-capability description: | - Create or update an existing flavor. + Create or update an existing hpa-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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability consumes: - application/json - application/xml @@ -5438,18 +5619,24 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: body in: body - description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) + description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) required: true schema: - $ref: "#/definitions/flavor" + $ref: "#/definitions/hpa-capability" patch: tags: - CloudInfrastructure - summary: update an existing flavor + summary: update an existing hpa-capability description: | - Update an existing flavor + Update an existing hpa-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. @@ -5460,7 +5647,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability consumes: - application/json - application/xml @@ -5489,18 +5676,24 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - name: body in: body - description: flavor object that needs to be created or updated. + description: hpa-capability object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/flavor" + $ref: "#/patchDefinitions/hpa-capability" delete: tags: - CloudInfrastructure - summary: delete an existing flavor - description: delete an existing flavor - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor + summary: delete an existing hpa-capability + description: delete an existing hpa-capability + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability consumes: - application/json - application/xml @@ -5529,18 +5722,24 @@ paths: required: true type: string example: __FLAVOR-ID__ + - name: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ - 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}/flavors: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities: get: tags: - CloudInfrastructure - summary: returns flavors - description: returns flavors - operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities produces: - application/json - application/xml @@ -5548,7 +5747,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/flavors" + $ref: "#/getDefinitions/hpa-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5564,6 +5763,12 @@ paths: 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) @@ -5574,12 +5779,17 @@ paths: 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}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: + - name: flavor-name + in: query + description: Cloud Region Flavor name + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship consumes: - application/json - application/xml @@ -5602,15 +5812,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: $ref: "#/definitions/relationship" @@ -5619,7 +5829,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship consumes: - application/json - application/xml @@ -5642,19 +5852,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor 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}: + example: __FLAVOR-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: get: tags: - CloudInfrastructure - summary: returns group-assignment - description: returns group-assignment - operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + summary: returns flavor + description: returns flavor + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor produces: - application/json - application/xml @@ -5662,7 +5872,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/group-assignment" + $ref: "#/getDefinitions/flavor" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5678,12 +5888,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5694,25 +5904,20 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: group-type - in: query - description: Group type - the type of group this instance refers to - required: false - type: string - - name: group-name + - name: flavor-name in: query - description: Group name - name assigned to the group + description: Cloud Region Flavor name required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing group-assignment + summary: create or update an existing flavor description: | - Create or update an existing group-assignment. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json - application/xml @@ -5735,24 +5940,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: body in: body - description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) + description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true schema: - $ref: "#/definitions/group-assignment" + $ref: "#/definitions/flavor" patch: tags: - CloudInfrastructure - summary: update an existing group-assignment + summary: update an existing flavor description: | - Update an existing group-assignment + 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. @@ -5763,7 +5968,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json - application/xml @@ -5786,24 +5991,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - name: body in: body - description: group-assignment object that needs to be created or updated. + description: flavor object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/group-assignment" + $ref: "#/patchDefinitions/flavor" delete: tags: - CloudInfrastructure - summary: delete an existing group-assignment - description: delete an existing group-assignment - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment + summary: delete an existing flavor + description: delete an existing flavor + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor consumes: - application/json - application/xml @@ -5826,24 +6031,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: group-id + - name: flavor-id in: path - description: Group id, expected to be unique across cloud-region. + description: Flavor id, expected to be unique across cloud-region. required: true type: string - example: __GROUP-ID__ + example: __FLAVOR-ID__ - 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}/group-assignments: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors: get: tags: - CloudInfrastructure - summary: returns group-assignments - description: returns group-assignments - operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments + summary: returns flavors + description: returns flavors + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors produces: - application/json - application/xml @@ -5851,7 +6056,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/group-assignments" + $ref: "#/getDefinitions/flavors" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5877,12 +6082,12 @@ paths: 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}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -5905,15 +6110,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true schema: $ref: "#/definitions/relationship" @@ -5922,7 +6127,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship consumes: - application/json - application/xml @@ -5945,19 +6150,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: + example: __GROUP-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}: get: tags: - CloudInfrastructure - summary: returns snapshot - description: returns snapshot - operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + summary: returns group-assignment + description: returns group-assignment + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment produces: - application/json - application/xml @@ -5965,7 +6170,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/snapshot" + $ref: "#/getDefinitions/group-assignment" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -5981,12 +6186,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -5997,40 +6202,25 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: snapshot-name - in: query - description: Snapshot name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version + - name: group-type in: query - description: The version of the application. + description: Group type - the type of group this instance refers to required: false type: string - - name: prev-snapshot-id + - name: group-name in: query - description: This field contains the UUID of the previous snapshot (if any). + description: Group name - name assigned to the group required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing snapshot + summary: create or update an existing group-assignment description: | - Create or update an existing snapshot. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -6053,24 +6243,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: body in: body - description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) + description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true schema: - $ref: "#/definitions/snapshot" + $ref: "#/definitions/group-assignment" patch: tags: - CloudInfrastructure - summary: update an existing snapshot + summary: update an existing group-assignment description: | - Update an existing snapshot + 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. @@ -6081,7 +6271,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -6104,24 +6294,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - name: body in: body - description: snapshot object that needs to be created or updated. + description: group-assignment object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/snapshot" + $ref: "#/patchDefinitions/group-assignment" delete: tags: - CloudInfrastructure - summary: delete an existing snapshot - description: delete an existing snapshot - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot + summary: delete an existing group-assignment + description: delete an existing group-assignment + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment consumes: - application/json - application/xml @@ -6144,24 +6334,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: snapshot-id + - name: group-id in: path - description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. + description: Group id, expected to be unique across cloud-region. required: true type: string - example: __SNAPSHOT-ID__ + example: __GROUP-ID__ - 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}/snapshots: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments: get: tags: - CloudInfrastructure - summary: returns snapshots - description: returns snapshots - operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots + summary: returns group-assignments + description: returns group-assignments + operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments produces: - application/json - application/xml @@ -6169,7 +6359,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/snapshots" + $ref: "#/getDefinitions/group-assignments" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6195,12 +6385,12 @@ paths: 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}/images/image/{image-id}/relationship-list/relationship: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship consumes: - application/json - application/xml @@ -6223,15 +6413,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: image-id + - name: snapshot-id in: path - description: Image id, expected to be unique across cloud region + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true type: string - example: __IMAGE-ID__ + example: __SNAPSHOT-ID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: $ref: "#/definitions/relationship" @@ -6240,7 +6430,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship consumes: - application/json - application/xml @@ -6263,19 +6453,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: image-id + - name: snapshot-id in: path - description: Image id, expected to be unique across cloud region + description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. 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}: + example: __SNAPSHOT-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: get: tags: - CloudInfrastructure - summary: returns metadatum - description: returns metadatum - operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + summary: returns snapshot + description: returns snapshot + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot produces: - application/json - application/xml @@ -6283,7 +6473,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/metadatum" + $ref: "#/getDefinitions/snapshot" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6299,17 +6489,12 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -6320,9 +6505,9 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: image-name + - name: snapshot-name in: query - description: Image name + description: Snapshot name required: false type: string - name: application @@ -6340,15 +6525,20 @@ paths: description: The version of the application. required: false type: string + - name: prev-snapshot-id + in: query + description: This field contains the UUID of the previous snapshot (if any). + required: false + type: string put: tags: - CloudInfrastructure - summary: create or update an existing metadatum + summary: create or update an existing snapshot description: | - Create or update an existing metadatum. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json - application/xml @@ -6371,29 +6561,24 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - name: body in: body - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) + description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true schema: - $ref: "#/definitions/metadatum" + $ref: "#/definitions/snapshot" patch: tags: - CloudInfrastructure - summary: update an existing metadatum + summary: update an existing snapshot description: | - Update an existing metadatum + 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. @@ -6404,7 +6589,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json - application/xml @@ -6427,29 +6612,24 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - name: body in: body - description: metadatum object that needs to be created or updated. + description: snapshot object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/metadatum" + $ref: "#/patchDefinitions/snapshot" delete: tags: - CloudInfrastructure - summary: delete an existing metadatum - description: delete an existing metadatum - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + summary: delete an existing snapshot + description: delete an existing snapshot + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot consumes: - application/json - application/xml @@ -6472,29 +6652,24 @@ paths: 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 + - 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: __METANAME__ + example: __SNAPSHOT-ID__ - 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}/images/image/{image-id}/metadata: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots: get: tags: - CloudInfrastructure - summary: returns metadata - description: returns metadata - operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata + summary: returns snapshots + description: returns snapshots + operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots produces: - application/json - application/xml @@ -6502,7 +6677,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/metadata" + $ref: "#/getDefinitions/snapshots" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6518,12 +6693,6 @@ paths: 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) @@ -6534,41 +6703,19 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: image-name - in: query - description: Image name - required: false - type: string - - name: application - in: query - description: The application that the image instantiates. - required: false - type: string - - name: application-vendor - in: query - description: The vendor of the application. - required: false - type: string - - name: application-version - in: query - description: The version of the application. - required: false - type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: - get: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship: + put: tags: - CloudInfrastructure - summary: returns image - description: returns image - operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - application/json + - application/xml produces: - application/json - application/xml responses: - "200": - description: successful operation - schema: - $ref: "#/getDefinitions/image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6590,6 +6737,87 @@ paths: required: true type: string example: __IMAGE-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship + consumes: + - 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__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}: + get: + tags: + - CloudInfrastructure + summary: returns metadatum + description: returns metadatum + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/metadatum" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: 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: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -6623,12 +6851,12 @@ paths: put: tags: - CloudInfrastructure - summary: create or update an existing image + summary: create or update an existing metadatum description: | - Create or update an existing image. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json - application/xml @@ -6657,18 +6885,23 @@ paths: required: true type: string example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ - name: body in: body - description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) + description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) required: true schema: - $ref: "#/definitions/image" + $ref: "#/definitions/metadatum" patch: tags: - CloudInfrastructure - summary: update an existing image + summary: update an existing metadatum description: | - Update an existing image + 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. @@ -6679,7 +6912,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json - application/xml @@ -6708,18 +6941,23 @@ paths: required: true type: string example: __IMAGE-ID__ + - name: metaname + in: path + required: true + type: string + example: __METANAME__ - name: body in: body - description: image object that needs to be created or updated. + description: metadatum object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/image" + $ref: "#/patchDefinitions/metadatum" delete: tags: - CloudInfrastructure - summary: delete an existing image - description: delete an existing image - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage + summary: delete an existing metadatum + description: delete an existing metadatum + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum consumes: - application/json - application/xml @@ -6748,18 +6986,23 @@ paths: 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 required: true type: string - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata: get: tags: - CloudInfrastructure - summary: returns images - description: returns images - operationId: getCloudInfrastructureCloudRegionsCloudRegionImages + summary: returns metadata + description: returns metadata + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata produces: - application/json - application/xml @@ -6767,7 +7010,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/images" + $ref: "#/getDefinitions/metadata" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6783,6 +7026,12 @@ paths: 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) @@ -6793,87 +7042,33 @@ paths: 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}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: - put: - tags: - - CloudInfrastructure - summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - "default": - description: Response codes found in [response codes](https://wiki.onap.org/). - parameters: - - name: cloud-owner - in: path - description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname - required: true - type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true - type: string - example: __CLOUD-REGION-ID__ - - name: switch-name - in: path - description: DVS switch name - required: true + - name: image-name + in: query + description: Image name + required: false type: string - example: __SWITCH-NAME__ - - name: body - in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) - required: true - schema: - $ref: "#/definitions/relationship" - delete: - tags: - - CloudInfrastructure - summary: delete an existing relationship - description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship - consumes: - - 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 + - name: application + in: query + description: The application that the image instantiates. + required: false type: string - example: __CLOUD-OWNER__ - - name: cloud-region-id - in: path - description: Identifier used by the vendor for the region. Second part of composite key - required: true + - name: application-vendor + in: query + description: The vendor of the application. + required: false type: string - example: __CLOUD-REGION-ID__ - - name: switch-name - in: path - description: DVS switch name - required: true + - name: application-version + in: query + description: The version of the application. + required: false type: string - example: __SWITCH-NAME__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: get: tags: - CloudInfrastructure - summary: returns dvs-switch - description: returns dvs-switch - operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + summary: returns image + description: returns image + operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage produces: - application/json - application/xml @@ -6881,7 +7076,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/dvs-switch" + $ref: "#/getDefinitions/image" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -6897,12 +7092,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -6913,20 +7108,35 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: vcenter-url + - name: image-name in: query - description: URL used to reach the vcenter + description: Image name + required: false + type: string + - name: application + in: query + description: The application that the image instantiates. + required: false + type: string + - name: application-vendor + in: query + description: The vendor of the application. + required: false + type: string + - name: application-version + in: query + description: The version of the application. required: false type: string put: tags: - CloudInfrastructure - summary: create or update an existing dvs-switch + summary: create or update an existing image description: | - Create or update an existing dvs-switch. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json - application/xml @@ -6949,24 +7159,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - name: body in: body - description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) + description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true schema: - $ref: "#/definitions/dvs-switch" + $ref: "#/definitions/image" patch: tags: - CloudInfrastructure - summary: update an existing dvs-switch + summary: update an existing image description: | - Update an existing dvs-switch + 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. @@ -6977,7 +7187,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json - application/xml @@ -7000,24 +7210,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - name: body in: body - description: dvs-switch object that needs to be created or updated. + description: image object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/dvs-switch" + $ref: "#/patchDefinitions/image" delete: tags: - CloudInfrastructure - summary: delete an existing dvs-switch - description: delete an existing dvs-switch - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch + summary: delete an existing image + description: delete an existing image + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage consumes: - application/json - application/xml @@ -7040,24 +7250,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: switch-name + - name: image-id in: path - description: DVS switch name + description: Image id, expected to be unique across cloud region required: true type: string - example: __SWITCH-NAME__ + example: __IMAGE-ID__ - 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: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: get: tags: - CloudInfrastructure - summary: returns dvs-switches - description: returns dvs-switches - operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches + summary: returns images + description: returns images + operationId: getCloudInfrastructureCloudRegionsCloudRegionImages produces: - application/json - application/xml @@ -7065,7 +7275,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/dvs-switches" + $ref: "#/getDefinitions/images" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7091,12 +7301,12 @@ paths: 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: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: see node definition for valid relationships - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship consumes: - application/json - application/xml @@ -7119,15 +7329,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: $ref: "#/definitions/relationship" @@ -7136,7 +7346,7 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship consumes: - application/json - application/xml @@ -7159,19 +7369,19 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: + example: __SWITCH-NAME__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: get: tags: - CloudInfrastructure - summary: returns oam-network - description: returns oam-network - operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + summary: returns dvs-switch + description: returns dvs-switch + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch produces: - application/json - application/xml @@ -7179,7 +7389,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/oam-network" + $ref: "#/getDefinitions/dvs-switch" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7195,12 +7405,12 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -7211,26 +7421,20 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) required: false type: string - - name: network-name + - name: vcenter-url in: query - description: Name of the network. + description: URL used to reach the vcenter required: false type: string - - name: cvlan-tag - in: query - description: cvlan-id - required: false - type: integer - format: int64 put: tags: - CloudInfrastructure - summary: create or update an existing oam-network + summary: create or update an existing dvs-switch description: | - Create or update an existing oam-network. + 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -7253,24 +7457,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: body in: body - description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) + description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true schema: - $ref: "#/definitions/oam-network" + $ref: "#/definitions/dvs-switch" patch: tags: - CloudInfrastructure - summary: update an existing oam-network + summary: update an existing dvs-switch description: | - Update an existing oam-network + 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. @@ -7281,7 +7485,7 @@ paths: - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST 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 + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -7304,24 +7508,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __NETWORK-UUID__ + example: __SWITCH-NAME__ - name: body in: body - description: oam-network object that needs to be created or updated. + description: dvs-switch object that needs to be created or updated. required: true schema: - $ref: "#/patchDefinitions/oam-network" + $ref: "#/patchDefinitions/dvs-switch" delete: tags: - CloudInfrastructure - summary: delete an existing oam-network - description: delete an existing oam-network - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + summary: delete an existing dvs-switch + description: delete an existing dvs-switch + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch consumes: - application/json - application/xml @@ -7344,24 +7548,24 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: network-uuid + - name: switch-name in: path - description: UUID of the network. Unique across a cloud-region + description: DVS switch name required: true type: string - example: __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}/oam-networks: + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches: get: tags: - CloudInfrastructure - summary: returns oam-networks - description: returns oam-networks - operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks + summary: returns dvs-switches + description: returns dvs-switches + operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches produces: - application/json - application/xml @@ -7369,7 +7573,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/oam-networks" + $ref: "#/getDefinitions/dvs-switches" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -7395,12 +7599,12 @@ paths: 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}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: + /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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship consumes: - application/json - application/xml @@ -7423,15 +7627,15 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: availability-zone-name + - name: network-uuid in: path - description: Name of the availability zone. Unique across a cloud region + description: UUID of the network. Unique across a cloud-region required: true type: string - example: __AVAILABILITY-ZONE-NAME__ + example: __NETWORK-UUID__ - name: body in: body - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) required: true schema: $ref: "#/definitions/relationship" @@ -7440,7 +7644,311 @@ paths: - CloudInfrastructure summary: delete an existing relationship description: delete an existing relationship - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + 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) + required: false + type: string + - name: owner-defined-type + in: query + description: Cloud-owner defined type indicator (e.g., dcp, lcp) + required: false + type: string + - name: network-name + in: query + description: Name of the network. + required: false + type: string + - name: cvlan-tag + in: query + description: cvlan-id + required: false + type: integer + format: int64 + put: + tags: + - CloudInfrastructure + summary: 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 + - 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. [Valid relationship examples shown here](apidocs/relations/v13/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 + summary: delete an existing oam-network + description: delete an existing oam-network + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork + consumes: + - 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: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks: + get: + tags: + - CloudInfrastructure + summary: returns oam-networks + description: returns oam-networks + operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/oam-networks" + "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: 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}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship + consumes: + - 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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship consumes: - application/json - application/xml @@ -8087,19 +8595,607 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: vip-ipv6-address + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + get: + tags: + - CloudInfrastructure + summary: returns vip-ipv6-address-list + description: returns vip-ipv6-address-list + operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/vip-ipv6-address-list" + "default": + description: Response codes found in [response codes](https://wiki.onap.org/). + parameters: + - name: cloud-owner + in: path + description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname + required: true + type: string + example: __CLOUD-OWNER__ + - name: cloud-region-id + in: path + description: Identifier used by the vendor for the region. Second part of composite key + required: true + type: string + example: __CLOUD-REGION-ID__ + - name: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-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: 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 vip-ipv6-address-list + description: | + Create or update an existing vip-ipv6-address-list. + # + Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + 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: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) + required: true + schema: + $ref: "#/definitions/vip-ipv6-address-list" + patch: + tags: + - CloudInfrastructure + summary: update an existing vip-ipv6-address-list + description: | + Update an existing vip-ipv6-address-list + # + Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. + The PUT operation will entirely replace an existing object. + The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. + # + Other differences between PUT and PATCH are: + # + - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. + - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. + - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. + operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - application/json + - application/xml + 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: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: body + in: body + description: vip-ipv6-address-list object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/vip-ipv6-address-list" + delete: + tags: + - CloudInfrastructure + summary: delete an existing vip-ipv6-address-list + description: delete an existing vip-ipv6-address-list + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + consumes: + - 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: vip-ipv6-address + in: path + description: IP address + required: true + type: string + example: __VIP-IPV6-ADDRESS__ + - name: resource-version + in: query + description: resource-version for concurrency + required: true + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributeRelationshipListRelationship + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute: + get: + tags: + - CloudInfrastructure + summary: returns hpa-feature-attribute + description: returns hpa-feature-attribute + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-feature-attribute" + "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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-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 + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture + required: false + type: string + /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capability + description: returns hpa-capability + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capability" + "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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-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 + - name: hpa-feature + in: query + description: Name of the HPACapability + required: false + type: string + - name: hpa-hw-arch + in: query + description: Hardware architecture + required: false + type: string + put: + tags: + - CloudInfrastructure + summary: create or update an existing hpa-capability + description: | + Create or update an existing hpa-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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) + required: true + schema: + $ref: "#/definitions/hpa-capability" + patch: + tags: + - CloudInfrastructure + summary: update an existing hpa-capability + description: | + Update an existing hpa-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: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + consumes: + - 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: hpa-capability-id + in: path + description: UUID to uniquely identify a HPA capability + required: true + type: string + example: __HPA-CAPABILITY-ID__ + - name: body + in: body + description: hpa-capability object that needs to be created or updated. + required: true + schema: + $ref: "#/patchDefinitions/hpa-capability" + delete: + tags: + - CloudInfrastructure + summary: delete an existing hpa-capability + description: delete an existing hpa-capability + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability + consumes: + - 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: hpa-capability-id in: path - description: IP address + description: UUID to uniquely identify a HPA capability required: true type: string - example: __VIP-IPV6-ADDRESS__ - /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: + example: __HPA-CAPABILITY-ID__ + - 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}/hpa-capabilities: get: tags: - CloudInfrastructure - summary: returns vip-ipv6-address-list - description: returns vip-ipv6-address-list - operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities produces: - application/json - application/xml @@ -8107,7 +9203,7 @@ paths: "200": description: successful operation schema: - $ref: "#/getDefinitions/vip-ipv6-address-list" + $ref: "#/getDefinitions/hpa-capabilities" "default": description: Response codes found in [response codes](https://wiki.onap.org/). parameters: @@ -8123,12 +9219,6 @@ paths: required: true type: string example: __CLOUD-REGION-ID__ - - name: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - name: cloud-type in: query description: Type of the cloud (e.g., openstack) @@ -8139,155 +9229,6 @@ paths: description: Cloud-owner defined type indicator (e.g., dcp, lcp) 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 vip-ipv6-address-list - description: | - Create or update an existing vip-ipv6-address-list. - # - Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below - operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList - consumes: - - application/json - - application/xml - 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: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - - name: body - in: body - description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) - required: true - schema: - $ref: "#/definitions/vip-ipv6-address-list" - patch: - tags: - - CloudInfrastructure - summary: update an existing vip-ipv6-address-list - description: | - Update an existing vip-ipv6-address-list - # - Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. - The PUT operation will entirely replace an existing object. - The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. - # - Other differences between PUT and PATCH are: - # - - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. - operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList - consumes: - - application/json - - application/xml - 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: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - - name: body - in: body - description: vip-ipv6-address-list object that needs to be created or updated. - required: true - schema: - $ref: "#/patchDefinitions/vip-ipv6-address-list" - delete: - tags: - - CloudInfrastructure - summary: delete an existing vip-ipv6-address-list - description: delete an existing vip-ipv6-address-list - operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList - consumes: - - 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: vip-ipv6-address - in: path - description: IP address - required: true - type: string - example: __VIP-IPV6-ADDRESS__ - - name: resource-version - in: query - description: resource-version for concurrency - required: true - type: string /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: get: tags: @@ -53549,6 +54490,7 @@ definitions: - 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 hpa-capability( hpa-capability 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) @@ -53559,7 +54501,7 @@ definitions: - 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: @@ -53650,6 +54592,11 @@ definitions: type: array items: $ref: "#/definitions/vip-ipv6-address-list" + hpa-capabilities: + type: array + items: + $ref: "#/definitions/hpa-capability" + description: List of cloud-region specific HPA Capabilities cloud-regions: properties: cloud-region: @@ -54452,8 +55399,9 @@ definitions: Openstack flavor. ###### Related Nodes - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER required: - flavor-id - flavor-name @@ -54464,7 +55412,7 @@ definitions: description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string - description: Flavor name + description: Cloud Region Flavor name flavor-vcpus: type: integer format: int32 @@ -54493,6 +55441,11 @@ definitions: flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled + hpa-capabilities: + type: array + items: + $ref: "#/definitions/hpa-capability" + description: List of flavor specific HPA Capabilities resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -54942,6 +55895,64 @@ definitions: type: array items: $ref: "#/definitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/definitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + hpa-hw-arch: + type: string + description: Hardware architecture + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" + hpa-feature-attribute: + type: array + items: + $ref: "#/definitions/hpa-feature-attribute" + hpa-feature-attribute: + description: | + HPA Capability Feature attributes + properties: + hpa-attr-key: + type: string + description: name of the specific HPA attribute + hpa-attr-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/definitions/relationship" image: description: | Openstack image. @@ -59058,6 +60069,7 @@ patchDefinitions: - 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 hpa-capability( hpa-capability 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) @@ -59068,7 +60080,7 @@ patchDefinitions: - 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: @@ -59723,8 +60735,9 @@ patchDefinitions: Openstack flavor. ###### Related Nodes - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER required: - flavor-id - flavor-name @@ -59735,7 +60748,7 @@ patchDefinitions: description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string - description: Flavor name + description: Cloud Region Flavor name flavor-vcpus: type: integer format: int32 @@ -59764,6 +60777,11 @@ patchDefinitions: flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled + hpa-capabilities: + type: array + items: + $ref: "#/patchDefinitions/hpa-capability" + description: List of flavor specific HPA Capabilities flavors: description: | Collection of openstack flavors. @@ -60066,6 +61084,46 @@ patchDefinitions: type: array items: $ref: "#/patchDefinitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/patchDefinitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + hpa-hw-arch: + type: string + description: Hardware architecture + hpa-feature-attribute: + description: | + HPA Capability Feature attributes + properties: + hpa-attr-key: + type: string + description: name of the specific HPA attribute + hpa-attr-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute image: description: | Openstack image. @@ -63299,6 +64357,7 @@ getDefinitions: - 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 hpa-capability( hpa-capability 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) @@ -63309,7 +64368,7 @@ getDefinitions: - 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,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP + - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO required: @@ -63400,6 +64459,11 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/vip-ipv6-address-list" + hpa-capabilities: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + description: List of cloud-region specific HPA Capabilities cloud-regions: properties: cloud-region: @@ -64202,8 +65266,9 @@ getDefinitions: Openstack flavor. ###### Related Nodes - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE) - - FLAVOR cannot be deleted if linked to VSERVER + - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER required: - flavor-id - flavor-name @@ -64214,7 +65279,7 @@ getDefinitions: description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string - description: Flavor name + description: Cloud Region Flavor name flavor-vcpus: type: integer format: int32 @@ -64243,6 +65308,11 @@ getDefinitions: flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled + hpa-capabilities: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + description: List of flavor specific HPA Capabilities resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. @@ -64692,6 +65762,64 @@ getDefinitions: type: array items: $ref: "#/getDefinitions/host-route" + hpa-capabilities: + description: | + Collection of HPA Capabilities + properties: + hpa-capability: + type: array + items: + $ref: "#/getDefinitions/hpa-capability" + hpa-capability: + description: | + Represents a HPA capability + ###### Related Nodes + - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE) + - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE) + required: + - hpa-capability-id + - hpa-feature + properties: + hpa-capability-id: + type: string + description: UUID to uniquely identify a HPA capability + hpa-feature: + type: string + description: Name of the HPACapability + hpa-version: + type: string + description: HPA schema version + hpa-hw-arch: + type: string + description: Hardware architecture + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" + hpa-feature-attribute: + type: array + items: + $ref: "#/getDefinitions/hpa-feature-attribute" + hpa-feature-attribute: + description: | + HPA Capability Feature attributes + properties: + hpa-attr-key: + type: string + description: name of the specific HPA attribute + hpa-attr-value: + type: string + description: JSON string specifying the value, unit and type of the specific HPA attribute + resource-version: + type: string + description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. + relationship-list: + type: array + items: + $ref: "#/getDefinitions/relationship" image: description: | Openstack image.