MEC010-2_AppGrant.yaml 32.5 KB
Newer Older
openapi: 3.1.0
Elian Kraja's avatar
Elian Kraja committed
info:
  title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management'
  description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.'
Muhammad Hamza's avatar
Muhammad Hamza committed
  version: '3.1.1'
  license:
    name: BSD-3-Clause
    url: https://forge.etsi.org/legal-matters
Elian Kraja's avatar
Elian Kraja committed
  contact:
Elian Kraja's avatar
Elian Kraja committed
    url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
    email: cti_support@etsi.org
Muhammad Hamza's avatar
Muhammad Hamza committed
  description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management"
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.01.01_60/gs_MEC01002v030101p.pdf'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
Elian Kraja's avatar
Elian Kraja committed
servers:
  - url: https://localhost/granting/v1
    variables: {}
tags:
  - name: granting
    description: Grant operations
Elian Kraja's avatar
Elian Kraja committed
paths:
Elian Kraja's avatar
Elian Kraja committed
    post:
      tags:
        - granting
      summary: "requests a grant for a particular application lifecycle operation"
      description: requests a grant for a particular application lifecycle operation
Elian Kraja's avatar
Elian Kraja committed
      operationId: grantPOST
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GrantRequest"
        required: true
Elian Kraja's avatar
Elian Kraja committed
      responses:
Elian Kraja's avatar
Elian Kraja committed
          description: grant was created successfully (synchronous mode)
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Grant"
        "202":
          description: the request was accepted for processing
          headers: {}
          content: {}
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      deprecated: false
    parameters: []
  /grants/{grantId}:
Elian Kraja's avatar
Elian Kraja committed
    get:
      tags:
        - granting
      summary: "read the grant"
      description: read the grant
Elian Kraja's avatar
Elian Kraja committed
      operationId: GrantGET
      parameters:
        - name: grantId
          in: path
          description: Identifier of the individual grant.
          required: true
          style: simple
          schema:
            type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
          description: A representation of the "individual grant" resource
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Grant"
        "202":
          description: returned when the process of creating the grant is ongoing, no grant is available yet
          headers: {}
          content: {}
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      deprecated: false
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
components:
  schemas:
    AppExtCpConfig:
      title: AppExtCpConfig
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        cpInstanceId:
          type: string
          description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created."
Elian Kraja's avatar
Elian Kraja committed
        cpProtocolData:
          type: array
            $ref: "#/components/schemas/CpProtocolData"
          description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note.
Elian Kraja's avatar
Elian Kraja committed
        linkPortId:
          type: string
          description: Identifier of a pre-configured link port to which the external CP will be associated. See note.
      description: |
        NOTE: The following conditions apply to the attributes "linkPortId" and " cpProtocolData":
              1)  The "linkPortId" and "cpProtocolData" attributes shall both be absent for the deletion of an existing 
                  external CP instance addressed by cpInstanceId.
              2)  At least one of these attributes shall be present for a to-be-created external CP instance or an existing 
                  external CP instance.
              3)  If the "linkPortId" attribute is absent, the MEPM shall create a link port.
              4)  If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a precreated link port, and the MEPM can use means outside the scope of the present document to obtain 
                  the pre-configured address information for the connection point from the resource representing the link port.
              5)  If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that  the 
                  cpProtocolData can be used with the pre-created link port referenced by "linkPortId".
Elian Kraja's avatar
Elian Kraja committed
    AppExtCpData:
      title: AppExtCpData
      required:
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        cpConfig:
          type: array
            $ref: "#/components/schemas/AppExtCpConfig"
          description: List of instance data that need to be configured on the CP instances created from the respective CPD.
Elian Kraja's avatar
Elian Kraja committed
        cpdId:
          type: string
          description: The identifier of the CPD in the AppD.
Elian Kraja's avatar
Elian Kraja committed
    ResourceDefinition.Type:
      title: ResourceDefinition.Type
Elian Kraja's avatar
Elian Kraja committed
      enum:
        - COMPUTE
        - STORAGE
        - LINKPORT
        - OSCONTAINER, see note.
      type: string
Umair Zafar's avatar
Umair Zafar committed
      description: >
        Type of the resource definition referenced.
