MEC010-2_AppLcm.yaml 84.7 KB
Newer Older
    parameters: []
Elian Kraja's avatar
Elian Kraja committed
  /app_lcm_op_occs/{appLcmOpOccId}:
    get:
      tags:
      - 'app-lcm'
      summary:  'reads the status information of an individual application LCM operation occurrence'
      description: reads the status information of an individual application LCM operation occurrence
Elian Kraja's avatar
Elian Kraja committed
      operationId: appLcmOpOccsbyIdGET
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
      responses:
        '200':
          description: Information about an application LCM operation occurrence was read successfully
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLcmOpOcc'
Elian Kraja's avatar
Elian Kraja committed
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '404':
          description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '406':
          description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/cancel:
    post:
      tags:
      - 'app-lcm'
      summary: 'cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.'
      description: cancel an ongoing application lifecycle operation whose related "Individual application LCM operation occurrence" resource is in "PROCESSING" state.
      operationId: appLcmCancelPOST
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelMode'
        required: true
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed.
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          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.'
          headers: {}
          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.'
          headers: {}
          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'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/fail:
    post:
      tags:
      - 'app-lcm'
      summary: marks an application lifecycle management operation occurrence as "finally failed"
      description: marks an application lifecycle management operation occurrence as "finally failed"
      operationId: appLcmFailPOST
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: Shall be returned when the state of the application lifecycle management operation occurrence has been changed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLcmOpOcc'
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          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.'
          headers: {}
          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.'
          headers: {}
          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'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_lcm_op_occs/{appLcmOpOccId}/retry:
    post:
      tags:
      - 'app-lcm'
      summary: initiate retrying an application lifecycle operation that has experience a temporary failure
      description: initiate retrying an application lifecycle operation that has experience a temporary failure
      operationId: appLcmRetryPOST
      parameters:
      - name: appLcmOpOccId
        in: path
        description: Identifies an individual application LCM operation occurrence
        required: true
        style: simple
        schema:
          type: string
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          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.'
          headers: {}
          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.'
          headers: {}
          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'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /app_instances/{appInstanceId}/configure_platform_for_app:
    post:
      tags:
      - 'app-lcm'
      summary: provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.
      description: provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.
      operationId: appInstancesConfigPlatformPOST
      parameters:
      - name: appInstanceId
        in: path
        description: The identifier of the application instance.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: The payload body in the request contains the information necessary to provide configuration information in AppD
        content:
          application/json:
            schema:
              $ref: './MEC010p2_v221_definitions.yaml#/definitions/ConfigPlatformForAppRequest'
      responses:
        '202':
          description: The request was accepted for processing, but it is possible that the processing is not yet completed
          headers: {}
          content: {}
        '400':
          description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: 'Unauthorized :  used when the client did not submit credentials.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: 'Forbidden :  operation is not allowed given the current status of the resource.'
          headers: {}
          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.'
          headers: {}
          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.'
          headers: {}
          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'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []


components:
  schemas:
    AppLcmOpOcc:
      title: AppLcmOpOcc
      required:
      - id
      - operationState
      - stateEnteredTime
      - startTime
      - lcmOperation
      - _links
      type: object
      properties:
        id:
          type: string
          description: "'Identifier of the subscription to application LCM operation occurrence notification'"
        operationState:
          $ref: '#/components/schemas/OperationState'
        stateEnteredTime:
          $ref: '#/components/schemas/TimeStamp'
        startTime:
          $ref: '#/components/schemas/TimeStamp'
        lcmOperation:
          $ref: '#/components/schemas/LcmOperation'
        operationParams:
          $ref: '#/components/schemas/OperationParams'
        isCancelPending:
          type: boolean
          description: If the application LCM operation occurrence operationState is in "PROCESSING" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.
        cancelMode:
          $ref: '#/components/schemas/CancelMode'

        _links:
          $ref: '#/components/schemas/AppInstanceLcmOpOcc.links'
      description: "'This data type represents an application lifecycle management operation occurrence'"
    
    AppInstanceSubscriptionLinkList:
      required:
        - _links
      properties:
        _links:
          $ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links'

    AppInstanceSubscriptionLinkList._links:
      required:
        - self
      type: object
      properties:
          self:
            type: string
            description: URI referring to a resource
          subscriptions:
            type: array
            items:
              $ref: '#/components/schemas/AppInstanceSubscriptionLinkList._links.subscriptions'

    AppInstanceSubscriptionLinkList._links.subscriptions:
      type: object
      required:
        - href
        - subscriptionType
      properties:
            href:
              type: uri
            subscriptionType:
              $ref: '#/components/schemas/AppInstanceSubscriptionType'


    AppInstanceSubscriptionType:
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: String representing the type of a subscription.
      enum:
          - AppInstanceStateChangeSubscription
          - AppLcmOpOccStateChangeSubscription
          - AppIdentifierCreationSubscription
          - AppIdentifierDeletionSubscription

    OperationParams:
      oneOf:
                - $ref: '#/components/schemas/InstantiateAppRequest'
                - $ref: '#/components/schemas/OperateAppRequest'
                - $ref: '#/components/schemas/TerminateAppRequest'

    CancelMode:
      description: Indicates the intervention action to be taken. GRACEFUL Indicates ongoing resource management operations in the underlying system are allowed to complete execution or time out. FORCED Indicates ongoing resource management operations in the underlying system are to be cancelled without allowing them to complete execution or time out.
      type: string
      enum:
        - GRACEFUL
        - FORCED





    AppInstIdCreationSubscriptionRequest:
      type: object
      required:
        - subscriptionType
        - callbackUri
      properties:
        subscriptionType:
          type: string
        callbackUri:
          type: uri
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'



    AppInstIdDeletionSubscriptionRequest:
      type: object
      required:
        - subscriptionType
        - callbackUri
      properties:
        subscriptionType:
          type: string
          description: Shall be set to "AppIdentifierDeletionSubscription".
        callbackUri:
          type: uri
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'

    AppInstIdCreationSubscriptionInfo:
      type: object
      required:
        - id
        - subscriptionType
        - callbackUri
        - _links
      properties:
        id:
          type: string
        subscriptionType:
          type: string
        callbackUri:
          type: uri
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'
        _links:
          type: object
          required:
            - self
          properties:
            self:
              $ref: '#/components/schemas/LinkType'



    AppInstIdDeletionSubscriptionInfo:
      type: object
      required:
        - id
        - subscriptionType
        - callbackUri
        - _links
      properties:
        id:
          type: string
        subscriptionType:
          type: string
          description: Shall be set to "AppIdentifierDeletionSubscription".
        callbackUri:
          type: uri
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'
        _links:
          type: object
          required:
            - self
          properties:
            self:
              $ref: '#/components/schemas/LinkType'

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


    AppLcmOpOccSubscriptionInfo:
      title: AppLcmOpOccSubscriptionInfo
      required:
      - id
      - subscriptionType
      - callbackUri
      - _links
      type: object
      properties:
        id:
          type: string
          description: Identifier of this subscription resource.
        subscriptionType:
          const: AppLcmOpOccStateChange
          type: string
          description: Shall be set to "AppLcmOpOccStateChangeSubscription".
          examples:
          - AppLcmOpOccStateChange
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
        appLcmOpOccSubscriptionFilter: 
          $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter'
          description: Criteria used to select application LCM operation occurrences on which to send notifications related to this subscription.
        _links:
          $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links'
      description: "'This data type represents a subscription to notifications of application life cycle management operation occurrence'"

Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccSubscriptionInfo.links:
      title: AppLcmOpOccSubscriptionInfo.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    AppInstSubscriptionInfo:
      title: AppInstSubscriptionInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - subscriptionType
      - callbackUri
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: "'Identifier of the subscription to application instance operational state change notification.'"
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          const: AppInstanceStateChange
          type: string
          description: Shall be set to "AppInstanceStateChangeSubscription".
          - AppInstanceStateChangeSubscription
        appInstanceState:
          type: string
          enum:
            - NOT_INSTANTIATED
            - STARTED
            - STOPPED
        appInstanceSubscriptionFilter:
           $ref: '#/components/schemas/AppInstanceSubscriptionFilter'
Elian Kraja's avatar
Elian Kraja committed
        callbackUri:
          type: string
          description: The URI of the endpoint for the subscription related notification to be sent to.
Elian Kraja's avatar
Elian Kraja committed
        _links:
          $ref: '#/components/schemas/AppInstSubscriptionInfo.links'
      description: "'The data type represents a subscription to notification of application instance operational state change.'"
Elian Kraja's avatar
Elian Kraja committed
    AppInstSubscriptionInfo.links:
      title: AppInstSubscriptionInfo.links
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
    AppLcmOpOccSubscriptionRequest:
      title: AppLcmOpOccSubscriptionRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
      - callbackUri
      - subscriptionType
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        appLcmOpOccSubscriptionFilter:
          $ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter'
        callbackUri:
          type: string
