MEC010-2_AppPkgMgmt.yaml

          description: The MEC version that compatible with this application. This information is copied from the AppD.
          items:
            type: string
        onBoardingFailureDetails: 
          description: Failure details of current onboarding procedure
          $ref: '#/components/schemas/ProblemDetails'
        userDefinedData:
          $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'"
        _links:
          $ref: '#/components/schemas/AppPkgInfo.links'
      description: |
        The data type AppPkgInfo represents the parameters for an application package resource
        NOTE 1: The data type of application software image information data model is related to virtualisation method and 
                needs for further study.
        NOTE 2: The data type of additional information of application package artifacts is not specified in the present 
                document.
        NOTE 3: This attribute applies only for the MEAO

    AppPkgInfoModifications:
      title: AppPkgInfoModifications
      required:
      - OperationalState
      type: object
      properties:
        OperationalState:
          $ref: '#/components/schemas/OperationalState2'
      description: "'The data type represents the operational state for an application package resource'"
    
    AppPkg.OperationalState:
      title: AppPkg.OperationalState
      enum:
      - ENABLED
      - DISABLED
      type: string
      description: |
        Operational state of the onboarded application package:
        ENABLED: the application package can be used for instantiation of new application instances.
        DISABLED: the application package cannot be used for further application instantiation requests.
      examples:
      - ENABLED
    
    OnboardingState:
      title: OnboardingState
      enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED
      type: string
      description: Onboarding state of application package
      examples:
      - CREATED
    UsageState:
      title: UsageState
      enum:
      - IN_USE
      - NOT_IN_USE
      type: string
      description: Usage state of the onboarded instance of the application package
      examples:
      - IN_USE
    AppPkgInfo.links:
      title: AppPkgInfo.links
      required:
      - self
      - appD
      - appPkgContent
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        appD:
          $ref: '#/components/schemas/LinkType'
        appPkgContent:
          $ref: '#/components/schemas/LinkType'
        vnfPkgInfo:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.

    AppPkgNotification:
      title: AppPkgNotification
      required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - appPkgId
      - appDId
      - operationalState
      - _links
      type: object
      properties:
        id:
          type: string
          description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all
                      these notifications shall have the same value.
        notificationType:
          $ref: '#/components/schemas/AppPkg.NotificationType'
        subscriptionId:
          type: string
          description: Identifier of the subscription related to this notification.
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appPkgId:
          type: string
          description: Identifier of the onboarded application package.
        appDId:
          type: string
          description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
        operationalState:
          $ref: '#/components/schemas/OperationalState'
        _links:
          $ref: '#/components/schemas/AppPkgNotification.links'
      description: "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'"

    AppPkg.NotificationType:
      title: AppPkg.NotificationType
      enum:
      - AppPackageOnBoarded
      - AppPacakgeEnabled
      - AppPacakgeDisabled
      - AppPackageDeleted
      type: string
      description: Discriminator for the different notification types
      examples:
      - AppPackageOnBoarded
    AppPkgNotification.links:
      title: AppPkgNotification.links
      required:
      - subscription
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.

    AppPkgSubscriptionInfo:
      title: AppPkgSubscriptionInfo
      required:
      - id
      - subscriptionType
      - callbackUri
      - _links
      type: object
      properties:
        id:
          type: string
          description: Identifier of the subscription to application package notification.
        subscriptionType:
          description: Type of subscription.
          $ref: '#/components/schemas/AppPkgSubscriptionType'
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
        _links:
          $ref: '#/components/schemas/AppPkgSubscriptionInfo.links'
      description: "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'"
    
    AppPkgSubscriptionType:
      title: AppPkgSubscriptionType
      enum:
      - AppPackageOnBoardingSubscription
      - AppPackageChangeSubscription
      - AppPackageDeletionSubscription
      type: string
      description: type of a subscription.
      examples:
      - AppPackageOnBoardingSubscription

    AppPkgSubscriptionInfo.links:
      title: AppPkgSubscriptionInfo.links
      required:
      - self
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.

    AppPkgSubscriptionLinkList:
      title: AppPkgSubscriptionLinkList
      required:
      - _links
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links'
      description: "'The data type represents a subscription link list of notification on application package management'"

    AppPkgSubscriptionLinkList.links:
      title: AppPkgSubscriptionLinkList.links
      required:
      - self
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscriptions.AppPkgSubscription'
          description: ''
      description: Links to resources related to this resource.

    Subscriptions.AppPkgSubscription:
      title: Subscriptions.AppPkgSubscription
      required:
      - href
      - subscriptionType
      type: object
      properties:
        href:
          type: string
          description: The URI referring to the subscription.
        subscriptionType:
          $ref: '#/components/schemas/AppPkgSubscriptionType'
      description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'"

    AppPkgSubscription:
      title: AppPkgSubscription
      required:
      - callbackUri
      - subscriptionType
      type: object
      properties:
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
        subscriptionType:
          $ref: '#/components/schemas/AppPkgSubscriptionType'
        appPkgFilter:
          type: array
          items:
            $ref: '#/components/schemas/AppPkgFilter'
          description: The attribute-based filter is to filter application packages on which the query applies
      description: "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'"

    AppPkgFilter:
      title: AppPkgFilter
      type: object
      properties:
        appPkgInfoId:
          type: string
          description: Match the application package identifier which is allocated by the MEO. The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter. see note.
        appDId:
          type: string
          description: Match the application descriptor identifier which is allocated by the application provider. The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter. See note.
        appProvider:
          type: string
          description: Match the provider's name of the onboarded application.
        appName:
          type: string
          description: Match the name of the onboarded application.
        appSoftwareVersion:
          type: string
          description: Match the software version of the application package.
        appDVersion:
          type: string
          description: Match the version of the application descriptor.
        operationalState:
          $ref: '#/components/schemas/OperationalState3'
        usageState:
          type: string
          description: Match particular usage state of the application package. May be present if the "subscriptionType" attribute contains the value "AppPackageChangeSubscription", and shall be absent otherwise.
          enum:
            - N_USE
            - NOT_IN_USE
      description: |
        NOTE: The attributes "appPkgInfoId ", and "appDId" are alternatives to reference particular application package in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.

    Checksum:
      title: Checksum
      required:
      - algorithm
      - hash
      type: object
      properties:
        algorithm:
          type: string
          description: Name of the algorithm used to generate the checksum,  as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.
        hash:
          type: string
          description: "'String 1 The hexadecimal value of the checksum'"

    CreateAppPkg:
      title: CreateAppPkg
      required:
      - appPkgName
      - appPkgPath
      - appPkgVersion
      - checksum
      type: object
      properties:
        appPkgName:
          type: string
          description: Name of the application package to be onboarded.
        appPkgPath:
          type: string
          format: uri
          description: Address information of the application package. See note.
        appPkgVersion:
          type: string
          description: Version of the application package to be onboarded.The appPkgName with appPkgVersion can be used to uniquely identify the application package.
        appProvider:
          type: string
          description: The provider's name of the application package to be onboarded.
        checksum:
          $ref: '#/components/schemas/Checksum'
        userDefinedData:
          $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'"
      description: |
        NOTE: It is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].

    LinkType:
      title: LinkType
      required:
      - href
      type: object
      properties:
        href:
          type: string
          description: URI referring to a resource

    ProblemDetails:
      title: ProblemDetails
      type: object
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          format: int32
        title:
          type: string
          description: A short, human-readable summary of the problem type
        type:
          type: string
          description: A URI reference according to IETF RFC 3986 that identifies the problem type      

    TimeStamp:
      title: TimeStamp
      required:
      - nanoSeconds
      - seconds
      type: object
      properties:
        nanoSeconds:
          type: integer
          description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: int32
        seconds:
          type: integer
          description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: int32

    OperationalState:
      title: OperationalState
      description: |
        Operational state of the application package:

        ENABLED: the application package can be used for instantiation of new application instances.
        DISABLED: the application package cannot be used for further application instantiation requests.
      type: string
      enum:
      - DISABLED
      - ENABLED
      examples:
      - DISABLED
    
    OperationalState2:
      title: OperationalState
      description: |
        New value of the "operationalState" attribute of the "OnboardedAppPkgInfo" structure.
        
        Permitted values
        DISABLED: to disable the individual application package.
        ENABLED: to enable the individual application package.
      type: string
      enum:
      - DISABLED
      - ENABLED
      examples:
      - ENABLED

    OperationalState3:
      title: OperationalState
      description: |
        Match particular operational state of the application package.
        
        ENABLED: the application package can be used for instantiation of new application instances.
        DISABLED: the application package cannot be used for further application instantiation requests.

        May be present if the "subscriptionType" attribute contains the value "AppPackageChangeSubscription",
        and shall be absent otherwise.
      type: string
      enum:
        - ENABLED
        - DISABLED
      examples:
        - DISABLED

  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'

security:
- {}