UEAppInterfaceApi.yaml 17 KB
Newer Older
1 2
swagger: '2.0'
info:
3
  description: 'The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI'
4
  version: 1.1.1
5
  title: 'UE Application Interface API'
6
  license:
7
    name: 'ETSI Forge copyright notice'
8
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
9
externalDocs:
10 11
  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'
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
host: '127.0.0.1:8081'
basePath: /mx2/v1
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - OauthSecurity:
      - all
securityDefinitions:
  OauthSecurity:
    type: oauth2
    flow: application
    tokenUrl: 'https://oauth.exampleAPI/token'
    scopes:
      all: Single oauth2 scope for API
parameters:
  Query.AppName:
    name: appName
    in: query
35
    description: 'Name to identify the mobile edge application'
36 37 38 39 40 41 42
    required: false
    type: array
    items:
      type: string
  Query.AppProvider:
    name: appProvider
    in: query
43
    description: 'Provider of the mobile edge application'
44 45 46 47 48 49 50
    required: false
    type: array
    items:
      type: string
  Query.AppSoftVersion:
    name: appSoftVersion
    in: query
51
    description: 'Software version of the mobile edge application'
52 53 54 55 56 57 58
    required: false
    type: array
    items:
      type: string
  Query.ServiceCont:
    name: serviceCont
    in: query
59
    description: 'Required service continuity mode for this application'
60 61 62 63 64 65 66 67
    required: false
    type: string
    enum:
      - SERVICE_CONTINUITY_NOT_REQUIRED
      - SERVICE_CONTINUITY_REQUIRED
  Body.AppContext:
    name: appContext
    in: body
68
    description: 'Uniquely identifies the application context in the mobile edge system. It is assigned by the mobile edge system and included in the response to an AppContext create.'
69 70 71 72 73 74
    required: true
    schema:
      $ref: '#/definitions/AppContext'
  Query.VendorId:
    name: vendorId
    in: query
75
    description: 'Vendor identifier'
76 77 78 79 80 81 82
    required: false
    type: array
    items:
      type: string
  Path.ContextId:
    name: contextId
    in: path
83
    description: 'Uniquely identifies the application context in the mobile edge system. It is assigned by the mobile edge system and included in the response to an AppContext create.'
84 85 86 87 88
    required: true
    type: string
paths:
  /app_list:
    get:
89
      description: 'The GET method can be used to query information about the available mobile edge applications.'
90 91 92 93 94 95 96 97 98 99
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Query.AppName'
        - $ref: '#/parameters/Query.AppProvider'
        - $ref: '#/parameters/Query.AppSoftVersion'
        - $ref: '#/parameters/Query.ServiceCont'
        - $ref: '#/parameters/Query.VendorId'
      responses:
        '200':
100
          description: 'The response body contains the ApplicationList resource available for the querying UE application'
101
          schema:
102
            type: object
103 104 105 106 107 108
            required:
              - ApplicationList
            properties:
              ApplicationList:
                $ref: '#/definitions/ApplicationList'
        '400':
109
          description: 'Incorrect parameters were passed in the request.More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
110
          schema:
111
            type: object
112 113 114 115
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
116
          description: 'An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
117
          schema:
118
            type: object
119 120 121 122
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
123
          description: 'The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
124
          schema:
125
            type: object
126 127 128 129 130 131
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
132
          description: 'The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
133
          schema:
134
            type: object
135 136 137 138 139
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
  /app_contexts:
    post:
140
      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.'
141 142 143 144 145 146
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.AppContext'
      responses:
        '201':
147
          description: 'The response body contains the Application Context as it was created by the mobile edge system'
148
          schema:
149
            type: object
150 151 152 153 154 155
            required:
              - AppContext
            properties:
              AppContext:
                $ref: '#/definitions/AppContext'
        '400':
156
          description: 'Incorrect parameters were passed in the request.More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
157
          schema:
158
            type: object