Elian Kraja's avatar
Elian Kraja committed
        subscriptionType:
          type: string
          description: Shall be set to "AppLcmOpOccStateChangeSubscription".

Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccSubscriptionFilter:
      title: AppLcmOpOccSubscriptionFilter
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'
        notificationTypes:
          description: Match particular notification types. Permitted values AppLcmOpOccNotification.
Elian Kraja's avatar
Elian Kraja committed
          $ref: '#/components/schemas/NotificationTypes'
        operationStates:
          $ref: '#/components/schemas/OperationStates'
        operationTypes:
          $ref: '#/components/schemas/OperationTypes'
    NotificationTypes:
      title: NotificationTypes
      const: AppLcmOperationOccurrenceNotification
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Match particular notification types.
      examples:
      - AppLcmOperationOccurrenceNotification
Elian Kraja's avatar
Elian Kraja committed
    OperationStates:
      title: OperationStates
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED
      - FAILED_TEMP
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'"
      examples:
      - STARTING
    OperationTypes:
      title: OperationTypes
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - INSTANTIATE
      - OPERATE
      - TERMINATE
      type: string
      description: "'Type of the LCM operation represented by this application instance LCM operation occurrence.'"
      examples:
      - INSTANTIATE

    MepInformation:
      type: object
      required:
        - mepId
      properties:
        mepId:
          type: string
          description: Deployment-specific identifier of MEC platform.
        mepName:
          type: string
          description: Human-readable name of MEC platform  
Elian Kraja's avatar
Elian Kraja committed
    CreateAppInstanceRequest:
      title: CreateAppInstanceRequest
      required:
      - appDId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appDId:
          type: string
          description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceDescription:
          type: string
          description: Human-readable description of the application instance to be created.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceName:
          type: string
          description: Human-readable name of the application instance to be created.
        appPlacementInfo:
          description: Describes the information of selected MEC platform for the application instance to associate
          $ref: '#/components/schemas/MepInformation'
Elian Kraja's avatar
Elian Kraja committed
    AppInstSubscriptionRequest:
      title: AppInstSubscriptionRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
      - subscriptionType
      - callbackUri
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        subscriptionType:
          const: AppInstanceStateChange
          type: string
          description: Shall be set to "AppInstanceStateChangeSubscription".
          examples:
          - AppInstanceStateChange
Elian Kraja's avatar
Elian Kraja committed
        callbackUri:
          type: string
          description: The URI of the endpoint for the notification to be sent to.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceState:
          $ref: '#/components/schemas/AppInstanceState'
        appInstanceSubscriptionFilter:
          $ref: '#/components/schemas/AppInstanceSubscriptionFilter'
    AppInstanceSubscriptionFilter:
      title: AppInstanceSubscriptionFilter
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appInstSelectorType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appInstSelectorType:
          $ref: '#/components/schemas/AppInstSelectorType'
        appInstances:
          type: array
          items:
            type: string
          description: ''
Elian Kraja's avatar
Elian Kraja committed
        appsFromProviders:
          type: array
          items:
            $ref: '#/components/schemas/AppsFromProviders'
          description: ''
      description: "'This data type represents subscription filter criteria to match application instances. '"
Elian Kraja's avatar
Elian Kraja committed
    AppsFromProviders:
      title: AppsFromProviders
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appProvider
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appProvider:
          type: string
          description: Provider of the application and of the AppD.
Elian Kraja's avatar
Elian Kraja committed
        appProducts:
          $ref: '#/components/schemas/AppProducts'
      description: "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'"
Elian Kraja's avatar
Elian Kraja committed
    AppProducts:
      title: AppProducts
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appName
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appName:
          type: string
          description: Name to identify the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        versions:
          $ref: '#/components/schemas/AppProducts.Versions'
      description: "'If present, match application instances that belong to application products with certain product names, from one particular provider.'"
Elian Kraja's avatar
Elian Kraja committed
    AppProducts.Versions:
      title: AppProducts.Versions
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appSoftVersion
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appSoftVersion:
          type: string
          description: Identifies the version of software of the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appDVersion:
          type: array
          items:
            type: string
          description: ''
      description: "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'"
Elian Kraja's avatar
Elian Kraja committed
    AppInstSelectorType:
      title: AppInstSelectorType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - VOID
      - APP_IDENTITY
      - APP_NAME
      - APP_D_ID
      - APP_FROM_PROVIDER
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: 0 = void
      examples:
      - VOID
    AppInstanceState:
      title: AppInstanceState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - NOT_INSTANTIATED
      - STARTED
      - STOPPED
      type: string
      description: Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.
      examples:
      - NOT_INSTANTIATED
