UEAppInterfaceApi.yaml 17.7 KB
Newer Older
1
openapi: 3.0.2
2
info:
3
  title: UE Application Interface API
4
  version: 2.1.1
5 6
  description: >-
    The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI
7
  license:
ETSI CTI's avatar
ETSI CTI committed
8 9
    name: BSD-3-Clause
    url: https://forge.etsi.org/legal-matters
10 11
  contact:
    email: cti_support@etsi.org
12
externalDocs:
13
  description: >-
14 15
    ETSI GS MEC016 UE Application Interface API, V2.1.1
  url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.01.01_60/gs_MEC016v020101p.pdf
16 17 18
security:
  - OauthSecurity:
      - all
19
servers:
20 21
  - url: http://127.0.0.1:8081/mx2/v2
  - url: https://127.0.0.1:8081/mx2/v2
22 23 24
tags:
  - name: appList
  - name: appContext
25
  - name: callback
26
paths:
27
  "/app_list":
28
    get:
29 30 31 32 33 34
      description: >-
        Used to query information about the available
        MEC applications.
      operationId: AppList_GET
      tags:
        - appList
35
      parameters:
36 37 38 39 40
        - $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"
41
      responses:
42 43 44 45 46 47 48 49 50 51 52
        "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":
53
    post:
54 55 56 57 58 59 60 61 62
      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"
63
      responses:
64 65 66 67 68 69 70 71 72 73
        "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'
74 75 76
      callbacks:
        referenceURI:
          $ref: '#/components/callbacks/NotificationEvent'
77 78 79
  "/app_contexts/{contextId}":
    parameters:
      - $ref: "#/components/parameters/Path.ContextId"
80
    put:
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
      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'
101 102 103
      callbacks:
        referenceURI:
          $ref: '#/components/callbacks/NotificationEvent'
104 105 106 107 108 109 110
    delete:
      description: >-
        The DELETE method is used to delete the resource that represents the
        existing application context.
      operationId: AppContextId_DEL
      tags:
        - appContext
111
      responses:
112 113 114 115 116 117 118 119 120 121 122
        "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:
123 124 125 126 127
  callbacks:
    NotificationEvent:
      '{$request.body#/callbackReference}':
        post:
          description: >-
128
            Used by the UALCMP to inform the Device application of 
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
            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'
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
  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:
218
          schema:
219 220
            $ref: "#/components/schemas/AppContext"
      required: true
221 222
    NotificationEvent:
      description: >- 
223
        Sent by the UALCMP to the Device application.
224 225 226 227 228
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/NotificationEvent"
      required: true
229 230 231 232 233 234 235
  responses:
    AppContext:
      description: >-
        The response body contains the Application Context as it was created
        by the MEC system
      content:
        application/json:
236
          schema:
237
            $ref: "#/components/schemas/AppContext"
238 239 240 241 242
      links:
        putAppContext:
          $ref: "#/components/links/PutAppContext"
        delAppContext:
          $ref: "#/components/links/DelAppContext"
243 244 245
    AppList:
      description: >-
        The response body contains the ApplicationList resource available
246
        for the querying Device application
247 248
      content:
        application/json:
249
          schema:
250 251 252 253 254 255 256
            $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:
257
          schema:
258 259 260 261 262 263 264 265 266 267
            $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:
268
          schema:
269 270
            $ref: '#/components/schemas/ProblemDetails'
        text/plain:
271
          schema:
272 273 274 275 276 277 278
            $ref: '#/components/schemas/Empty'
    Error.403:
      description: >-
        Forbidden.
        The operation is not allowed given the current status of the resource. 
      content:
        application/problem+json:
279
          schema:
280 281 282 283 284 285 286 287
            $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:
288
          schema:
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
            $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:
346 347
        appList:
          $ref: "#/components/schemas/AppList"
348 349
        vendorSpecificExt:
          $ref: "#/components/schemas/VendorSpecificExt"
350 351 352 353 354 355 356 357 358 359 360 361
    AppList:
      description: >-
        List of user applications available to the device application
      type: array
      minItems: 0
      items:
        type: object
        required:
          - appInfo
        properties:
          appInfo:
            $ref: "#/components/schemas/AppInfo"