Elian Kraja's avatar
Elian Kraja committed
    CpProtocolData:
      title: CpProtocolData
      required:
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        ipOverEthernet:
Umair Zafar's avatar
Umair Zafar committed
          type: string
          items:
            $ref: "#/components/schemas/IpOverEthernetAddressData"
          description: | 
            Network address data for IP over Ethernet to assign to the extCP instance. Shall be present
            if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise.
Elian Kraja's avatar
Elian Kraja committed
        layerProtocol:
Umair Zafar's avatar
Umair Zafar committed
          type: string
          items:
            $ref: "#/components/schemas/IpOverEthernetAddressData"
          description: "Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET. See note."
      description: |
        Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET. See note.
        NOTE: This attribute allows to signal the addition of further types of layer and protocol in future
        versions of the present document in a backwards-compatible way. In the current version of the present
        document, only IP over Ethernet is supported.
    ExtLinkPortData:
      title: ExtLinkPortData
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        id:
          type: string
          description: Identifier of this link port as provided by the entity that has created the link port.
Elian Kraja's avatar
Elian Kraja committed
        resourceHandle:
          $ref: "#/components/schemas/ResourceHandle"
    ExtVirtualLinkData:
      title: ExtVirtualLinkData
Elian Kraja's avatar
Elian Kraja committed
      required:
        - extCps
        - id
        - resourceId
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        extCps:
          type: array
          items:
            $ref: "#/components/schemas/AppExtCpData"
          description: External CPs of the application instance to be connected to this external VL.
        extLinkPorts:
Elian Kraja's avatar
Elian Kraja committed
          type: array
            $ref: "#/components/schemas/ExtLinkPortData"
          description: | 
            Externally provided link ports to be used to connect external connection points to this external
            VL. If this attribute is not present, the MEPM shall create the link ports on the external VL.
Elian Kraja's avatar
Elian Kraja committed
        id:
          type: string
          description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance.
Elian Kraja's avatar
Elian Kraja committed
        resourceId:
          type: string
          description: The identifier of the resource in the scope of the VIM.
Elian Kraja's avatar
Elian Kraja committed
        vimConnectionId:
          type: string
          description: Identifier of the VIM connection to manage this resource.
    Grant:
      title: Grant
Elian Kraja's avatar
Elian Kraja committed
      required:
        - id
        - appInstanceId
        - appLcmOpOccId
        - _links
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        id:
          type: string
          description: Identifier of the Grant.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceId:
          type: string
          description: Identifier of the application instance which this Grant is related to.
Elian Kraja's avatar
Elian Kraja committed
        appLcmOpOccId:
          type: string
          description: The identifier of the application lifecycle management operation occurrence associated to the Grant.
Elian Kraja's avatar
Elian Kraja committed
        vimConnections:
          type: array
          description: | 
            Provides information regarding VIM connections that are approved to be used by the MEPM to
            allocate resources, and provides parameters of these VIM connections.See note 1.
Elian Kraja's avatar
Elian Kraja committed
          items:
            $ref: "#/components/schemas/VimConnectionInfo"
Elian Kraja's avatar
Elian Kraja committed
        zones:
          type: array
          items:
            $ref: "#/components/schemas/ZoneInfo"
          description:  Identifies resource zones where the resources are approved to be allocated by the MEPM.
Elian Kraja's avatar
Elian Kraja committed
        zoneGroups:
          type: array
          items:
            $ref: "#/components/schemas/ZoneGroupInfo"
          description: Information about groups of resource zones that are related and that the MEO has chosen to fulfil a zoneGroup 
                        constraint in the Grant request.
Elian Kraja's avatar
Elian Kraja committed
        addResources:
          type: array
          items:
            $ref: "#/components/schemas/GrantInfo"
          description: List of resources that are approved to be added, with one entry per resource.
Elian Kraja's avatar
Elian Kraja committed
        tempResources:
          type: array
          items:
            $ref: "#/components/schemas/GrantInfo"
          description: List of resources that are approved to be temporarily instantiated during the runtime of the lifecycle operation, with 
                        one entry per resource