159 160 161 162
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
163
          description: 'An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
164
          schema:
165
            type: object
166 167 168 169
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
170
          description: 'The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
171
          schema:
172
            type: object
173 174 175 176 177 178
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
179
          description: 'The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
180
          schema:
181
            type: object
182 183 184 185 186
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
  '/app_contexts/{contextId}':
    put:
187
      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.'
188 189 190 191 192 193 194
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.ContextId'
        - $ref: '#/parameters/Body.AppContext'
      responses:
        '204':
195
          description: 'Upon success, a response 204 No Content without any response body is returned.'
196
        '400':
197
          description: 'Incorrect parameters were passed in the request.More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
198
          schema:
199
            type: object
200 201 202 203
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
204
          description: 'An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
205
          schema:
206
            type: object
207 208 209 210
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
211
          description: 'The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
212
          schema:
213
            type: object
214 215 216 217 218 219
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
220
          description: 'The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
221
          schema:
222
            type: object
223 224 225 226
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    delete:
227
      description: 'The DELETE method is used to delete the resource that represents the existing application context.'
228 229 230 231 232 233 234 235 236 237
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.ContextId'
      responses:
        '204':
          description: >-
            Upon success, a response 204 No Content without any response body is
            returned.
        '400':
238
          description: 'Incorrect parameters were passed in the request. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
239
          schema:
240
            type: object
241 242 243 244
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '401':
245
          description: 'An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
246
          schema:
247
            type: object
248 249 250 251
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
252
          description: 'The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
253
          schema:
254
            type: object
255 256 257 258 259 260
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
261
          description: 'The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.'
262
          schema:
263
            type: object
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
definitions:
  ProblemDetails:
    type: object
    properties:
      type:
        $ref: '#/definitions/Problem.type'
      title:
        $ref: '#/definitions/Problem.title'
      status:
        $ref: '#/definitions/Problem.status'
      detail:
        $ref: '#/definitions/Problem.detail'
      instance:
        $ref: '#/definitions/Problem.instance'
  Problem.type:
    type: string
    format: uri
284
    description: 'A URI reference according to IETF RFC 3986 that identifies the problem type'
285 286 287 288 289 290
  Problem.title:
    type: string
    description: 'A short, human-readable summary of the problem type'
  Problem.status:
    type: integer
    format: uint32
291
    description: 'The HTTP status code for this occurrence of the problem'
292 293
  Problem.detail:
    type: string
294
    description: 'A human-readable explanation specific to this occurrence of the problem'
295 296 297
  Problem.instance:
    type: string
    format: uri
298
    description: 'A URI reference that identifies the specific occurrence of the problem'
299
  ApplicationList:
300
    description: 'Information on available applications'
301 302 303 304 305 306 307
    type: object
    properties:
      appInfo:
        $ref: '#/definitions/AppInfo'
      vendorSpecificExt:
        $ref: '#/definitions/VendorSpecificExt'
  AppContext:
308
    description: 'Information on application context created by the mobile edge system'
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
    type: object
    required:
      - contextId
      - associateUeAppId
      - appInfo
    properties:
      contextId:
        $ref: '#/definitions/ContextId'
      associateUeAppId:
        $ref: '#/definitions/AssociateUeAppId'
      callbackReference:
        $ref: '#/definitions/CallbackReference'
      appInfo:
        $ref: '#/definitions/RequiredAppInfo'
  NotificationEvent:
324
    description: 'The parameters used in the method "Receiving notification events".'
325 326 327 328 329 330 331
    type: object
    required:
      - referenceURI
    properties:
      referenceURI:
        $ref: '#/definitions/ReferenceURL'
  VendorSpecificExt:
332
    description: 'Extension for vendor-specific information'
333 334 335 336 337 338 339 340
    type: array
    items:
      required:
        - vendorId
      properties:
        vendorId:
          $ref: '#/definitions/VendorId'
  ContextId:
