Commit 9a1995f1 authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

fix minor issues in AppPkgMgmt API yaml file

parent f4c064b9
Loading
Loading
Loading
Loading
Loading
+51 −47
Original line number Diff line number Diff line
@@ -1150,7 +1150,7 @@ components:
          type: array
          description: Type of the LCM operation state represented by this application instance LCM operation occurrence.
          items:
            $ref: '#/components/schemas/OperationStates'
            $ref: '#/components/schemas/OperationState'
        operationTypes:
          type: array
          description: Type of the LCM operation represented by this application instance LCM operation occurrence.
@@ -1165,19 +1165,6 @@ components:
      examples:
      - AppLcmOperationOccurrenceNotification

    OperationStates:
      title: OperationStates
      enum:
        - STARTING
        - PROCESSING
        - COMPLETED
        - FAILED
        - FAILED_TEMP
      type: string
      description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'"
      examples:
      - STARTING

    OperationTypes:
      title: OperationTypes
      enum:
@@ -2163,11 +2150,8 @@ components:
        extendedResourceRequests:
          type: array
          items:
            type: object
            description:  |
              An array of key-value pairs of extended resources required by the container see note.
            additionalProperties:
              type: string
            $ref: '#/components/schemas/KeyValuePairs'
          description:  An array of key-value pairs of extended resources required by the container see note.
        cpuResourceLimit:
          type: integer
          description: Number of CPU resources the container can maximally use (e.g. in milli-CPU).
@@ -2270,16 +2254,17 @@ components:
        vduStorageRequirements:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/KeyValuePairs'
          description: An array of key-value pairs that articulate the storage deployment requirements.
          description: Array of key-value pair requirements on the storage for the VDU.
        rdmaEnabled:
          type: boolean
          description: Indicate if the storage support RDMA.
        swImageDesc:
          type: object
          $ref: '#/components/schemas/SwImageDesc'
          description: References the software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. Shall be absent when used for virtual disks. See note.
          description: |
            References the software image to be loaded on the VirtualStorage resource created
            based on this VirtualStorageDesc. Shall be absent when used for virtual disks. See note.

    SwImageDesc:
      type: object
@@ -2395,7 +2380,11 @@ components:
          items:
            $ref: '#/components/schemas/KeyValuePair'

    KeyValuePair:
    KeyValuePairs:
      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:
@@ -2412,16 +2401,21 @@ components:
          type: number
          description: Amount of virtual memory in MB.
        virtualMemOversubscriptionPolicy:
          description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
          type: string
          description: |
            The memory core oversubscription policy in terms of virtual memory to physical memory
            on the platform. The cardinality can be 0 during the allocation request, if no particular
            value is requested.
        vduMemRequirements:
          type: array
          items:
            $ref: '#/components/schemas/KeyValuePair'
            $ref: '#/components/schemas/KeyValuePairs'
          description: Array of key-value pair requirements on the memory for the VDU.
        numaEnabled:
          type: boolean
          description: Specifies the memory allocation to be cognisant of the relevant process/core allocation.
        hugePagesRequirements:
          type: string
          description: Specifies requirements on the huge pages resources for the virtual memory.

    VirtualCpuData:
@@ -2444,11 +2438,9 @@ components:
        vduCpuRequirements:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/KeyValuePairs'
          description: Array of key-value pair requirements on the Compute (CPU) for the VDU.
        virtualCpuPinning:
          type: object
          description: The virtual CPU pinning configuration for the virtualised compute resource. See clause 7.1.9.2.4.
          $ref: '#/components/schemas/VirtualCpuPinningData'

    VirtualCpuPinningData:
@@ -2478,7 +2470,7 @@ components:
          items:
            $ref: '#/components/schemas/CivicAddressElement'
        area:
          type: object
          type: string
          description: Geographic area. Shall be absent if the "civicAddressElement" attribute is present. The content of this attribute shall follow the provisions for the "Polygon" geometry object as defined in IETF RFC 7946 [8], for which the "type" member shall be set to the value "Polygon". See note.

      description: |
@@ -2511,13 +2503,14 @@ components:
      type: object
      properties:
        hostId:
          type: object
          $ref: '#/components/schemas/KeyValuePairs'
          description: Deployment-specific information to identify a MEC host. See note.
        hostName:
          type: string
          description: Human-readable name of MEC host.
      description: |
        NOTE: This information can be structured to cater for host identification schemes that are more complex than a simple identifier, e.g. when referring to the structure of an NFVI.
        NOTE: This information can be structured to cater for host identification schemes that are more 
        complex than a simple identifier, e.g. when referring to the structure of an NFVI.

    OperateAppRequest:
      title: OperateAppRequest
@@ -2633,28 +2626,39 @@ components:
      type: object
      properties:
        accessInfo:
          type: object
          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'"
          $ref: '#/components/schemas/KeyValuePairs'
          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.
        extra:
          type: object
          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'"
          $ref: '#/components/schemas/KeyValuePairs'
          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.
        id:
          type: string
          description: The identifier of the VIM Connection. This identifier is managed by the MEO.
        interfaceInfo:
          type: object
          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'"
          $ref: '#/components/schemas/KeyValuePairs'
          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.
        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.
          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.
        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.
          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.

    Links:
      title: Links