Elian Kraja's avatar
Elian Kraja committed
        removeResources:
          type: array
          items:
            $ref: "#/components/schemas/GrantInfo"
          description: List of resources that are approved to be removed, with one entry per resource.
Elian Kraja's avatar
Elian Kraja committed
        updateResources:
          type: array
          items:
            $ref: "#/components/schemas/GrantInfo"
          description: List of resources that are approved to be modified, with one entry per resource
Elian Kraja's avatar
Elian Kraja committed
        vimAssets:
          $ref: "#/components/schemas/VimAssets"
          description: Information about assets for the application that are managed by the MEO in the VIM, such as software images.See note 2.
Elian Kraja's avatar
Elian Kraja committed
        extVirtualLinks:
          type: array
          items:
            $ref: "#/components/schemas/ExtVirtualLinkData"
          description: Information about external VLs to connect the application instance to. See note 3.
Elian Kraja's avatar
Elian Kraja committed
        additionalParams:
          $ref: '#/components/schemas/KeyValuePair'
          description: "MEPM, specific to the application and the LCM operation."
Elian Kraja's avatar
Elian Kraja committed
        _links:
          description: Links to resources related to this request.
          $ref: "#/components/schemas/Grant.links"
      description: |
        This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 
        NOTE 1: This interface allows to signal the use of multiple VIMs per application. However, due to the partial support of 
                this feature in the present release, it is recommended in the present document that the number of entries in 
                the "vims" attribute in the Grant is not greater than 1.
        NOTE 2: The further condition will be defined by ETSI GS NFV-SOL 003 [7].
        NOTE 3: External VLs can be passed in the application lifecycle management operation requests such as Instantiate, 
                and/or in the grant response. The MEO may choose to override in the grant response external VL instances 
                that have been passed previously in the associated application lifecycle management request, if the lifecycle 
                management request has originated from the MEO itself
Elian Kraja's avatar
Elian Kraja committed
    VimAssets:
      title: VimAssets
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        softwareImages:
          type: array
          items:
            $ref: "#/components/schemas/VimSoftwareImage"
          description: ""
      description: Information about assets for the application that are managed by the MEO in the VIM, such as software images.
    Grant.links:
      title: Grant.links
Elian Kraja's avatar
Elian Kraja committed
      required:
        - appLcmOpOcc
        - appInstance
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appLcmOpOcc:
          $ref: "#/components/schemas/LinkType"
Elian Kraja's avatar
Elian Kraja committed
        appInstance:
          $ref: "#/components/schemas/LinkType"
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    GrantInfo:
      title: GrantInfo
      required:
        - resourceDefinitionId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        resourceDefinitionId:
          type: string
          description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure.
Elian Kraja's avatar
Elian Kraja committed
        resourceGroupId:
          type: string
          description: | 
            Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned
            to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the
            VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups,
            this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId"
            applies to a single infrastructure resource group, this attribute may be present for new resources.
            This attribute shall be absent for resources that have already been allocated.
Elian Kraja's avatar
Elian Kraja committed
        vimConnectionId:
          type: string
          description: | 
            Identifier of the VIM connection to be used to manage this resource. Shall be present for new
            resources, and shall be absent for resources that have already been allocated.
Elian Kraja's avatar
Elian Kraja committed
        zoneId:
          type: string
          description: |
            Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining
            the resource zone into which this resource is to be placed. Shall be present for new resources
            if the zones concept is applicable to them (typically, Compute resources), and shall be absent
            for resources that have already been allocated.
        containerNamespace:
          type: string
Umair Zafar's avatar
Umair Zafar committed
          description: >
            The value of the namespace in which the MCIOs of an application with containerized components
            shall be deployed. This attribute shall be present if the granted resources are managed by a CISM.
            The attribute shall be absent if the granted resources are not managed by a CISM. See note.
          items:
            $ref: '#/components/schemas/KeyValuePair'
Umair Zafar's avatar
Umair Zafar committed
          description: >
            "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
      description: |
        NOTE: This attribute reflects the ETSI NFV interpretation of the cloud native workloads.
Elian Kraja's avatar
Elian Kraja committed
    GrantRequest:
      title: GrantRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
        - appInstanceId
        - appLcmOpOccId
        - appDId
        - operation
        - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appInstanceId:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        appLcmOpOccId:
          type: string
          description: Identifier of application lifecycle management operation occurrence.
