UEAppInterfaceApi.yaml

openapi: 3.0.2
info:
  title: UE Application Interface API
  version: 1.1.1
  description: >-
    The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    email: cti_support@etsi.org
externalDocs:
  description: >-
    ETSI GS MEC016 UE Application Interface API, V1.1.1
  url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/01.01.01_60/gs_MEC016v010101p.pdf
security:
  - OauthSecurity:
      - all
servers:
  - url: http://127.0.0.1:8081/mx2/v1
  - url: https://127.0.0.1:8081/mx2/v1
tags:
  - name: appList
  - name: appContext
  - name: callback
paths:
  "/app_list":
    get:
      description: >-
        Used to query information about the available
        MEC applications.
      operationId: AppList_GET
      tags:
        - appList
      parameters:
        - $ref: "#/components/parameters/Query.AppName"
        - $ref: "#/components/parameters/Query.AppProvider"
        - $ref: "#/components/parameters/Query.AppSoftVersion"
        - $ref: "#/components/parameters/Query.ServiceCont"
        - $ref: "#/components/parameters/Query.VendorId"
      responses:
        "200":
          $ref: '#/components/responses/AppList'
        "400":
          $ref: '#/components/responses/Error.400'
        "401":
          $ref: '#/components/responses/Error.401'
        "403":
          $ref: '#/components/responses/Error.403'
        "404":
          $ref: '#/components/responses/Error.404'
  "/app_contexts":
    post:
      description: >-
        The POST method can be used to create a new application context. Upon
        success, the response contains entity body describing the created
        application context.
      operationId: AppContext_POST
      tags:
        - appContext
      requestBody:
        $ref: "#/components/requestBodies/AppContext"
      responses:
        "201":
          $ref: '#/components/responses/AppContext'
        "400":
          $ref: '#/components/responses/Error.400'
        "401":
          $ref: '#/components/responses/Error.401'
        "403":
          $ref: '#/components/responses/Error.403'
        "404":
          $ref: '#/components/responses/Error.404'
      callbacks:
        referenceURI:
          $ref: '#/components/callbacks/NotificationEvent'
  "/app_contexts/{contextId}":
    parameters:
      - $ref: "#/components/parameters/Path.ContextId"
    put:
      description: >-
        The PUT method is used to update the callback reference of the existing
        application context. Upon successful operation, the target resource is
        updated with new callback reference.
      operationId: AppContextId_PUT
      tags:
        - appContext
      requestBody:
        $ref: "#/components/requestBodies/AppContext"
      responses:
        "204":
          description: No Content.
        "400":
          $ref: '#/components/responses/Error.400'
        "401":
          $ref: '#/components/responses/Error.401'
        "403":
          $ref: '#/components/responses/Error.403'
        "404":
          $ref: '#/components/responses/Error.404'
      callbacks:
        referenceURI:
          $ref: '#/components/callbacks/NotificationEvent'
    delete:
      description: >-
        The DELETE method is used to delete the resource that represents the
        existing application context.
      operationId: AppContextId_DEL
      tags:
        - appContext
      responses:
        "204":
          description: No Content
        "400":
          $ref: '#/components/responses/Error.400'
        "401":
          $ref: '#/components/responses/Error.401'
        "403":
          $ref: '#/components/responses/Error.403'
        "404":
          $ref: '#/components/responses/Error.404'
