diff options
4 files changed, 8836 insertions, 28 deletions
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 @@ -172,6 +172,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </td> </tr> <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities</a></td> + <td><p>returns hpa-capabilities</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>returns hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>create or update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>delete an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>returns hpa-feature-attribute</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship</a></td> <td><p>see node definition for valid relationships</p> </td> @@ -217,6 +267,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </td> </tr> <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities</a></td> + <td><p>returns hpa-capabilities</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>returns hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>create or update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>delete an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute</a></td> + <td><p>returns hpa-feature-attribute</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images</a></td> <td><p>returns images</p> </td> @@ -18282,7 +18382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen flavor-name </td> <td> - <p>Flavor name</p> + <p>Cloud region Flavor name</p> </td> <td>query</td> <td> @@ -18713,6 +18813,1553 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capabilities</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capabilities</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + flavor-name + </td> + <td> + <p>Cloud region Flavor name</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capabilities">/hpa-capabilities</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capability</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + flavor-name + </td> + <td> + <p>Cloud region Flavor name</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">create or update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>create or update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch" class="swagger--panel-operation-patch panel"> + <div class="panel-heading"> + <div class="operation-summary">update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated.</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/patchDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + resource-version + </td> + <td> + <p>resource-version for concurrency</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-feature-attribute</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-feature-attribute</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + flavor-name + </td> + <td> + <p>Cloud region Flavor name</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-feature-attribute">/hpa-feature-attribute</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-"></span> <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel"> <div class="panel-heading"> @@ -19868,6 +21515,1348 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capabilities</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capabilities</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capabilities">/hpa-capabilities</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capability</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">create or update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>create or update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch" class="swagger--panel-operation-patch panel"> + <div class="panel-heading"> + <div class="operation-summary">update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated.</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/patchDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + resource-version + </td> + <td> + <p>resource-version for concurrency</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-feature-attribute</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-feature-attribute</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-feature-attribute">/hpa-feature-attribute</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-relationship-list-relationship-"></span> + <div id="operation--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" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-relationship-list-relationship-"></span> + <div id="operation--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" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-"></span> <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get" class="swagger--panel-operation-get panel"> <div class="panel-heading"> @@ -168515,6 +171504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> +<li>FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> @@ -168525,7 +171515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)</li> <li>FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)</li> -<li>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</li> +<li>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</li> <li>CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE</li> <li>CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO</li></ul> @@ -168919,6 +171909,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </section> </div> </dd> + <dt data-property-name="hpa-capabilities"> + <span class="json-property-name">hpa-capabilities:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-capability">hpa-capability</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> </dl> </section> </div> @@ -172316,8 +175326,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <h6 id="related-nodes">Related Nodes</h6> <ul> <li>TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> +<li>FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)</li> <li>FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)</li> -<li>FLAVOR cannot be deleted if linked to VSERVER</li></ul> +<li>FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER</li></ul> </section> @@ -172344,7 +175355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <span class="json-property-required"></span> </dt> <dd> - <p>Flavor name</p> + <p>Cloud region Flavor name</p> <div class="json-inner-schema"> </div> @@ -172458,6 +175469,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </dd> + <dt data-property-name="hpa-capabilities"> + <span class="json-property-name">hpa-capabilities:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-capability">hpa-capability</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> <dt data-property-name="relationship-list"> <span class="json-property-name">relationship-list:</span> <span class="json-property-type">object[]</span> @@ -174152,6 +177183,251 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </section> </div> </div> + <div id="definition-hpa-capabilities" class="panel panel-definition"> + <div class="panel-heading"> + <h3 class="panel-title"><a name="/definitions/hpa-capabilities"></a>hpa-capabilities: + <span class="json-property-type"><span class="json-property-type">object</span> + <span class="json-property-range" title="Value limits"></span> + + </span> + </h3> + </div> + <div class="panel-body"> + <section class="json-schema-description"> + <p>Collection of HPA Capabilities</p> + + </section> + + <section class="json-schema-properties"> + <dl> + <dt data-property-name="hpa-capability"> + <span class="json-property-name">hpa-capability:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-capability">hpa-capability</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + </dl> + </section> + </div> + </div> + <div id="definition-hpa-capability" class="panel panel-definition"> + <div class="panel-heading"> + <h3 class="panel-title"><a name="/definitions/hpa-capability"></a>hpa-capability: + <span class="json-property-type"><span class="json-property-type">object</span> + <span class="json-property-range" title="Value limits"></span> + + </span> + </h3> + </div> + <div class="panel-body"> + <section class="json-schema-description"> + <p>Represents a HPA capability</p> +<h6 id="related-nodes">Related Nodes</h6> +<ul> +<li>TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)</li> +<li>TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li></ul> + + </section> + + <section class="json-schema-properties"> + <dl> + <dt data-property-name="hpa-capability-id"> + <span class="json-property-name">hpa-capability-id:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + <span class="json-property-required"></span> + </dt> + <dd> + <p>UUID to uniquely identify a HPA capability</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-feature"> + <span class="json-property-name">hpa-feature:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + <span class="json-property-required"></span> + </dt> + <dd> + <p>Name of the HPACapability</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-version"> + <span class="json-property-name">hpa-version:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>HPA schema version</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-hw-arch"> + <span class="json-property-name">hpa-hw-arch:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>Hardware architecture</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="resource-version"> + <span class="json-property-name">resource-version:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="relationship-list"> + <span class="json-property-name">relationship-list:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + <dt data-property-name="hpa-feature-attribute"> + <span class="json-property-name">hpa-feature-attribute:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-feature-attribute">hpa-feature-attribute</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + </dl> + </section> + </div> + </div> + <div id="definition-hpa-feature-attribute" class="panel panel-definition"> + <div class="panel-heading"> + <h3 class="panel-title"><a name="/definitions/hpa-feature-attribute"></a>hpa-feature-attribute: + <span class="json-property-type"><span class="json-property-type">object</span> + <span class="json-property-range" title="Value limits"></span> + + </span> + </h3> + </div> + <div class="panel-body"> + <section class="json-schema-description"> + <p>HPA Capability Feature attributes</p> + + </section> + + <section class="json-schema-properties"> + <dl> + <dt data-property-name="hpa-attr-key"> + <span class="json-property-name">hpa-attr-key:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>name of the specific HPA attribute</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-attr-value"> + <span class="json-property-name">hpa-attr-value:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>JSON string specifying the value, unit and type of the specific HPA attribute</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="resource-version"> + <span class="json-property-name">resource-version:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="relationship-list"> + <span class="json-property-name">relationship-list:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + </dl> + </section> + </div> + </div> <div id="definition-image" class="panel panel-definition"> <div class="panel-heading"> <h3 class="panel-title"><a name="/definitions/image"></a>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 @@ -172,6 +172,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </td> </tr> <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities</a></td> + <td><p>returns hpa-capabilities</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>returns hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>create or update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>delete an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>returns hpa-feature-attribute</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship</a></td> <td><p>see node definition for valid relationships</p> </td> @@ -217,6 +267,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </td> </tr> <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities</a></td> + <td><p>returns hpa-capabilities</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>returns hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>create or update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>update an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</a></td> + <td><p>delete an existing hpa-capability</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute</a></td> + <td><p>returns hpa-feature-attribute</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--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">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</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</a></td> + <td><p>see node definition for valid relationships</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</a></td> + <td><p>delete an existing relationship</p> + </td> + </tr> + <tr> <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images</a></td> <td><p>returns images</p> </td> @@ -18282,7 +18382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen flavor-name </td> <td> - <p>Flavor name</p> + <p>Cloud Region Flavor name</p> </td> <td>query</td> <td> @@ -18713,6 +18813,1553 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capabilities</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capabilities</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + flavor-name + </td> + <td> + <p>Cloud Region Flavor name</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capabilities">/hpa-capabilities</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capability</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + flavor-name + </td> + <td> + <p>Cloud Region Flavor name</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">create or update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>create or update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch" class="swagger--panel-operation-patch panel"> + <div class="panel-heading"> + <div class="operation-summary">update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated.</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/patchDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + resource-version + </td> + <td> + <p>resource-version for concurrency</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-feature-attribute</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-feature-attribute</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + flavor-name + </td> + <td> + <p>Cloud Region Flavor name</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-feature-attribute">/hpa-feature-attribute</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--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-"></span> + <div id="operation--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" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + flavor-id + </td> + <td> + <p>Flavor id, expected to be unique across cloud-region.</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-"></span> <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel"> <div class="panel-heading"> @@ -19868,6 +21515,1348 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capabilities</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capabilities</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capabilities">/hpa-capabilities</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-capability</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">create or update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>create or update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--patch" class="swagger--panel-operation-patch panel"> + <div class="panel-heading"> + <div class="operation-summary">update an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>update an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>hpa-capability object that needs to be created or updated.</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/patchDefinitions/hpa-capability">/hpa-capability</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing hpa-capability</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing hpa-capability</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + resource-version + </td> + <td> + <p>resource-version for concurrency</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns hpa-feature-attribute</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns hpa-feature-attribute</p> + + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-type + </td> + <td> + <p>Type of the cloud (e.g., openstack)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + owner-defined-type + </td> + <td> + <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-feature + </td> + <td> + <p>Name of the HPACapability</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + hpa-hw-arch + </td> + <td> + <p>Hardware architecture</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-200"> + 200 OK + + </dt> + <dd class="sw-response-200"> + <div class="row"> + <div class="col-md-12"> + <p>successful operation</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + <div class="panel panel-definition"> + + <div class="panel-body"> + <a class="json-schema-ref" href="#/getDefinitions/hpa-feature-attribute">/hpa-feature-attribute</a> + </div> + </div> + </div> + + </div> </dd> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-relationship-list-relationship-"></span> + <div id="operation--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" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttribute.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--hpa-feature-attribute-relationship-list-relationship-"></span> + <div id="operation--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" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attribute/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">see node definition for valid relationships</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>see node definition for valid relationships</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + <div class="row"> + <div class="col-md-6"> + <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)</p> + </p> + </div> + <div class="col-md-6 sw-request-model"> + <div class="panel panel-definition"> + <div class="panel-body"> + <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a> + </div> + </div></div> + </div> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--hpa-capabilities-hpa-capability--hpa-capability-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing relationship</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing relationship</p> + + </section> + <section class="sw-request-body"> + + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + </section> + <section class="sw-request-params"> + <table class="table"> + <thead> + <tr> + <th class="sw-param-name"></th> + <th class="sw-param-description"></th> + <th class="sw-param-type"></th> + <th class="sw-param-data-type"></th> + <th class="sw-param-annotation"></th> + </tr> + </thead> + <tbody> + <tr> + <td> + cloud-owner + </td> + <td> + <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + cloud-region-id + </td> + <td> + <p>Identifier used by the vendor for the region. Second part of composite key</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + <tr> + <td> + hpa-capability-id + </td> + <td> + <p>UUID to uniquely identify a HPA capability</p> + </td> + <td>path</td> + <td> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + <span class="json-property-required"></span> + </td> + </tr> + </tbody> + </table> + </section> + + <section class="sw-responses"> + <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span> + </p> + + <dl> + <dt class="sw-response-default"> + default + + </dt> + <dd class="sw-response-default"> + <div class="row"> + <div class="col-md-12"> + <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p> + + </div> + </div> + <div class="row"> + + <div class="col-md-6 sw-response-model"> + </div> + + </div> </dd> + </dl> + </section> + </div> + </div> + <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-"></span> <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get" class="swagger--panel-operation-get panel"> <div class="panel-heading"> @@ -168515,6 +171504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> +<li>FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> @@ -168525,7 +171515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> <li>FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)</li> <li>FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)</li> -<li>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</li> +<li>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</li> <li>CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE</li> <li>CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO</li></ul> @@ -168919,6 +171909,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </section> </div> </dd> + <dt data-property-name="hpa-capabilities"> + <span class="json-property-name">hpa-capabilities:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-capability">hpa-capability</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> </dl> </section> </div> @@ -172316,8 +175326,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <h6 id="related-nodes">Related Nodes</h6> <ul> <li>TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li> +<li>FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)</li> <li>FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)</li> -<li>FLAVOR cannot be deleted if linked to VSERVER</li></ul> +<li>FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER</li></ul> </section> @@ -172344,7 +175355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <span class="json-property-required"></span> </dt> <dd> - <p>Flavor name</p> + <p>Cloud Region Flavor name</p> <div class="json-inner-schema"> </div> @@ -172458,6 +175469,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </dd> + <dt data-property-name="hpa-capabilities"> + <span class="json-property-name">hpa-capabilities:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-capability">hpa-capability</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> <dt data-property-name="relationship-list"> <span class="json-property-name">relationship-list:</span> <span class="json-property-type">object[]</span> @@ -174152,6 +177183,251 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </section> </div> </div> + <div id="definition-hpa-capabilities" class="panel panel-definition"> + <div class="panel-heading"> + <h3 class="panel-title"><a name="/definitions/hpa-capabilities"></a>hpa-capabilities: + <span class="json-property-type"><span class="json-property-type">object</span> + <span class="json-property-range" title="Value limits"></span> + + </span> + </h3> + </div> + <div class="panel-body"> + <section class="json-schema-description"> + <p>Collection of HPA Capabilities</p> + + </section> + + <section class="json-schema-properties"> + <dl> + <dt data-property-name="hpa-capability"> + <span class="json-property-name">hpa-capability:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-capability">hpa-capability</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + </dl> + </section> + </div> + </div> + <div id="definition-hpa-capability" class="panel panel-definition"> + <div class="panel-heading"> + <h3 class="panel-title"><a name="/definitions/hpa-capability"></a>hpa-capability: + <span class="json-property-type"><span class="json-property-type">object</span> + <span class="json-property-range" title="Value limits"></span> + + </span> + </h3> + </div> + <div class="panel-body"> + <section class="json-schema-description"> + <p>Represents a HPA capability</p> +<h6 id="related-nodes">Related Nodes</h6> +<ul> +<li>TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)</li> +<li>TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li></ul> + + </section> + + <section class="json-schema-properties"> + <dl> + <dt data-property-name="hpa-capability-id"> + <span class="json-property-name">hpa-capability-id:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + <span class="json-property-required"></span> + </dt> + <dd> + <p>UUID to uniquely identify a HPA capability</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-feature"> + <span class="json-property-name">hpa-feature:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + <span class="json-property-required"></span> + </dt> + <dd> + <p>Name of the HPACapability</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-version"> + <span class="json-property-name">hpa-version:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>HPA schema version</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-hw-arch"> + <span class="json-property-name">hpa-hw-arch:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>Hardware architecture</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="resource-version"> + <span class="json-property-name">resource-version:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="relationship-list"> + <span class="json-property-name">relationship-list:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + <dt data-property-name="hpa-feature-attribute"> + <span class="json-property-name">hpa-feature-attribute:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/hpa-feature-attribute">hpa-feature-attribute</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + </dl> + </section> + </div> + </div> + <div id="definition-hpa-feature-attribute" class="panel panel-definition"> + <div class="panel-heading"> + <h3 class="panel-title"><a name="/definitions/hpa-feature-attribute"></a>hpa-feature-attribute: + <span class="json-property-type"><span class="json-property-type">object</span> + <span class="json-property-range" title="Value limits"></span> + + </span> + </h3> + </div> + <div class="panel-body"> + <section class="json-schema-description"> + <p>HPA Capability Feature attributes</p> + + </section> + + <section class="json-schema-properties"> + <dl> + <dt data-property-name="hpa-attr-key"> + <span class="json-property-name">hpa-attr-key:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>name of the specific HPA attribute</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="hpa-attr-value"> + <span class="json-property-name">hpa-attr-value:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>JSON string specifying the value, unit and type of the specific HPA attribute</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="resource-version"> + <span class="json-property-name">resource-version:</span> + <span class="json-property-type">string</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p> + <div class="json-inner-schema"> + + </div> + </dd> + <dt data-property-name="relationship-list"> + <span class="json-property-name">relationship-list:</span> + <span class="json-property-type">object[]</span> + <span class="json-property-range" title="Value limits"></span> + + </dt> + <dd> + + <div class="json-inner-schema"> + + <section class="json-schema-array-items"> + <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + </dl> + </section> + </div> + </div> <div id="definition-image" class="panel panel-definition"> <div class="panel-heading"> <h3 class="panel-title"><a name="/definitions/image"></a>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,6 +5276,514 @@ 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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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/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 hpa-feature-attribute + description: returns hpa-feature-attribute + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute + 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: 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 + /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 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + consumes: + - 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: 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/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: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + consumes: + - 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: 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: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + consumes: + - 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: 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/flavor/{flavor-id}/hpa-capabilities: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capabilities" + "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: 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: put: tags: @@ -5398,7 +5906,7 @@ paths: type: string - name: flavor-name in: query - description: Flavor name + description: Cloud region Flavor name required: false type: string put: @@ -8288,6 +8796,439 @@ paths: 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: 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}/hpa-capabilities: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capabilities" + "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}: 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,6 +5276,514 @@ 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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship: + put: + tags: + - CloudInfrastructure + summary: see node definition for valid relationships + operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) + required: true + schema: + $ref: "#/definitions/relationship" + delete: + tags: + - CloudInfrastructure + summary: delete an existing relationship + description: delete an existing relationship + operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship + consumes: + - 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/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 hpa-feature-attribute + description: returns hpa-feature-attribute + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttribute + 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: 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 + /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 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: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + consumes: + - 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: 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/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: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + consumes: + - 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: 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: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability + consumes: + - 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: 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/flavor/{flavor-id}/hpa-capabilities: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capabilities" + "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: 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship: put: tags: @@ -5398,7 +5906,7 @@ paths: type: string - name: flavor-name in: query - description: Flavor name + description: Cloud Region Flavor name required: false type: string put: @@ -8288,6 +8796,439 @@ paths: 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: 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}/hpa-capabilities: + get: + tags: + - CloudInfrastructure + summary: returns hpa-capabilities + description: returns hpa-capabilities + operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities + produces: + - application/json + - application/xml + responses: + "200": + description: successful operation + schema: + $ref: "#/getDefinitions/hpa-capabilities" + "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}: 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. |