Elian Kraja's avatar
Elian Kraja committed
        appDId:
          type: string
          description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
Elian Kraja's avatar
Elian Kraja committed
        operation:
          $ref: "#/components/schemas/GrantRequest.Operation"
          description: The lifecycle management operation for which granting is requested See notes 1 and 2.
Elian Kraja's avatar
Elian Kraja committed
        addResources:
          type: array
          items:
            $ref: "#/components/schemas/ResourceDefinition"
          description: List of resource definitions in the AppD for resources to be added by the LCM operation which is related to this grant request, with one entry per resource.
Elian Kraja's avatar
Elian Kraja committed
        tempResources:
          type: array
          items:
            $ref: "#/components/schemas/ResourceDefinition"
          description: List of resource definitions in the AppD for resources to be temporarily instantiated during the runtime of the LCM operation which is related to this grant request. See note 3.
Elian Kraja's avatar
Elian Kraja committed
        removeResources:
          type: array
          items:
            $ref: "#/components/schemas/ResourceDefinition"
          description: Removed by the LCM operation which is related to this grant request, with one entry per resource.
Elian Kraja's avatar
Elian Kraja committed
        updateResources:
          type: array
          items:
            $ref: "#/components/schemas/ResourceDefinition"
          description: Provides the definitions of resources to be modified by the LCM operation which is related to this grant request, with one entry per resource.
Elian Kraja's avatar
Elian Kraja committed
        additionalParams:
          $ref: '#/components/schemas/KeyValuePair'
          description: "MEPM, specific to the application and the LCM operation."
Elian Kraja's avatar
Elian Kraja committed
        _links:
          $ref: "#/components/schemas/GrantRequest.links"
      description: |
        This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003
        NOTE 1: Other application LCM operations can be executed by the MEPM without requesting granting.
        NOTE 2: If the granting request is for Instantiate, addResources shall be present.
        NOTE 3: The MEO will assume that the MEPM will be responsible to both allocate and release the temporary 
                resource during the runtime of the LCM operation. This means, the resource can be allocated and 
                consumed after the "start" notification for the LCM operation is sent by the MEPM, and the resource will be
                released before the "result" notification of the application LCM operation is sent by the MEPM.
Elian Kraja's avatar
Elian Kraja committed
    GrantRequest.Operation:
      title: GrantRequest.Operation
Elian Kraja's avatar
Elian Kraja committed
      enum:
        - INSTANTIATE
        - OPERATE
        - TERMINATE
      type: string
      description: "'The lifecycle management operation for which granting is requested'"
      examples:
Elian Kraja's avatar
Elian Kraja committed
    GrantRequest.links:
      title: GrantRequest.links
Elian Kraja's avatar
Elian Kraja committed
      required:
        - appLcmOpOcc
        - appInstance
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appLcmOpOcc:
          $ref: "#/components/schemas/LinkType"
Elian Kraja's avatar
Elian Kraja committed
        appInstance:
          $ref: "#/components/schemas/LinkType"
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    IpOverEthernetAddressData:
      title: IpOverEthernetAddressData
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        macAddress:
          type: string
          description: |
            "'MAC address. If this attribute is not present, it shall be chosen by the VIM. See note 1.'"
Elian Kraja's avatar
Elian Kraja committed
        ipAddresses:
          type: array
          items:
            $ref: "#/components/schemas/IpAddress"
          description: |
            List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned. See note 1.
      description: |
        NOTE 1: At least one of "macAddress" or "ipAddresses" shall be present.
        NOTE 2: Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present.
      description: |
        This data type represents a list of key-value pairs. The order of the pairs in the list is not
        significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with
        the provisions defined in clause 4 of IETF RFC 8259.
      type: object
      properties:
        key:
          type: string
        value:
          type: string

Elian Kraja's avatar
Elian Kraja committed
    IpAddress:
      title: IpAddress
Elian Kraja's avatar
Elian Kraja committed
      required:
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        type:
          $ref: "#/components/schemas/IpAddress.Type"