362 363 364 365 366 367 368
    AppContext:
      description: >-
        Information on application context created by the MEC system
      type: object
      required:
        - contextId
        - associateUeAppId
369
        - callbackReference
370 371 372 373 374 375 376 377 378
        - appInfo
      properties:
        contextId:
          $ref: "#/components/schemas/ContextId"
        associateUeAppId:
          $ref: "#/components/schemas/AssociateUeAppId"
        callbackReference:
          $ref: "#/components/schemas/CallbackReference"
        appInfo:
379
          $ref: "#/components/schemas/AppInfoAppContext"
380 381 382 383
    NotificationEvent:
      description: >-
        The parameters used in the method "Receiving notification events".
      type: object
384
      required:
385 386 387 388 389 390 391 392
        - referenceURI
      properties:
        referenceURI:
          $ref: "#/components/schemas/ReferenceURL"
    VendorSpecificExt:
      description: >-
        Extension for vendor-specific information
      required: 
393 394 395
        - vendorId
      properties:
        vendorId:
396 397 398 399 400 401 402
          $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
403
      readOnly: true
404 405
    AssociateUeAppId:
      description: >-
406
        Uniquely identifies the Device application. Included in the request. The
407 408
        length of the value shall not exceed 32 characters.
      type: string
409
      writeOnly: true
410 411 412 413 414 415 416
    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:
417 418
      type: object
      required:
419
        - appDId
420 421
        - appName
        - appProvider
422 423
        - appSoftVersion
        - appDVersion
424 425
        - appDescription
      properties:
426 427
        appDId:
          $ref: "#/components/schemas/AppDId"
428
        appName:
429
          $ref: "#/components/schemas/AppName"
430
        appProvider:
431
          $ref: "#/components/schemas/AppProvider"
432
        appSoftVersion:
433
          $ref: "#/components/schemas/AppSoftVersion"
434 435
        appDVersion:
          $ref: "#/components/schemas/AppDVersion"
436
        appDescription:
437
          $ref: "#/components/schemas/AppDescription"
438
        appCharcs:
439
          $ref: "#/components/schemas/AppCharcs"
440
    AppInfoAppContext:
441 442 443 444 445
      description: Included in the request
      type: object
      required:
        - appName
        - appProvider
446
        - appDVersion
447
      properties:
448 449
        appDId:
          $ref: "#/components/schemas/AppDId"
450 451 452 453 454 455
        appName:
          $ref: "#/components/schemas/AppName"
        appProvider:
          $ref: "#/components/schemas/AppProvider"
        appSoftVersion:
          $ref: "#/components/schemas/AppSoftVersion"
456 457
        appDVersion:
          $ref: "#/components/schemas/AppDVersion"
458 459 460 461 462 463 464 465 466
        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
467
        by the application. Device application can use this information e.g., for
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
        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: >-
502 503
        The required connection bandwidth in kbit/s for the use of the MEC
        application instance
504 505 506 507 508 509 510 511 512
      type: integer
      format: uint32
    ServiceCont:
      description: >-
        Required service continuity mode for this application.
      type: string
      enum:
        - SERVICE_CONTINUITY_NOT_REQUIRED
        - SERVICE_CONTINUITY_REQUIRED
513 514 515 516 517 518 519 520 521
      example:
        SERVICE_CONTINUITY_NOT_REQUIRED
    AppDId:
      description: >-
        Identifier of this MEC application descriptor. It is equivalent to 
        the appDId defined in clause 6.2.1.2 of ETSI GS MEC 010-2. 
        This attribute shall be globally unique. It shall be present if the 
        application is one in the ApplicationList.
      type: string
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
    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
537 538 539 540 541 542
    AppDVersion:
      description: >-
        Identifies the version of the application descriptor. It is 
        equivalent to the appDVersion defined in clause 6.2.1.2 of 
        ETSI GS MEC 010-2.
      type: string
543 544 545 546 547 548 549 550
    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: >-
551
        URI assigned by the Device application to receive application lifecycle
552 553 554 555
        related notifications. Included in the request. This subscription stays
        alive for the lifetime of the application context.
      type: string
      format: uri
556
      writeOnly: true
557 558 559 560 561 562 563
    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
564
      readOnly: true
565 566 567 568 569 570 571 572
    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
ETSI CTI's avatar
ETSI CTI committed
573
      format: uri