components:
  callbacks:
    NotificationEvent:
      '{$request.body#/callbackReference}':
        post:
          description: >-
            Used by the UALCMP to inform the UE application of 
            a modification to reference URI of the user application.
          operationId: NotificationEvent_POST
          tags:
            - callback
          requestBody:
            $ref: '#/components/requestBodies/NotificationEvent'
          responses:
            '204':
              description: No Content.
  links:
    PutAppContext:
      operationId: AppContextId_PUT
      description: The `contextId` value returned in the response can be used as the `contextId` parameter in `PUT /app_contexts/{contextId}`
      parameters:
        contextId: '$response.body#/contextId'
    DelAppContext:
      operationId: AppContextId_DEL
      description: The `contextId` value returned in the response can be used as the `contextId` parameter in `DELETE /app_contexts/{contextId}`
      parameters:
        contextId: '$response.body#/contextId'
  parameters:
    Query.AppName:
      name: appName
      in: query
      description: >-
        Name to identify the MEC application
      required: false
      schema:
        type: array
        items:
          type: string
    Query.AppProvider:
      name: appProvider
      in: query
      description: >-
        Provider of the MEC application
      required: false
      schema:
        type: array
        items:
          type: string
    Query.AppSoftVersion:
      name: appSoftVersion
      in: query
      description: >-
        Software version of the MEC application
      required: false
      schema:
        type: array
        items:
          type: string
    Query.ServiceCont:
      name: serviceCont
      in: query
      description: >-
        Required service continuity mode for this application
      required: false
      schema:
        type: string
        enum:
          - SERVICE_CONTINUITY_NOT_REQUIRED
          - SERVICE_CONTINUITY_REQUIRED
    Query.VendorId:
      name: vendorId
      in: query
      description: Vendor identifier
      required: false
      schema:
        type: array
        items:
          type: string
    Path.ContextId:
      name: contextId
      in: path
      description: >-
        Uniquely identifies the application context in the MEC system.
        It is assigned by the MEC system and included in the response to
        an AppContext create.
      required: true
      schema:
        type: string
  requestBodies:
    AppContext:
      description: >- 
        Uniquely identifies the application context in the MEC system.
        It is assigned by the MEC system and included in the response to
        an AppContext create.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AppContext"
      required: true
    NotificationEvent:
      description: >- 
        Sent by the UALCMP to the UE application.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/NotificationEvent"
      required: true
  responses:
    AppContext:
      description: >-
        The response body contains the Application Context as it was created
        by the MEC system
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AppContext"
      links:
        putAppContext:
          $ref: "#/components/links/PutAppContext"
        delAppContext:
          $ref: "#/components/links/DelAppContext"
    AppList:
      description: >-
        The response body contains the ApplicationList resource available
        for the querying UE application
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApplicationList"
    Error.400:
      description: >-
        Bad Request.
        It is used to indicate that incorrect parameters were passed to the request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
        text/plain:
          schema:
            $ref: '#/components/schemas/Empty'
    Error.401:
      description: >-
        Unauthorized.
        It is used when the client did not submit the appropriate credentials.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
        text/plain:
          schema:
            $ref: '#/components/schemas/Empty'
    Error.403:
      description: >-
        Forbidden.
        The operation is not allowed given the current status of the resource. 
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    Error.404:
      description: >-
        Not Found.
        It is 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'
        text/plain:
          schema:
            $ref: '#/components/schemas/Empty'
  securitySchemes:
    OauthSecurity:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://oauth.exampleAPI/token
          scopes:
            all: Single oauth2 scope for API
  schemas:
    Empty:
      description: Empty schema
    ProblemDetails:
      type: object
      properties:
        type:
          $ref: "#/components/schemas/Problem.type"
        title:
          $ref: "#/components/schemas/Problem.title"
        status:
          $ref: "#/components/schemas/Problem.status"
        detail:
          $ref: "#/components/schemas/Problem.detail"
        instance:
          $ref: "#/components/schemas/Problem.instance"
    Problem.type:
      type: string
      format: uri
      description: >-
        A URI reference according to IETF RFC 3986 that identifies the problem
        type
    Problem.title:
      type: string
      description: >-
        A short, human-readable summary of the problem type
    Problem.status:
      type: integer
      format: uint32
      description: >-
        The HTTP status code for this occurrence of the problem
    Problem.detail:
      type: string
      description: >-
        A human-readable explanation specific to this occurrence of the problem
    Problem.instance:
      type: string
      format: uri
      description: >-
        A URI reference that identifies the specific occurrence of the problem
    ApplicationList:
      description: >-
        Information on available applications
      type: object
      properties:
        appInfo:
          $ref: "#/components/schemas/AppInfo"
        vendorSpecificExt:
          $ref: "#/components/schemas/VendorSpecificExt"
    AppContext:
      description: >-
        Information on application context created by the MEC system
      type: object
      required:
        - contextId
        - associateUeAppId
        - callbackReference
        - appInfo
      properties:
        contextId:
          $ref: "#/components/schemas/ContextId"
        associateUeAppId:
          $ref: "#/components/schemas/AssociateUeAppId"
        callbackReference:
          $ref: "#/components/schemas/CallbackReference"
        appInfo:
          $ref: "#/components/schemas/RequiredAppInfo"
    NotificationEvent:
      description: >-
        The parameters used in the method "Receiving notification events".
      type: object
      required:
        - referenceURI
      properties:
        referenceURI:
          $ref: "#/components/schemas/ReferenceURL"
    VendorSpecificExtList:
      description: Extension for vendor specific information.
      type: array
      minItems: 0
      items:
        $ref: "#/components/schemas/VendorSpecificExt"
    VendorSpecificExt:
      description: >-
        Extension for vendor-specific information
      required: 
        - vendorId
      properties:
        vendorId:
          $ref: "#/components/schemas/VendorId"
    ContextId:
      description: >-
        Uniquely identifies the application context in the MEC system.
        Assigned by the MEC system and included in the response. The
        length of the value shall not exceed 32 characters.
      type: string
      readOnly: true
    AssociateUeAppId:
      description: >-
        Uniquely identifies the UE application. Included in the request. The
        length of the value shall not exceed 32 characters.
      type: string
      writeOnly: true
    VendorId:
      description: >-
        Vendor identifier. The length of the value shall not exceed 32
        characters. The rest of the structure of this vendor specific extension
        is not defined
      type: string
    AppInfo:
      description: >-
        User applications available for the UE application
      type: array
      items:
        $ref: "#/components/schemas/AppInfoList"
    AppInfoList:
      type: object
      required:
        - appName
        - appProvider
        - appDescription
      properties:
        appName:
          $ref: "#/components/schemas/AppName"
        appProvider:
          $ref: "#/components/schemas/AppProvider"
        appSoftVersion:
          $ref: "#/components/schemas/AppSoftVersion"
        appDescription:
          $ref: "#/components/schemas/AppDescription"
        appCharcs:
          $ref: "#/components/schemas/AppCharcs"
    RequiredAppInfo:
      description: Included in the request
      type: object
      required:
        - appName
        - appProvider
        - referenceURL
      properties:
        appName:
          $ref: "#/components/schemas/AppName"
        appProvider:
          $ref: "#/components/schemas/AppProvider"
        appSoftVersion:
          $ref: "#/components/schemas/AppSoftVersion"
        appDescription:
          $ref: "#/components/schemas/AppDescription"
        referenceURL:
          $ref: "#/components/schemas/ReferenceURL"
        appPackageSource:
          $ref: "#/components/schemas/AppPackageSource"
    AppCharcs:
      description: >-
        The application characteristics relate to the system resources consumed
        by the application. UE application can use this information e.g., for
        estimating the cost of use of the application or for the expected user
        experience
      type: object
      properties:
        memory:
          $ref: "#/components/schemas/Memory"
        storage:
          $ref: "#/components/schemas/Storage"
        latency:
          $ref: "#/components/schemas/Latency"
        bandwidth:
          $ref: "#/components/schemas/Bandwidth"
        serviceCont:
          $ref: "#/components/schemas/ServiceCont"
    Memory:
      description: >-
        The maximum size in Mbytes of the memory resource reserved for the
        MEC application instance in the MEC system
      type: integer
      format: uint32
    Storage:
      description: >-
        The maximum size in Mbytes of the storage resource expected to be used
        by the MEC application instance in the MEC system
      type: integer
      format: uint32
    Latency:
      description: >-
        The target round trip time in milliseconds supported by the MEC
        system for the MEC application instance
      type: integer
      format: uint32
    Bandwidth:
      description: >-
        The required connection bandwidth in kbit/s for the use of the MEC
        application instance
      type: integer
      format: uint32
    ServiceCont:
      description: >-
        Required service continuity mode for this application.
      type: string
      enum:
        - SERVICE_CONTINUITY_NOT_REQUIRED
        - SERVICE_CONTINUITY_REQUIRED
    AppName:
      description: >-
        Name of the MEC application. The length of the value shall not
        exceed 32 characters.
      type: string
    AppProvider:
      description: >-
        Provider of the MEC application. The length of the value shall
        not exceed 32 characters.
      type: string
    AppSoftVersion:
      description: >-
        Software version of the MEC application. The length of the value
        shall not exceed 32 characters.
      type: string
    AppDescription:
      description: >-
        Human readable description of the MEC application. NOTE the
        language support may be limited. The length of the value shall not
        exceed 128 characters.
      type: string
    CallbackReference:
      description: >-
        URI assigned by the UE application to receive application lifecycle
        related notifications. Included in the request. This subscription stays
        alive for the lifetime of the application context.
      type: string
      format: uri
      writeOnly: true
    ReferenceURL:
      description: >-
        Address of the user application. Used as the reference URL for the
        application. Assigned by the MEC system and included in the
        response
      type: string
      format: uri
      readOnly: true
    AppPackageSource:
      description: >-
        URI of the application package. Included in the request if the
        application is not one in the ApplicationList. appPackageSource enables
        on-boarding of the application package into the MEC system. The
        application package shall comply with the definitions in clause 6.2.1.2
        of ETSI GS MEC 010-2
      type: string
      format: uri