Elian Kraja's avatar
Elian Kraja committed
        fixedAddresses:
          type: array
          items:
            type: string
          description: Fixed addresses to assign (from the subnet defined by subnetId if provided).
Elian Kraja's avatar
Elian Kraja committed
        numDynamicAddresses:
          type: integer
          description: Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)
          format: int32
Elian Kraja's avatar
Elian Kraja committed
        addressRange:
          $ref: "#/components/schemas/AddressRange"
Elian Kraja's avatar
Elian Kraja committed
        subnetId:
          type: string
          description: Subnet defined by the identifier of the subnet resource in the VIM.
      description: "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'"
Elian Kraja's avatar
Elian Kraja committed
    IpAddress.Type:
      title: IpAddress.Type
Elian Kraja's avatar
Elian Kraja committed
      enum:
      type: string
      description: The type of the IP addresses.
      examples:
Elian Kraja's avatar
Elian Kraja committed
    AddressRange:
      title: AddressRange
Elian Kraja's avatar
Elian Kraja committed
      required:
        - minAddress
        - maxAddress
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        minAddress:
          type: string
          description: Lowest IP address belonging to the range.
Elian Kraja's avatar
Elian Kraja committed
        maxAddress:
          type: string
          description: Highest IP address belonging to the range.
      description: An IP address range to be used, e.g. in case of egress connections.
    LinkType:
      title: LinkType
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        href:
          type: string
          description: URI referring to a resource
Elian Kraja's avatar
Elian Kraja committed
    ProblemDetails:
      title: ProblemDetails
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          format: int32
Elian Kraja's avatar
Elian Kraja committed
        title:
          type: string
          description: A short, human-readable summary of the problem type
Elian Kraja's avatar
Elian Kraja committed
        type:
          type: string
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
Elian Kraja's avatar
Elian Kraja committed
    ResourceDefinition:
      title: ResourceDefinition
Elian Kraja's avatar
Elian Kraja committed
      required:
        - id
        - type
        - resourceTemplateId
        - resource
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: Identifier of the related ResourceDefinition structure from the related GrantRequest structure.
Elian Kraja's avatar
Elian Kraja committed
        type:
          $ref: "#/components/schemas/ResourceDefinition.Type"
          description: Type of the resource definition referenced.See note
Elian Kraja's avatar
Elian Kraja committed
        vduId:
          type: string
          description: Reference to the related VDU in the AppD applicable to this resource.
Elian Kraja's avatar
Elian Kraja committed
        resourceTemplateId:
Umair Zafar's avatar
Umair Zafar committed
          description: >
            Reference to a resource template, in the AppD as follows:
            - If type="COMPUTE": VirtualComputeDescriptor,
            - If type="LINKPORT": AppExtCpd,
            - If type="STORAGE": VirtualStorageDescriptor
            - If type="OSCONTAINER": osContainerDescriptor
            Cardinality may be greater than "1" when
            Type ="OSCONTAINER" and multiple references to
            OsContainerDescriptor are present in the AppD. Cardinality 
            shall be "1" otherwise.
          type: array
          items:
            type: string
Elian Kraja's avatar
Elian Kraja committed
        resource:
          $ref: "#/components/schemas/Resource"
      description: |
        This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003
        NOTE: This permitted value reflects the ETSI NFV interpretation of the cloud native workloads.
Muhammad Hamza's avatar
Muhammad Hamza committed
    
Elian Kraja's avatar
Elian Kraja committed
    Resource:
      title: Resource
Elian Kraja's avatar
Elian Kraja committed
      required:
        - vimConnectionInfo
        - resourceId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        vimConnectionInfo:
          $ref: "#/components/schemas/VimConnectionInfo"
Elian Kraja's avatar
Elian Kraja committed
        resourceId:
          type: string
          description: Identifier of the resource in the scope of the VIM.
      description: Resource information for an existing resource
Elian Kraja's avatar
Elian Kraja committed
    ResourceHandle:
      title: ResourceHandle
      required:
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        resourceId:
          type: string
          description: |
            Identifier of the resource in the scope of the VIM or the CISM or the resource provider. See note 2.
Elian Kraja's avatar
Elian Kraja committed
        vimConnectionId:
          type: string
          description: Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure.