Elian Kraja's avatar
Elian Kraja committed
    AppInstNotification:
      title: AppInstNotification
      required:
      - _links
      - appDId
      - appInstanceId
      - appPkgId
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        _links:
          $ref: '#/components/schemas/Links'
Elian Kraja's avatar
Elian Kraja committed
        appDId:
          type: string
          description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceId:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        appPkgId:
          type: string
          description: Identifier of the onboarded application package.
Elian Kraja's avatar
Elian Kraja committed
        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.
Elian Kraja's avatar
Elian Kraja committed
        notificationType:
          type: string
          description: Discriminator for the different notification types. Shall be set to "AppInstanceStateChangeSubscription" for this notification type.
Elian Kraja's avatar
Elian Kraja committed
        subscriptionId:
          type: string
          description: Identifier of the subscription related to this notification.
Elian Kraja's avatar
Elian Kraja committed
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appInstLocation:
          $ref: '#/components/schemas/LocationInformation'
        appInstanceState:
          type: string
          enum:
            - NOT_INSTANTIATED
            - STARTED
            - STOPPED

    LocationInformation:
      type: object
      required:
       - countryCode
      properties:
        countryCode:
          type: string
        civicAddress:
           $ref: '#/components/schemas/LocationInformation.civicAddress'
        geographicalPosition:
          type: string

    LocationInformation.civicAddress:
      type: object
      required:
       - civicAddressElement
      properties:
        civicAddressElement:
          type: array
          items:
            $ref: '#/components/schemas/CivicAddressElement'

    AppInstanceInfo:
      title: AppInstanceInfo
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - appDId
      - appProvider
      - appName
      - appSoftVersion
      - appDVersion
      - appPkgId
      - instantiationState
Elian Kraja's avatar
Elian Kraja committed
      - _links
      type: object
      properties:
        id:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceName:
          type: string
          description: Name of the application instance.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceDescription:
          type: string
          description: Human-readable description of the application instance to be created.
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
        appProvider:
          type: string
          description: Provider of the application and of the AppD.
Elian Kraja's avatar
Elian Kraja committed
        appName:
          type: string
          description: Name to identify the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appSoftVersion:
          type: string
          description: Identifies the version of software of the MEC application.
Elian Kraja's avatar
Elian Kraja committed
        appDVersion:
          type: string
          description: Identifies the version of the application descriptor.
Elian Kraja's avatar
Elian Kraja committed
        appPkgId:
          type: string
          description: Identifier of the onboarded application package.
Elian Kraja's avatar
Elian Kraja committed
        vimConnectionInfo:
          type: array
          items:
            $ref: '#/components/schemas/VimConnectionInfo'
          description: ''
Elian Kraja's avatar
Elian Kraja committed
        instantiationState:
          $ref: '#/components/schemas/InstantiationState'
        instantiatedAppState:
          $ref: '#/components/schemas/InstantiatedAppState'
        _links:
          $ref: '#/components/schemas/AppInstanceInfo.links'
      description: "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'"
Elian Kraja's avatar
Elian Kraja committed
    OperationState:
      title: OperationState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTING
      - PROCESSING
      - COMPLETED
      - FAILED
      - FAILED_TEMP
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Operation state
      examples:
      - STARTING
Elian Kraja's avatar
Elian Kraja committed
    InstantiationState:
      title: InstantiationState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - NOT_INSTANTIATED
      - INSTANTIATED
      type: string
      description: Instantiation state of the application instance
      examples:
      - NOT_INSTANTIATED
Elian Kraja's avatar
Elian Kraja committed
    InstantiatedAppState:
      title: InstantiatedAppState
Elian Kraja's avatar
Elian Kraja committed
      required:
      - operationalState
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        operationalState:
          $ref: '#/components/schemas/OperationalState'
      description: "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'"
Elian Kraja's avatar
Elian Kraja committed
    OperationalState:
      title: OperationalState
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTED
      - STOPPED
      type: string
      description: Operational state is applicable in the instantiation state INSTANTIATED
      examples:
      - STARTED
Elian Kraja's avatar
Elian Kraja committed
    AppInstanceInfo.links:
      title: AppInstanceInfo.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - self
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        instantiate:
          $ref: '#/components/schemas/LinkType'
        terminate:
          $ref: '#/components/schemas/LinkType'
        operate:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    LcmOperation:
      title: LcmOperation
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - INSTATIATE