UEAppInterfaceApi.yaml 35.3 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
1
openapi: 3.0.0
2
info:
Michel Roy's avatar
Michel Roy committed
3
4
  contact:
    url: https://forge.etsi.org/rep/mec/gs016-dev-app-api
Michel Roy's avatar
Michel Roy committed
5
6
7
  title: 'ETSI GS MEC 016 Device application interface'
  version: 2.2.1
  description: The ETSI MEC ISG Device application interface API described using OpenAPI.
8
  license:
ETSI CTI's avatar
ETSI CTI committed
9
    name: BSD-3-Clause
Michel Roy's avatar
Michel Roy committed
10
11
    url: 'https://forge.etsi.org/legal-matters'

12
externalDocs:
Michel Roy's avatar
Michel Roy committed
13
14
15
  description: ETSI GS MEC016 V2.2.1 Device application interface
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.02.01_60/gs_MEC016v020201p.pdf'

Walter Featherstone's avatar
Walter Featherstone committed
16
servers:
Michel Roy's avatar
Michel Roy committed
17
18
19
20
  - url: 'https://localhost/dev_app/v1'

tags:
- name: "dev_app"
Michel Roy's avatar
Michel Roy committed
21

22
paths:
Michel Roy's avatar
Michel Roy committed
23
  /app_list:
24
    get:
Walter Featherstone's avatar
Walter Featherstone committed
25
      tags:
Michel Roy's avatar
Michel Roy committed
26
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
27
28
29
      summary: "Get available application information."
      description: "Used to query information about the available MEC applications."
      operationId: "meAppListGET"
30
      parameters:
Michel Roy's avatar
Michel Roy committed
31
32
33
34
35
      - $ref: '#/components/parameters/Query.appName'
      - $ref: '#/components/parameters/Query.appProvider'
      - $ref: '#/components/parameters/Query.appSoftVersion'
      - $ref: '#/components/parameters/Query.vendorId'
      - $ref: '#/components/parameters/Query.serviceCont'
36
      responses:
Michel Roy's avatar
Michel Roy committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
        200:
          description: "The response body contains an array of the user applications available to the querying device application."
          content:
            application/json:
              schema:
                type: object
                properties:
                  applicationList:
                    $ref: "#/components/schemas/ApplicationList"
        400:
          $ref: "#/components/responses/400"
        401:
          $ref: "#/components/responses/401"
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
  /app_contexts:
55
    post:
Walter Featherstone's avatar
Walter Featherstone committed
56
      tags:
Michel Roy's avatar
Michel Roy committed
57
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
58
59
60
      summary: "Creation of a new application context."
      description: "Used to create a new application context. Upon success, the response contains entity body describing the created application context."
      operationId: "devAppContextsGET"
Walter Featherstone's avatar
Walter Featherstone committed
61
      requestBody:
Michel Roy's avatar
Michel Roy committed
62
63
64
65
66
67
68
69
70
71
        description: "Entity body in the request contains the Application Context as requested by the device application."
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                appContext:
                  $ref: '#/components/schemas/AppContext'
      parameters: []
72
      responses:
Michel Roy's avatar
Michel Roy committed
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
        201:
          description: "The response body contains the Application Context as it was created by the MEC system, which includes the reference URI(s) of the associated user application instance(s). The URI of the resource created within the MEC system associated with the request, with its specific application context ID, shall be included in the 'Location' HTTP header of the response."
          content:
            application/json:
              schema:
                type: object
                properties:
                  appContext:
                    $ref: "#/components/schemas/AppContext"
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
90
      callbacks:
Michel Roy's avatar
Michel Roy committed
91
92
93
94
95
96
        notification:
          '{$request.body#/appContext.callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification with content based on subscription type'
              operationId: notificationPOST
Michel Roy's avatar
Michel Roy committed
97
              requestBody:
Michel Roy's avatar
Michel Roy committed
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        notification:
                          oneOf:
                            - $ref: '#/components/schemas/AddressChangeNotification'
                            - $ref: '#/components/schemas/ApplicationContextDeleteNotification'
                            - $ref: '#/components/schemas/ApplicationContextUpdateNotification'
                            - $ref: '#/components/schemas/ApplicationLocationAvailabilityNotification'
                          discriminator:
                            propertyName: notificationType
                      example:
                        notification:
                          notificationType: ApplicationContextDeleteNotification
                          contextId: 'contextId123'
              responses:
                204:
                  $ref: '#/components/responses/204'
  /app_contexts/{contextId}:
121
    put:
Walter Featherstone's avatar
Walter Featherstone committed
122
      tags:
Michel Roy's avatar
Michel Roy committed
123
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
124
125
126
      summary: "Updating the callbackReference and/or appLocation of an existing application context."
      description: "Used to update the callback reference and/or application location constraints of an existing application context. Upon successful operation, the target resource is updated with the new application context information."
      operationId: "devAppContextPUT"
Walter Featherstone's avatar
Walter Featherstone committed
127
      requestBody:
Michel Roy's avatar
Michel Roy committed
128
129
130
131
132
133
134
135
136
137
138
        description: "Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched."
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                appContext:
                  $ref: '#/components/schemas/AppContext'
      parameters:
      - $ref: '#/components/parameters/Path.contextId'
Walter Featherstone's avatar
Walter Featherstone committed
139
      responses:
Michel Roy's avatar
Michel Roy committed
140
141
142
143
144
145
146
147
148
149
        204:
          $ref: '#/components/responses/204'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
Walter Featherstone's avatar
Walter Featherstone committed
150
151
    delete:
      tags:
Michel Roy's avatar
Michel Roy committed
152
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
153
154
155
156
157
      summary: "Deletion of an existing application context."
      description: "Used to delete the resource that represents the existing application context."
      operationId: "devAppContextDELETE"
      parameters:
      - $ref: '#/components/parameters/Path.contextId'
158
      responses:
Michel Roy's avatar
Michel Roy committed
159
160
161
162
163
164
165
166
167
168
169
170
171
        204:
          $ref: '#/components/responses/204'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
  /obtain_app_loc_availability:
    post:
      tags:
Michel Roy's avatar
Michel Roy committed
172
      - "dev_app"
Michel Roy's avatar
Michel Roy committed
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
      summary: "Obtain the location constraints for a new application context."
      description: "Used to obtain the locations available for instantiation of a specific user application in the MEC system."
      operationId: "appLocationAvailabilityPOST"
      requestBody:
        description: "Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application."
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                applicationLocationAvailability:
                  $ref: '#/components/schemas/ApplicationLocationAvailability'
      parameters: []
      responses:
        200:
          description: "The response body contains the locations available for instantiation of the requested user application in the MEC system."
          content:
            application/json:
              schema:
                type: object
                properties:
                  applicationLocationAvailability:
                    $ref: "#/components/schemas/ApplicationLocationAvailability"
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
Walter Featherstone's avatar
Walter Featherstone committed
205
components:
Michel Roy's avatar
Michel Roy committed
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
  responses:
    204:
      description: "Upon success, a response 204 No Content without any response body is returned."
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
            type: object
            required:
              - problemDetails
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
Walter Featherstone's avatar
Walter Featherstone committed
247
  parameters:
Michel Roy's avatar
Michel Roy committed
248
    Query.appName:
Walter Featherstone's avatar
Walter Featherstone committed
249
      name: appName
Michel Roy's avatar
Michel Roy committed
250
251
      in: "query"
      description: "Name to identify the MEC application."
Walter Featherstone's avatar
Walter Featherstone committed
252
253
254
255
256
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
257
258
          maxLength: 32
    Query.appProvider:
Walter Featherstone's avatar
Walter Featherstone committed
259
      name: appProvider
Michel Roy's avatar
Michel Roy committed
260
261
      in: "query"
      description: "Provider of the MEC application."
Walter Featherstone's avatar
Walter Featherstone committed
262
263
264
265
266
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
267
268
          maxLength: 32
    Query.appSoftVersion:
Walter Featherstone's avatar
Walter Featherstone committed
269
      name: appSoftVersion
Michel Roy's avatar
Michel Roy committed
270
271
      in: "query"
      description: "Software version of the MEC application."
Walter Featherstone's avatar
Walter Featherstone committed
272
273
274
275
276
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
277
278
          maxLength: 32
    Query.vendorId:
Walter Featherstone's avatar
Walter Featherstone committed
279
      name: vendorId
Michel Roy's avatar
Michel Roy committed
280
281
      in: "query"
      description: "Vendor identifier"
Walter Featherstone's avatar
Walter Featherstone committed
282
283
284
285
286
      required: false
      schema:
        type: array
        items:
          type: string
Michel Roy's avatar
Michel Roy committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
          maxLength: 32
    Query.serviceCont:
      name: serviceCont
      in: "query"
      description: "Required service continuity mode for this application. Permitted values:
        0 = SERVICE_CONTINUITY_NOT_REQUIRED.
        1 = SERVICE_CONTINUITY_REQUIRED."
      required: false
      schema:
        type: integer
        enum:
        - 0
        - 1
    Path.contextId:
Walter Featherstone's avatar
Walter Featherstone committed
301
      name: contextId
Michel Roy's avatar
Michel Roy committed
302
303
      in: "path"
      description: "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system."
Walter Featherstone's avatar
Walter Featherstone committed
304
305
306
307
      required: true
      schema:
        type: string
  schemas:
Michel Roy's avatar
Michel Roy committed
308
    AddressChangeNotification:
Walter Featherstone's avatar
Walter Featherstone committed
309
      properties:
Michel Roy's avatar
Michel Roy committed
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
        appInstanceId:
          description: Identifier of the user application instance.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        contextId:
          description: Uniquely identifies the application context in the MEC system.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "AddressChangeNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        referenceURI:
          description: 'Address of the user application. Used as the reference URI for the application. Assigned by the MEC system.'
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
      required:
      - notificationType
      - contextId
      - appInstanceId
      - referenceURI
Walter Featherstone's avatar
Walter Featherstone committed
336
      type: object
Michel Roy's avatar
Michel Roy committed
337
338
      x-etsi-ref: 6.4.2
    AppContext:
Walter Featherstone's avatar
Walter Featherstone committed
339
      properties:
Michel Roy's avatar
Michel Roy committed
340
341
342
343
344
        appAutoInstantiation:
          description: Provides indication to the MEC system that instantiation of the requested application is desired should a requested appLocation become available that was not at the time of the request.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
Walter Featherstone's avatar
Walter Featherstone committed
345
        appInfo:
Michel Roy's avatar
Michel Roy committed
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
          description: ''
          properties:
            appDId:
              description: "Identifier of this MEC application descriptor. This attribute shall be globally unique. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. It shall be present if the application is one in the ApplicationList."
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            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 0102 [1]."
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appDescription:
              description: "Human readable description of the MEC application. The length of the value shall not exceed 128 characters."
              type: string
              maxLength: 128
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appName:
              description: "Name of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appProvider:
              description: "Provider of the MEC application.\nThe length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appSoftVersion:
              description: "Software version of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appPackageSource:
              description: "URI of the application package.\nIncluded 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 0102 [1]."
              format: uri
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: URI
            userAppInstanceInfo:
              description: List of user application instance information.
              items:
                type: object
                properties:
                  appInstanceId:
                    description: 'Identifier of the user application instance. It shall only be included in the response.'
                    type: string
                    x-etsi-mec-cardinality: 0..1
                    x-etsi-mec-origin-type: String
                  appLocation:
Michel Roy's avatar
Michel Roy committed
399
400
401
402
                    $ref: '#/components/schemas/LocationConstraints'
                    # description: 'Location of the user application instance. For a user application not provided by the requesting device application it shall match one of the appLocations in ApplicationList.'
                    # x-etsi-mec-cardinality: 0..1
                    # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
                  referenceURI:
                    description: 'Address of the user application instance. It shall only be included in the response.'
                    format: uri
                    type: string
                    x-etsi-mec-cardinality: 0..1
                    x-etsi-mec-origin-type: URI
              minItems: 1
              type: array
              x-etsi-mec-cardinality: 1..N
              x-etsi-mec-origin-type: array (Structure inlined)
          required:
          - appName
          - appProvider
          - appDVersion
          - userAppInstanceInfo
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        appLocationUpdates:
          description: Used by the device application to request to receive notifications at the callbackReference URI relating to location availability for user application instantiation.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        associateDevAppId:
          description: "Uniquely identifies the device application. The length of the value shall not exceed 32 characters."
          type: string
          maxLength: 32
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        callbackReference:
          description: 'URI assigned by the device application to receive application lifecycle related notifications. Inclusion in the request implies the client supports the pub/sub mechanism and is capable of receiving notifications. This endpoint shall be maintained for the lifetime of the application context.'
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        contextId:
          description: "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and shall be present other than in a create request. The length of the value shall not exceed 32 characters."
          type: string
          maxLength: 32
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - associateDevAppId
      - appInfo
Walter Featherstone's avatar
Walter Featherstone committed
447
      type: object
Michel Roy's avatar
Michel Roy committed
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
      x-etsi-notes: "NOTE 1:\tIf a value of the attribute is included in the request,\
        \ the same value shall be included in the response.\nNOTE 2:\tThe design of\
        \ the current operation with callback reference assumes no web proxy between\
        \ the entity that originates the notification and the entity that receives\
        \ it.\nNOTE 3:\tThe language support for the application description may be\
        \ limited.\nNOTE 4:\tAttribute appLocationUpdates and appAutoInstantiation\
        \ shall not both be set to TRUE."
      x-etsi-ref: 6.2.3
    ApplicationContextDeleteNotification:
      properties:
        contextId:
          description: Uniquely identifies the application context that has been deleted from the MEC system.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ApplicationContextDeleteNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Walter Featherstone's avatar
Walter Featherstone committed
468
      required:
Michel Roy's avatar
Michel Roy committed
469
470
471
472
473
      - notificationType
      - contextId
      type: object
      x-etsi-ref: 6.4.3
    ApplicationContextUpdateNotification:
Walter Featherstone's avatar
Walter Featherstone committed
474
475
      properties:
        contextId:
Michel Roy's avatar
Michel Roy committed
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
          description: Uniquely identifies the application context in the MEC system.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ApplicationContextUpdateNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        userAppInstanceInfo:
          description: List of user application instance information.
          items:
            type: object
            properties:
              appInstanceId:
                description: Identifier of the user application instance.
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
              appLocation:
Michel Roy's avatar
Michel Roy committed
496
497
498
499
                $ref: '#/components/schemas/LocationConstraints'
                # description: Location of the user application instance.
                # x-etsi-mec-cardinality: 0..1
                # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
500
501
502
503
504
505
506
507
508
509
510
511
512
              referenceURI:
                description: Address of the user application instance.
                format: uri
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: URI
          minItems: 1
          required:
          - appInstanceId
          - referenceURI
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: array (Structure inlined)
Walter Featherstone's avatar
Walter Featherstone committed
513
      type: object
514
      required:
Michel Roy's avatar
Michel Roy committed
515
516
517
518
519
      - notificationType
      - contextId
      - userAppInstanceInfo
      x-etsi-ref: 6.4.4
    ApplicationList:
520
      properties:
Michel Roy's avatar
Michel Roy committed
521
522
523
524
525
526
527
528
529
530
531
532
533
534
        appList:
          description: 'List of user applications available to the device application. As defined below.'
          items:
            type: object
            properties:
              appInfo:
                description: ''
                properties:
                  appCharcs:
                    description: 'Characteristics of the application. As defined below. The application characteristics relate to the system resources consumed by the application. A device application can use this information e.g. for estimating the cost of use of the application or for the expected user experience.'
                    properties:
                      bandwidth:
                        description: 'The required connection bandwidth in kbit/s for the use of the MEC application instance. '
                        type: integer