Elian Kraja's avatar
Elian Kraja committed
        vimLevelResourceType:
          type: string
Umair Zafar's avatar
Umair Zafar committed
          description: >
            Type of the resource in the scope of the VIM. See note 1.
      description: |
        NOTE 1: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM and can be used as 
                information that complements the ResourceHandle. This value set is different from the value set of the 
                "type" attribute in the ResourceDefinition.
        NOTE 2: When the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the 
                following way:
                - For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide 
                per resource type.
                - For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, 
                i.e. the value of the 'claimName' field in the Kubernetes® manifest, or a compound name built by 
                Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own 
                manifest.
                - For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value 
                of the 'metadata.name' field in Kubernetes® manifest.
    VimConnectionInfo:
      title: VimConnectionInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        accessInfo:
          type: object
          items:
            $ref: "#/components/schemas/KeyValuePair"
          description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
Elian Kraja's avatar
Elian Kraja committed
        extra:
          type: object
          items:
            $ref: "#/components/schemas/KeyValuePair"
          description: | 
            "'This data type represents a list of key-value pairs. The order of the pairs in the list
            is not significant. In JSON, a set of key-value pairs is represented as an object. It shall
            comply with the provisions defined in clause 4 of IETF RFC 8259'"
Elian Kraja's avatar
Elian Kraja committed
        id:
          type: string
          description: The identifier of the VIM Connection. This identifier is managed by the MEO.
Elian Kraja's avatar
Elian Kraja committed
        interfaceInfo:
          type: object
          items:
            $ref: "#/components/schemas/KeyValuePair"
          description: | 
            "'This data type represents a list of key-value pairs. The order of the pairs in the list
            is not significant. In JSON, a set of key-value pairs is represented as an object. It shall
            comply with the provisions defined in clause 4 of IETF RFC 8259'"
Elian Kraja's avatar
Elian Kraja committed
        vimId:
          type: string
          description: | 
            The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to
            address additional information about the VIM if such information has been configured into the
            MEPM by means outside the scope of the present document, and should be absent otherwise.
Elian Kraja's avatar
Elian Kraja committed
        vimType:
          type: string
          description: | 
            Discriminator for the different types of the VIM information. The value of this attribute
            determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type
            of the VIM.The set of permitted values is expected to change over time as new types or versions
            of VIMs become available.
    VimSoftwareImage:
      title: VimSoftwareImage
Elian Kraja's avatar
Elian Kraja committed
      required:
        - appDSoftwareImageId
        - vimSoftwareImageId
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        appDSoftwareImageId:
          type: string
          description: Identifier which references the software image descriptor in the AppD.
Elian Kraja's avatar
Elian Kraja committed
        vimConnectionId:
          type: string
          description: Identifier of the VIM connection to access the software image referenced in this structure.
Elian Kraja's avatar
Elian Kraja committed
        vimSoftwareImageId:
          type: string
Umair Zafar's avatar
Umair Zafar committed
          description: >
            Identifier of the software image in the resource management layer (i.e. VIM) See note.
      description: |
        NOTE: For an OS container image, the value of this attribute is a string concatenating the name and tag of the image in the CIR separated by a colon ':' with no spaces, e.g. "dbImage:001".
    ZoneGroupInfo:
      title: ZoneGroupInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        zoneId:
          type: array
          items:
            type: string
          description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group.
    ZoneInfo:
      title: ZoneInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        id:
          type: string
          description: Identifier of the connection to the VIM that manages the resource zone. The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the " vimConnectionInfo" attribute of the "AppInstanceInfo" structure.
Elian Kraja's avatar
Elian Kraja committed
          type: string
          description: |
            "Identifier of the connection to the VIM that manages the resource zone.The applicable "VimConnectionInfo" structure, which is referenced byvimConnectionId, can be obtained from the " vimConnectionInfo"
            attribute of the "AppInstanceInfo" structure."
Elian Kraja's avatar
Elian Kraja committed
        zoneId:
          type: string
          description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM).

  responses:
    '400':
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '401':
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '403':
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '404':
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '406':
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    '429':
      description: 'Too Many Requests: used when a rate limiter has triggered.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'