MEC010-2_AppLcm.yaml

    AppInstanceDescription:
      description: Human-readable description of the application instance to be created.
      type: string
    AppDId:
      description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.'
      type: string
    AppProvider:
      description: 'Provider of the application and of the AppD.'
      type: string
    AppName:
      description: 'Name to identify the MEC application.'
      type: string
    AppSoftVersion:
      description: 'Identifies the version of software of the MEC application.'
      type: string
    AppDVersion:
      description: 'Identifies the version of the application descriptor.'
      type: string
    AppPkgId:
      description: Identifier of the onboarded application package.
      type: string
    InstantiationState:
      description: Instantiation state of the application instance
      type: string
      enum:
        - NOT_INSTANTIATED
        - INSTANTIATED
    InstantiatedAppState:
      description: >-
        'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'
      type: object
      required:
        - operationalState
      properties:
        operationalState:
          $ref: '#/components/schemas/OperationalState'
    OperationalState:
      description: Operational state is applicable in the instantiation state INSTANTIATED
      type: string
      enum:
        - STARTED
        - STOPPED
    AppInstanceInfo.links:
      description: >- 
        Links to resources related to this resource.
      type: object
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        instantiate:
          $ref: '#/components/schemas/LinkType'
        terminate:
          $ref: '#/components/schemas/LinkType'
        operate:
          $ref: '#/components/schemas/LinkType'
    LcmOperation:
      description: >-
        Type of the actual LCM operation represented by this application instance LCM operation occurrence
      type: string
      format: enum
      enum:
        - INSTATIATE
        - OPERATE
        - TERMINATE
    AppLcmOpOccNotification:
      description: >-
        'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'
      type: object
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - appLcmOpOccId
        - appInstanceId
        - _links
      properties:
        id:
          $ref: '#/components/schemas/AppLcmOpOccNotification.Id'
        notificationType:
          $ref: '#/components/schemas/AppLcmOpOcc.NotificationType'
        subscriptionId:
          $ref: '#/components/schemas/SubscriptionId'
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appLcmOpOccId:
          $ref: '#/components/schemas/AppLcmOpOccId'
        appInstanceId:
          $ref: '#/components/schemas/AppInstanceId'
        _links:
          $ref: '#/components/schemas/AppLcmOpOccNotification.links'
    AppLcmOpOccNotification.Id:
      description: >-
        ''
      type: string
    AppLcmOpOcc.NotificationType:
      description: >-
        Discriminator for the different notification types
      type: string
      enum:
       - STARTING
       - PROCESSING
       - COMPLETED
       - FAILED
    SubscriptionId:
      description: >-
        Identifier of the subscription related to this notification.
      type: string
    AppLcmOpOccId:
      description: >-
        Identifier of application lifecycle management operation occurrence.
      type: string
    AppLcmOpOccNotification.links:
      description: >- 
        Links to resources related to this resource.
      type: object
      required:
        - appInstance
        - subscription
        - appLcmOpOcc
      properties:
        appInstance:
          $ref: '#/components/schemas/LinkType'
        subscription:
          $ref: '#/components/schemas/LinkType'
        appLcmOpOcc:
          $ref: '#/components/schemas/LinkType'
    InstantiateAppRequest:
      properties:
        locationConstraints:
          # description': Defines the location constraints for the application instance to be created. See note 3.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': LocationConstraints
          $ref: '#/components/schemas/LocationConstraints'
        selectedMECHostInfo:
          description: Describes the information of selected host for the application instance. See note 2.
          items:
            $ref: '#/components/schemas/MECHostInformation'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: MECHostInformation
        vimConnectionInfo:
          description: 'Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.

            This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.'
          items:
            $ref: '#/components/schemas/VimConnectionInfo'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: VimConnectionInfo
        virtualComputeDescriptor:
          # description': Describes CPU, Memory and acceleration requirements of the virtual machine for the application instance to be created. See note 1.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': VirtualComputeDescription
          $ref: '#/components/schemas/VirtualComputeDescription'
        virtualStorageDescriptor:
          description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.
          items:
            $ref: '#/components/schemas/VirtualStorageDescriptor'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: VirtualStorageDescriptor
      required:
      - selectedMECHostInfo
      type: object
      x-etsi-notes: "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only."
      x-etsi-ref: 6.2.2.7
    LinkType:
      properties:
        href:
          description: URI referring to a resource
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
      required:
      - href
      type: object
      x-etsi-ref: 6.5.2
    LocationConstraints:
      description: >-
        'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'
      type: object
      required:
        - countryCode
      properties:
        countryCode:
          $ref: '#/components/schemas/CountryCode'
        civicAddressElement:
          type: array
          items:
            $ref: '#/components/schemas/CivicAddressElement'
    CountryCode:
      description: 'The two-letter ISO 3166 country code in capital letters.'
      type: string
    CivicAddressElement:
      description: >-
        'The civic address.'
      type: object
      required:
        - caType
        - caValue
      properties:
        caType:
          $ref: '#/components/schemas/CaType'
        caValue:
          $ref: '#/components/schemas/CaValue' 
    CaType:
      description: >-
        'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'
      type: integer
    CaValue:
      description: >-
       'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'
      type: string
    MECHostInformation:
      properties:
        hostId:
          #description: 'User defined MEC host ID. '
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: '1'
          #x-etsi-mec-origin-type: KeyValuePairs
        hostName:
          description: Human-readable name of MEC host.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - hostId
      type: object
      x-etsi-ref: 6.2.2.17
    OperateAppRequest:
      properties:
        changeStateTo:
          #description: "The desired operational state: \nSTARTED: the application instance is up and running.\nSTOPPED: the application instance stops operation."
         # x-etsi-mec-cardinality: '1'
          $ref: '#/components/schemas/ChangeStateTo'
        gracefulStopTimeout:
          description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        stopType:
          #description: 'The stop type'
          #x-etsi-mec-cardinality: 0..1
          $ref: '#/components/schemas/StopType'
      required:
      - changeStateTo
      type: object
      x-etsi-notes: "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent."
      x-etsi-ref: 6.2.2.8
    StopType:
      description: >-
        Signals forceful or graceful stop
      type: string
      enum:
        - FORCEFUL
        - GRACEFUL      
    ChangeStateTo:
      description: 'The desired operational state'
      type: string
      format: enum
      enum:
        - STARTED
        - STOPPED
    ProblemDetails:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
    TerminateAppRequest:
      properties:
        gracefulTerminationTimeout:
          description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources."
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Integer
        terminationType:
         # description: 'Indicates whether forceful or graceful termination is requested.'
         # x-etsi-mec-cardinality: '1'
          $ref: '#/components/schemas/TerminationType'
      required:
      - terminationType
      type: object
      x-etsi-notes: "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service."
      x-etsi-ref: 6.2.2.9
    TimeStamp:
      properties:
        nanoSeconds:
          description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC."
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - seconds
      - nanoSeconds
      type: object
      x-etsi-ref: 6.2.5.4
    TerminationType:
      description: >-
        'Indicates whether forceful or graceful termination is requested.'
      type: string
      format: enum
      enum:
        - FORCEFUL
        - GRACEFUL
    VimConnectionInfo:
      properties:
        accessInfo:
          #description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.'
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePairs
        extra:
          #description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType.
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePairs
        id:
          description: The identifier of the VIM Connection. This identifier is managed by the MEO.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        interfaceInfo:
          #description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.'
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePairs
        vimId:
          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.'
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        vimType:
          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. '
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - id
      - vimType
      type: object
      x-etsi-ref: 6.2.2.18
    VirtualComputeDescription:
      description: Ref NFV
      type: string
    VirtualStorageDescriptor:
      description: Ref NFV
      type: string
    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
      additionalProperties: true
      
  responses:
    204:
      description: No Content
    206:
      description: Partial content    
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/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/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/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    409:
      description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when
        using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    414:
      description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
                
    416:
      description: 'Range Not Satisfiable .'               
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              problemDetails:
                type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'