341
    description: 'Uniquely identifies the application context in the mobile edge system. Assigned by the mobile edge system and included in the response. The length of the value shall not exceed 32 characters.'
342 343 344 345 346
    type: string
  AssociateUeAppId:
    description: 'Uniquely identifies the UE application. Included in the request. The length of the value shall not exceed 32 characters.'
    type: string
  VendorId:
347
    description: 'Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of vendor specific extension is not defined'
348 349
    type: string
  AppInfo:
350
    description: 'User applications available for the UE application'
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
    type: array
    items:
      type: object
      required:
        - appName
        - appProvider
        - appDescription
      properties:
        appName:
          $ref: '#/definitions/AppName'
        appProvider:
          $ref: '#/definitions/AppProvider'
        appSoftVersion:
          $ref: '#/definitions/AppSoftVersion'
        appDescription:
          $ref: '#/definitions/AppDescription'
        appCharcs:
          $ref: '#/definitions/AppCharcs'
  RequiredAppInfo:
370
    description: 'Included in the request'
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    type: object
    required:
      - appName
      - appProvider
      - referenceURL
    properties:
      appName:
        $ref: '#/definitions/AppName'
      appProvider:
        $ref: '#/definitions/AppProvider'
      appSoftVersion:
        $ref: '#/definitions/AppSoftVersion'
      appDescription:
        $ref: '#/definitions/AppDescription'
      referenceURL:
        $ref: '#/definitions/ReferenceURL'
      appPackageSource:
        $ref: '#/definitions/AppPackageSource'
  AppCharcs:
390
    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'
391 392 393 394 395 396 397 398 399 400 401 402 403
    type: object
    properties:
      memory:
        $ref: '#/definitions/Memory'
      storage:
        $ref: '#/definitions/Storage'
      latency:
        $ref: '#/definitions/Latency'
      bandwidth:
        $ref: '#/definitions/Bandwidth'
      serviceCont:
        $ref: '#/definitions/ServiceCont'
  Memory:
404
    description: 'The maximum size in Mbytes of the memory resource reserved for the mobile edge application instance in the mobile edge system'
405
    type: integer
406
    format: uint32
407
  Storage:
408
    description: 'The maximum size in Mbytes of the storage resource expected to be used by the mobile edge application instance in the mobile edge system'
409
    type: integer
410
    format: uint32
411
  Latency:
412
    description: 'The target round trip time in milliseconds supported by the mobile edge system for the mobile edge application instance'
413
    type: integer
414
    format: uint32
415
  Bandwidth:
416
    description: 'The required connection bandwidth in kbit/s for the use of the mobile edge application instance'
417
    type: integer
418
    format: uint32
419 420 421 422 423 424 425 426 427 428 429 430
  ServiceCont:
    description: >-
      Required service continuity mode for this application.
    type: string
    enum:
      - SERVICE_CONTINUITY_NOT_REQUIRED
      - SERVICE_CONTINUITY_REQUIRED
  AppName:
    description: >-
      Name of the mobile edge application. The length of the value shall not exceed 32 characters.
    type: string
  AppProvider:
431
    description: 'Provider of the mobile edge application. The length of the value shall not exceed 32 characters.'
432 433
    type: string
  AppSoftVersion:
434
    description: 'Software version of the mobile edge application. The length of the value shall not exceed 32 characters.'
435 436
    type: string
  AppDescription:
437
    description: 'Human readable description of the mobile edge application. NOTE: the language support may be limited. The length of the value shall not exceed 128 characters.'
438 439
    type: string
  CallbackReference:
440
    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.'
441 442 443
    type: string
    format: uri
  ReferenceURL:
444
    description: 'Address of the user application. Used as the reference URL for the application. Assigned by the mobile edge system and included in the response'
445 446 447
    type: string
    format: uri
  AppPackageSource:
448
    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 mobile edge system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2'
449
    type: string
450
    format: uri