diff options
Diffstat (limited to 'aai-schema/src/main/resources/aai_swagger_html')
| -rw-r--r-- | aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html | 2532 |
1 files changed, 1462 insertions, 1070 deletions
diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html index dc95e4bf..869ad93d 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html @@ -620,6 +620,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--vip-ipv4-address-list--vip-ipv4-address--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td> + <td><p>returns vip-ipv4-address-list</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td> + <td><p>create or update an existing vip-ipv4-address-list</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td> + <td><p>delete an existing vip-ipv4-address-list</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/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--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/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--vip-ipv6-address-list--vip-ipv6-address--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td> + <td><p>returns vip-ipv6-address-list</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td> + <td><p>create or update an existing vip-ipv6-address-list</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td> + <td><p>delete an existing vip-ipv6-address-list</p> + </td> + </tr> + <tr> + <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/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--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/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--volume-groups-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups</a></td> <td><p>returns volume-groups</p> </td> @@ -4176,56 +4226,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </td> </tr> <tr> - <td><a href="#operation--network-vip-ipv4-address-list--vip-ipv4-address--get">GET /network/vip-ipv4-address-list/{vip-ipv4-address}</a></td> - <td><p>returns vip-ipv4-address-list</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv4-address-list--vip-ipv4-address--put">PUT /network/vip-ipv4-address-list/{vip-ipv4-address}</a></td> - <td><p>create or update an existing vip-ipv4-address-list</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv4-address-list--vip-ipv4-address--delete">DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}</a></td> - <td><p>delete an existing vip-ipv4-address-list</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-put">PUT /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</a></td> - <td><p>see node definition for valid relationships</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-delete">DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</a></td> - <td><p>delete an existing relationship</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv6-address-list--vip-ipv6-address--get">GET /network/vip-ipv6-address-list/{vip-ipv6-address}</a></td> - <td><p>returns vip-ipv6-address-list</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv6-address-list--vip-ipv6-address--put">PUT /network/vip-ipv6-address-list/{vip-ipv6-address}</a></td> - <td><p>create or update an existing vip-ipv6-address-list</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv6-address-list--vip-ipv6-address--delete">DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}</a></td> - <td><p>delete an existing vip-ipv6-address-list</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-put">PUT /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</a></td> - <td><p>see node definition for valid relationships</p> - </td> - </tr> - <tr> - <td><a href="#operation--network-vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-delete">DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</a></td> - <td><p>delete an existing relationship</p> - </td> - </tr> - <tr> <td><a href="#operation--network-vnfcs-get">GET /network/vnfcs</a></td> <td><p>returns vnfcs</p> </td> @@ -32866,6 +32866,1362 @@ 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--vip-ipv4-address-list--vip-ipv4-address--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns vip-ipv4-address-list</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns vip-ipv4-address-list</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> + vip-ipv4-address + </td> + <td> + <p>IP address</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> + vlan-id-inner + </td> + <td> + <p>Inner VLAN tag</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">integer</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + neutron-network-id + </td> + <td> + <p>Neutron network id of the interface that address belongs to</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> + neutron-subnet-id + </td> + <td> + <p>Neutron id of subnet that address belongs to</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="#/definitions/vip-ipv4-address-list">/vip-ipv4-address-list</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--vip-ipv4-address-list--vip-ipv4-address--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">create or update an existing vip-ipv4-address-list</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</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 vip-ipv4-address-list</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>vip-ipv4-address-list 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="#/definitions/vip-ipv4-address-list">/vip-ipv4-address-list</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> + vip-ipv4-address + </td> + <td> + <p>IP address</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--vip-ipv4-address-list--vip-ipv4-address--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing vip-ipv4-address-list</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing vip-ipv4-address-list</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> + vip-ipv4-address + </td> + <td> + <p>IP address</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--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--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}/vip-ipv4-address-list/{vip-ipv4-address}/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</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> + vip-ipv4-address + </td> + <td> + <p>IP address</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--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--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}/vip-ipv4-address-list/{vip-ipv4-address}/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> + vip-ipv4-address + </td> + <td> + <p>IP address</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--vip-ipv6-address-list--vip-ipv6-address--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--get" class="swagger--panel-operation-get panel"> + <div class="panel-heading"> + <div class="operation-summary">returns vip-ipv6-address-list</div> + <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>returns vip-ipv6-address-list</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> + vip-ipv6-address + </td> + <td> + <p>IP address</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> + vlan-id-inner + </td> + <td> + <p>Inner VLAN tag</p> + </td> + <td>query</td> + <td> + <span class="json-property-type">integer</span> + <span class="json-property-range" title="Value limits"></span> + </td> + <td> + </td> + </tr> + <tr> + <td> + neutron-network-id + </td> + <td> + <p>Neutron network id of the interface that address belongs to</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> + neutron-subnet-id + </td> + <td> + <p>Neutron id of subnet that address belongs to</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="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</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--vip-ipv6-address-list--vip-ipv6-address--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--put" class="swagger--panel-operation-put panel"> + <div class="panel-heading"> + <div class="operation-summary">create or update an existing vip-ipv6-address-list</div> + <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</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 vip-ipv6-address-list</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>vip-ipv6-address-list 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="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</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> + vip-ipv6-address + </td> + <td> + <p>IP address</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--vip-ipv6-address-list--vip-ipv6-address--"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--delete" class="swagger--panel-operation-delete panel"> + <div class="panel-heading"> + <div class="operation-summary">delete an existing vip-ipv6-address-list</div> + <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3> + Tags: + <a href="#tag-CloudInfrastructure">CloudInfrastructure</a> + </div> + <div class="panel-body"> + <section class="sw-operation-description"> + <p>delete an existing vip-ipv6-address-list</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> + vip-ipv6-address + </td> + <td> + <p>IP address</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--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--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}/vip-ipv6-address-list/{vip-ipv6-address}/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</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> + vip-ipv6-address + </td> + <td> + <p>IP address</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--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-"></span> + <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--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}/vip-ipv6-address-list/{vip-ipv6-address}/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> + vip-ipv6-address + </td> + <td> + <p>IP address</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--volume-groups-"></span> <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-get" class="swagger--panel-operation-get panel"> <div class="panel-heading"> @@ -116553,982 +117909,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </div> - <span id="path--network-vip-ipv4-address-list--vip-ipv4-address--"></span> - <div id="operation--network-vip-ipv4-address-list--vip-ipv4-address--get" class="swagger--panel-operation-get panel"> - <div class="panel-heading"> - <div class="operation-summary">returns vip-ipv4-address-list</div> - <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3> - Tags: - <a href="#tag-Network">Network</a> - </div> - <div class="panel-body"> - <section class="sw-operation-description"> - <p>returns vip-ipv4-address-list</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> - vip-ipv4-address - </td> - <td> - <p>IP address</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> - vlan-id-inner - </td> - <td> - <p>Inner VLAN tag</p> - </td> - <td>query</td> - <td> - <span class="json-property-type">integer</span> - <span class="json-property-range" title="Value limits"></span> - </td> - <td> - </td> - </tr> - <tr> - <td> - neutron-network-id - </td> - <td> - <p>Neutron network id of the interface that address belongs to</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> - neutron-subnet-id - </td> - <td> - <p>Neutron id of subnet that address belongs to</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="#/definitions/vip-ipv4-address-list">/vip-ipv4-address-list</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--network-vip-ipv4-address-list--vip-ipv4-address--"></span> - <div id="operation--network-vip-ipv4-address-list--vip-ipv4-address--put" class="swagger--panel-operation-put panel"> - <div class="panel-heading"> - <div class="operation-summary">create or update an existing vip-ipv4-address-list</div> - <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3> - Tags: - <a href="#tag-Network">Network</a> - </div> - <div class="panel-body"> - <section class="sw-operation-description"> - <p>create or update an existing vip-ipv4-address-list</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>vip-ipv4-address-list 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="#/definitions/vip-ipv4-address-list">/vip-ipv4-address-list</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> - vip-ipv4-address - </td> - <td> - <p>IP address</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--network-vip-ipv4-address-list--vip-ipv4-address--"></span> - <div id="operation--network-vip-ipv4-address-list--vip-ipv4-address--delete" class="swagger--panel-operation-delete panel"> - <div class="panel-heading"> - <div class="operation-summary">delete an existing vip-ipv4-address-list</div> - <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3> - Tags: - <a href="#tag-Network">Network</a> - </div> - <div class="panel-body"> - <section class="sw-operation-description"> - <p>delete an existing vip-ipv4-address-list</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> - vip-ipv4-address - </td> - <td> - <p>IP address</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--network-vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-"></span> - <div id="operation--network-vip-ipv4-address-list--vip-ipv4-address--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>/network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</strong></h3> - Tags: - <a href="#tag-Network">Network</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</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> - vip-ipv4-address - </td> - <td> - <p>IP address</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--network-vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-"></span> - <div id="operation--network-vip-ipv4-address-list--vip-ipv4-address--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>/network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</strong></h3> - Tags: - <a href="#tag-Network">Network</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> - vip-ipv4-address - </td> - <td> - <p>IP address</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--network-vip-ipv6-address-list--vip-ipv6-address--"></span> - <div id="operation--network-vip-ipv6-address-list--vip-ipv6-address--get" class="swagger--panel-operation-get panel"> - <div class="panel-heading"> - <div class="operation-summary">returns vip-ipv6-address-list</div> - <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3> - Tags: - <a href="#tag-Network">Network</a> - </div> - <div class="panel-body"> - <section class="sw-operation-description"> - <p>returns vip-ipv6-address-list</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> - vip-ipv6-address - </td> - <td> - <p>IP address</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> - vlan-id-inner - </td> - <td> - <p>Inner VLAN tag</p> - </td> - <td>query</td> - <td> - <span class="json-property-type">integer</span> - <span class="json-property-range" title="Value limits"></span> - </td> - <td> - </td> - </tr> - <tr> - <td> - neutron-network-id - </td> - <td> - <p>Neutron network id of the interface that address belongs to</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> - neutron-subnet-id - </td> - <td> - <p>Neutron id of subnet that address belongs to</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="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</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--network-vip-ipv6-address-list--vip-ipv6-address--"></span> - <div id="operation--network-vip-ipv6-address-list--vip-ipv6-address--put" class="swagger--panel-operation-put panel"> - <div class="panel-heading"> - <div class="operation-summary">create or update an existing vip-ipv6-address-list</div> - <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3> - Tags: - <a href="#tag-Network">Network</a> - </div> - <div class="panel-body"> - <section class="sw-operation-description"> - <p>create or update an existing vip-ipv6-address-list</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>vip-ipv6-address-list 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="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</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> - vip-ipv6-address - </td> - <td> - <p>IP address</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--network-vip-ipv6-address-list--vip-ipv6-address--"></span> - <div id="operation--network-vip-ipv6-address-list--vip-ipv6-address--delete" class="swagger--panel-operation-delete panel"> - <div class="panel-heading"> - <div class="operation-summary">delete an existing vip-ipv6-address-list</div> - <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3> - Tags: - <a href="#tag-Network">Network</a> - </div> - <div class="panel-body"> - <section class="sw-operation-description"> - <p>delete an existing vip-ipv6-address-list</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> - vip-ipv6-address - </td> - <td> - <p>IP address</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--network-vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-"></span> - <div id="operation--network-vip-ipv6-address-list--vip-ipv6-address--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>/network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</strong></h3> - Tags: - <a href="#tag-Network">Network</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</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> - vip-ipv6-address - </td> - <td> - <p>IP address</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--network-vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-"></span> - <div id="operation--network-vip-ipv6-address-list--vip-ipv6-address--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>/network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</strong></h3> - Tags: - <a href="#tag-Network">Network</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> - vip-ipv6-address - </td> - <td> - <p>IP address</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--network-vnfcs-"></span> <div id="operation--network-vnfcs-get" class="swagger--panel-operation-get panel"> <div class="panel-heading"> @@ -146922,6 +147302,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>TO group-assignment (comprises cloud-region, One2Many)</li> <li>TO snapshot (comprises cloud-region, One2Many)</li> <li>TO zone (Many2One)</li> +<li>TO vip-ipv4-address-list (comprises cloud-region, One2Many)</li> +<li>TO vip-ipv6-address-list (comprises cloud-region, One2Many)</li> <li>FROM pserver</li> <li>FROM logical-link</li></ul> @@ -147295,6 +147677,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </section> </div> </dd> + <dt data-property-name="vip-ipv4-address-list"> + <span class="json-property-name">vip-ipv4-address-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/vip-ipv4-address-list">vip-ipv4-address-list</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> + <dt data-property-name="vip-ipv6-address-list"> + <span class="json-property-name">vip-ipv6-address-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/vip-ipv6-address-list">vip-ipv6-address-list</a> + </span> + <span class="json-property-range" title="Value limits"></span> + + <div class="json-inner-schema"> + + </div> + </section> </div> + </dd> </dl> </section> </div> @@ -151996,7 +152418,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>FROM pnf</li> <li>FROM allotted-resource</li> <li>FROM generic-vnf</li> -<li>FROM service-instance</li></ul> +<li>FROM service-instance</li> +<li>FROM vip-ipv4-address-list</li> +<li>FROM vip-ipv6-address-list</li></ul> </section> @@ -156783,46 +157207,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen </div> </section> </div> </dd> - <dt data-property-name="vip-ipv4-address-list"> - <span class="json-property-name">vip-ipv4-address-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/vip-ipv4-address-list">vip-ipv4-address-list</a> - </span> - <span class="json-property-range" title="Value limits"></span> - - <div class="json-inner-schema"> - - </div> - </section> </div> - </dd> - <dt data-property-name="vip-ipv6-address-list"> - <span class="json-property-name">vip-ipv6-address-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/vip-ipv6-address-list">vip-ipv6-address-list</a> - </span> - <span class="json-property-range" title="Value limits"></span> - - <div class="json-inner-schema"> - - </div> - </section> </div> - </dd> </dl> </section> </div> @@ -163376,7 +163760,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <li>TO host-route (comprises subnet, One2Many)</li> <li>FROM l3-interface-ipv4-address-list</li> <li>FROM l3-interface-ipv6-address-list</li> -<li>FROM l3-network (is composed of subnet)</li></ul> +<li>FROM l3-network (is composed of subnet)</li> +<li>FROM vip-ipv4-address-list</li> +<li>FROM vip-ipv6-address-list</li></ul> </section> @@ -164922,7 +165308,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <p>IPv4 Address Range</p> <h6 id="related-nodes">Related Nodes</h6> <ul> -<li>FROM vnfc</li></ul> +<li>TO instance-group (Many2Many)</li> +<li>TO subnet (Many2Many)</li> +<li>FROM vnfc</li> +<li>FROM cloud-region (is composed of vip-ipv4-address-list)</li></ul> </section> @@ -165063,7 +165452,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen <p>IPv6 Address Range</p> <h6 id="related-nodes">Related Nodes</h6> <ul> -<li>FROM vnfc</li></ul> +<li>TO instance-group (Many2Many)</li> +<li>TO subnet (Many2Many)</li> +<li>FROM vnfc</li> +<li>FROM cloud-region (is composed of vip-ipv6-address-list)</li></ul> </section> |