@itentialopensource/adapter-onap_aai/report/adapter-openapi.yaml

This adapter integrates with ONAP AAI

openapi: 3.0.0
info:
  title: Active and Available Inventory REST API
  description: >2

    [Differences versus the previous schema version](apidocs/aai_swagger_v16.diff)


    Copyright © 2017-18 AT&T Intellectual Property. All rights reserved.


    Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.


    You may obtain a copy of the License at


    (https://creativecommons.org/licenses/by/4.0/)


    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


    This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  contact: {}
  version: 'v16'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/aai/v16
paths:
  ? /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship
  : put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
      description: see node definition for valid relationships
      operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: target-pe
        in: path
        description: The Target provider edge router
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: path
        description: Name of the availability zone
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/relationship-dict'
              - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
      description: delete an existing relationship
      operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: target-pe
        in: path
        description: The Target provider edge router
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: path
        description: Name of the availability zone
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
    get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      description: returns ctag-pool
      operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: target-pe
        in: path
        description: The Target provider edge router
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: path
        description: Name of the availability zone
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ctag-pool1'
                - description: >-
                    A collection of C tags (vlan tags) grouped for a specific purpose.

                    ###### Related Nodes

                    - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)

                    - TO complex (PARENT of ctag-pool, ctag-pool BelongsTo complex, MANY2ONE)(4)

                    - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)

                    - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)


                    -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      description: >
        Create or update an existing ctag-pool.

        #

        Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
      operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: target-pe
        in: path
        description: The Target provider edge router
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: path
        description: Name of the availability zone
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ctag-pool'
              - description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - CloudInfrastructure
      summary: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      description: >
        Update an existing ctag-pool

        #

        Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.

        The PUT operation will entirely replace an existing object.

        The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.

        #

        Other differences between PUT and PATCH are:

        #

        - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.

        - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.

        - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
      operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: target-pe
        in: path
        description: The Target provider edge router
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: path
        description: Name of the availability zone
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ctag-pool object that needs to be updated.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ctag-pool2'
              - description: ctag-pool object that needs to be updated.
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      description: delete an existing ctag-pool
      operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: target-pe
        in: path
        description: The Target provider edge router
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: path
        description: Name of the availability zone
        required: true
        style: simple
        schema:
          type: string
      - name: resource-version
        in: query
        description: resource-version for concurrency
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
    get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureComplexesComplexCtagPools
      description: returns ctag-pools
      operationId: getCloudInfrastructureComplexesComplexCtagPools
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: availability-zone-name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ctag-pools1'
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
    put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
      description: see node definition for valid relationships
      operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/relationship-dict'
              - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
      description: delete an existing relationship
      operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/complexes/complex/{physical-location-id}:
    get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureComplexesComplex
      description: returns complex
      operationId: getCloudInfrastructureComplexesComplex
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/complex1'
                - description: >-
                    Collection of physical locations that can house cloud-regions.

                    ###### Related Nodes

                    - TO l3-network( complex Uses l3-network, MANY2MANY)

                    - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)

                    - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)

                    - FROM ctag-pool (CHILD of complex, ctag-pool BelongsTo complex, MANY2ONE)(1)

                    - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)

                    - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)

                    - FROM pnf( pnf LocatedIn complex, MANY2ONE)

                    - FROM pserver( pserver LocatedIn complex, MANY2ONE)

                    - FROM site-resource( site-resource Uses complex, MANY2MANY)

                    For CCVPN Usecase

                    - FROM vce( vce LocatedIn complex, MANY2MANY)

                    - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)

                    - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)

                    - FROM zone( zone LocatedIn complex, MANY2ONE)


                    -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also

                    -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureComplexesComplex
      description: >
        Create or update an existing complex.

        #

        Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
      operationId: createOrUpdateCloudInfrastructureComplexesComplex
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/complex'
              - description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - CloudInfrastructure
      summary: UpdateCloudInfrastructureComplexesComplex
      description: >
        Update an existing complex

        #

        Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.

        The PUT operation will entirely replace an existing object.

        The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.

        #

        Other differences between PUT and PATCH are:

        #

        - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.

        - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.

        - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
      operationId: UpdateCloudInfrastructureComplexesComplex
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: complex object that needs to be updated.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/complex2'
              - description: complex object that needs to be updated.
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureComplexesComplex
      description: delete an existing complex
      operationId: deleteCloudInfrastructureComplexesComplex
      parameters:
      - name: physical-location-id
        in: path
        description: Unique identifier for physical location, e.g., CLLI
        required: true
        style: simple
        schema:
          type: string
      - name: resource-version
        in: query
        description: resource-version for concurrency
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/complexes:
    get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureComplexes
      description: returns complexes
      operationId: getCloudInfrastructureComplexes
      parameters:
      - name: physical-location-id
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: data-center-code
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: complex-name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: identity-url
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/complexes1'
                - description: Collection of physical locations that can house cloud-regions.
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship
  : put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
      description: see node definition for valid relationships
      operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: path
        description: Unique ID of volume-group.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/relationship-dict'
              - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
      description: delete an existing relationship
      operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: path
        description: Unique ID of volume-group.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
    get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      description: returns volume-group
      operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: path
        description: Unique ID of volume-group.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/volume-group1'
                - description: >-
                    Persistent block-level storage.

                    ###### Related Nodes

                    - TO cloud-region (PARENT of volume-group, volume-group BelongsTo cloud-region, MANY2ONE)

                    - TO complex( volume-group LocatedIn complex, MANY2ONE)

                    - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)

                    - FROM tenant( tenant DependsOn volume-group, ONE2MANY)

                    - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      description: >
        Create or update an existing volume-group.

        #

        Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
      operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: path
        description: Unique ID of volume-group.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/volume-group'
              - description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - CloudInfrastructure
      summary: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      description: >
        Update an existing volume-group

        #

        Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.

        The PUT operation will entirely replace an existing object.

        The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.

        #

        Other differences between PUT and PATCH are:

        #

        - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.

        - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.

        - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
      operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: path
        description: Unique ID of volume-group.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: volume-group object that needs to be updated.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/volume-group2'
              - description: volume-group object that needs to be updated.
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      description: delete an existing volume-group
      operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: path
        description: Unique ID of volume-group.
        required: true
        style: simple
        schema:
          type: string
      - name: resource-version
        in: query
        description: resource-version for concurrency
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
    get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
      description: returns volume-groups
      operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: volume-group-id
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: volume-group-name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: heat-stack-id
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: vnf-type
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/volume-groups1'
                - description: Collection of persistent block-level storage.
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship
  : put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
      description: see node definition for valid relationships
      operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: tenant-id
        in: path
        description: Unique id relative to the cloud-region.
        required: true
        style: simple
        schema:
          type: string
      - name: vserver-id
        in: path
        description: Unique identifier for this vserver relative to its tenant
        required: true
        style: simple
        schema:
          type: string
      - name: volume-id
        in: path
        description: Unique ID of block storage volume relative to the vserver.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/relationship-dict'
              - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CloudInfrastructure
      summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
      description: delete an existing relationship
      operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: tenant-id
        in: path
        description: Unique id relative to the cloud-region.
        required: true
        style: simple
        schema:
          type: string
      - name: vserver-id
        in: path
        description: Unique identifier for this vserver relative to its tenant
        required: true
        style: simple
        schema:
          type: string
      - name: volume-id
        in: path
        description: Unique ID of block storage volume relative to the vserver.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
  ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}
  : get:
      tags:
      - CloudInfrastructure
      summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
      description: returns volume
      operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: tenant-id
        in: path
        description: Unique id relative to the cloud-region.
        required: true
        style: simple
        schema:
          type: string
      - name: vserver-id
        in: path
        description: Unique identifier for this vserver relative to its tenant
        required: true
        style: simple
        schema:
          type: string
      - name: volume-id
        in: path
        description: Unique ID of block storage volume relative to the vserver.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/volume1'
                - description: >-
                    Ephemeral Block storage volume.

                    ###### Related Nodes

                    - FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3)


                    -(3) IF this FROM node is deleted, this VOLUME is DELETED also
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - CloudInfrastructure
      summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
      description: >
        Create or update an existing volume.

        #

        Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
      operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: tenant-id
        in: path
        description: Unique id relative to the cloud-region.
        required: true
        style: simple
        schema:
          type: string
      - name: vserver-id
        in: path
        description: Unique identifier for this vserver relative to its tenant
        required: true
        style: simple
        schema:
          type: string
      - name: volume-id
        in: path
        description: Unique ID of block storage volume relative to the vserver.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/volume'
              - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        default:
          description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054).
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - CloudInfrastructure
      summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
      description: >
        Update an existing volume

        #

        Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.

        The PUT operation will entirely replace an existing object.

        The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.

        #

        Other differences between PUT and PATCH are:

        #

        - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.

        - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.

        - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
      operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
      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
        style: simple
        schema:
          type: string
      - name: cloud-region-id
        in: path
        description: Identifier used by the vendor for the region. Second part of composite key
        required: true
        style: simple
        schema:
          type: string
      - name: tenant-id
        in: path
        description: Unique id relative to the cloud-region.
        required: true
        style: simple
        schema:
          type: string
      - name: vserver-id
        in: path
        description: Unique identifier for this vserver rel