Michel Roy's avatar
Michel Roy committed
535
                        format: int32
Michel Roy's avatar
Michel Roy committed
536
537
538
539
540
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                      latency:
                        description: The target round trip time in milliseconds supported by the MEC system for the MEC application instance.
                        type: integer
Michel Roy's avatar
Michel Roy committed
541
                        format: int32
Michel Roy's avatar
Michel Roy committed
542
543
544
545
546
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                      memory:
                        description: The maximum size in Mbytes of the memory resource expected to be used by the MEC application instance in the MEC system.
                        type: integer
Michel Roy's avatar
Michel Roy committed
547
                        format: int32
Michel Roy's avatar
Michel Roy committed
548
549
550
551
552
553
554
555
556
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                      serviceCont:
                        description: 'Required service continuity mode for this application. Permitted values:
                          0 = SERVICE_CONTINUITY_NOT_REQUIRED.
                          1 = SERVICE_CONTINUITY_REQUIRED.'
                        enum:
                        - 0
                        - 1
Michel Roy's avatar
Michel Roy committed
557
                        type: integer
Michel Roy's avatar
Michel Roy committed
558
559
560
561
562
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: Enum
                      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
Michel Roy's avatar
Michel Roy committed
563
                        format: int32
Michel Roy's avatar
Michel Roy committed
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
                        x-etsi-mec-cardinality: 0..1
                        x-etsi-mec-origin-type: uint32
                    type: object
                    x-etsi-mec-cardinality: 0..1
                    x-etsi-mec-origin-type: Structure (inlined)
                  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 0102 [1]. This attribute shall be globally unique."
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  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 0102 [1].
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appDescription:
                    description: Human readable description of the MEC application (see note 2).
                    type: string
                    maxLength: 128
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appLocation:
                    description: Identifies the locations of the MEC application.
                    items:
                      $ref: '#/components/schemas/LocationConstraints'
                    minItems: 0
                    type: array
                    x-etsi-mec-cardinality: 0..N
                    x-etsi-mec-origin-type: LocationConstraints
                  appName:
                    description: 'Name of the MEC application. The length of the value shall not exceed 32 characters.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appProvider:
                    description: 'Provider of the MEC application. The length of the value shall not exceed 32 characters.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                  appSoftVersion:
                    description: 'Software version of the MEC application. The length of the value shall not exceed 32 characters.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - appDId
                - appName
                - appProvider
                - appSoftVersion
                - appDVersion
                - appDescription
                type: object
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Structure (inlined)
              vendorSpecificExt:
                description: Extension for vendor specific information (see note 1).
                properties:
                  vendorId:
                    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.'
                    type: string
                    maxLength: 32
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - vendorId
                type: object
                x-etsi-mec-cardinality: 0..1
                x-etsi-mec-origin-type: Structure (inlined)
          minItems: 0
          required:
          - appInfo
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Array (Structure (inlined))
641
      type: object
Michel Roy's avatar
Michel Roy committed
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
      x-etsi-notes: "NOTE 1:\tThe vendor specific extension allows submitting information\
        \ on the application lists that have been made available to the device application\
        \ of the corresponding vendor.\nNOTE 2:\tThe language support may be limited.\
        \ The length of the value shall not exceed 128 characters."
      x-etsi-ref: 6.2.2
    ApplicationLocationAvailability:
      properties:
        appInfo:
          description: ''
          properties:
            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 0102 [1]."
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appDescription:
              description: "Human readable description of the MEC application. The length of the value shall not exceed 128 characters."
              type: string
              maxLength: 128
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            appName:
              description: "Name of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appPackageSource:
              description: "URI of the application package. Shall be included in the request. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1]."
              format: uri
              type: string
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: URI
            appProvider:
              description: "Provider of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            appSoftVersion:
              description: "Software version of the MEC application. The length of the value shall not exceed 32 characters."
              type: string
              maxLength: 32
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: String
            availableLocations:
              description: 'MEC application location constraints. '
              items:
                type: object
                properties:
                  appLocation:
Michel Roy's avatar
Michel Roy committed
693
694
695
696
                    $ref: '#/components/schemas/LocationConstraints'
                    # description: Shall only be included in the response, where it indicates a location constraint available in the MEC system.
                    # x-etsi-mec-cardinality: 0..1
                    # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: array (Structure (inline))
          required:
          - appName
          - appProvider
          - appDVersion
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        associateDevAppId:
          description: "Uniquely identifies the device application. The length of the value shall not exceed 32 characters."
          type: string
          maxLength: 32
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
714
      required:
Michel Roy's avatar
Michel Roy committed
715
716
717
718
719
      - associateDevAppId
      - appInfo
      type: object
      x-etsi-ref: 6.2.4
    ApplicationLocationAvailabilityNotification:
720
      properties:
Michel Roy's avatar
Michel Roy committed
721
722
723
724
725
726
        availableLocations:
          description: Locations available to the MEC application.
          items:
            type: object
            properties:
              appLocation:
Michel Roy's avatar
Michel Roy committed
727
728
729
730
                $ref: '#/components/schemas/LocationConstraints'
                # description: 'It shall match one of the appLocations in the AppContext sent in the Application context create '
                # x-etsi-mec-cardinality: '1'
                # x-etsi-mec-origin-type: LocationConstraints
Michel Roy's avatar
Michel Roy committed
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
          minItems: 1
          required:
          - appLocation
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: array (Structure (inline))
        contextId:
          description: Uniquely identifies the application context in the MEC system.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        notificationType:
          description: Shall be set to "ApplicationLocationAvailabilityNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Walter Featherstone's avatar
Walter Featherstone committed
747
748
      type: object
      required:
Michel Roy's avatar
Michel Roy committed
749
750
751
752
      - notificationType
      - availableLocations
      x-etsi-ref: 6.4.5
    LocationConstraints:
Walter Featherstone's avatar
Walter Featherstone committed
753
      properties:
Michel Roy's avatar
Michel Roy committed
754
        area:
Michel Roy's avatar
Michel Roy committed
755
756
757
758
          $ref: '#/components/schemas/Polygon'
          # description: "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946 [8], for which the \"type\" member shall be set to the value \"Polygon\". See note."
          # x-etsi-mec-cardinality: 0..1
          # x-etsi-mec-origin-type: Polygon
Michel Roy's avatar
Michel Roy committed
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
        civicAddressElement:
          description: Zero or more elements comprising the civic address. Shall be absent if the "area" attribute is present.
          items:
            type: object
            properties:
              caType:
                description: "Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776 [6]. "
                type: integer
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: Integer
              caValue:
                description: "Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6]."
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
          minItems: 0
          required:
          - caType
          - caValue
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: array (Structure inlined)
        countryCode:
          description: The two-letter ISO 3166 [7] country code in capital letters. Shall be present in case the "area" attribute is absent. May be absent if the "area" attribute is present (see note).
          type: string
          maxLength: 2
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-notes: "NOTE:\tIf both \"countryCode\" and \"area\" are present, no conflicts\
        \ should exist between the values of these two attributes. In case of conflicts,\
        \ the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic\
        \ area signalled by \"area\" that are outside the boundaries of the country\
        \ signalled by \"countryCode\". If \"countryCode\" is absent, it is solely\
        \ the \"area\" attribute that defines the location constraint."
      x-etsi-ref: 6.5.2
    Polygon:
      properties:
        coordinates:
          items:
            items:
              items:
                type: number
                format: float
              type: array
            type: array
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1
          x-etsi-mec-origin-type: array
Walter Featherstone's avatar
Walter Featherstone committed
809
      type: object
Michel Roy's avatar
Michel Roy committed
810
    ProblemDetails:
Walter Featherstone's avatar
Walter Featherstone committed
811
      properties:
Michel Roy's avatar
Michel Roy committed
812
813
814
815
816
817
818
819
820
821
822
823
824
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
Michel Roy's avatar
Michel Roy committed
825
          format: int32
Michel Roy's avatar
Michel Roy committed
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object