UEAppInterfaceApi.json 40.7 KB
Newer Older
1
{
Michel Roy's avatar
Michel Roy committed
2
  "openapi": "3.0.0",
3
  "info": {
Michel Roy's avatar
Michel Roy committed
4 5 6
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs016-dev-app-api"
    },
Michel Roy's avatar
Michel Roy committed
7 8 9
    "title": "ETSI GS MEC 016 Device application interface",
    "version": "2.2.1",
    "description": "The ETSI MEC ISG Device application interface API described using OpenAPI.",
10
    "license": {
ETSI CTI's avatar
ETSI CTI committed
11 12
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
13 14 15
    }
  },
  "externalDocs": {
Michel Roy's avatar
Michel Roy committed
16 17
    "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"
18
  },
19 20
  "servers": [
    {
Michel Roy's avatar
Michel Roy committed
21 22 23 24 25 26
      "url": "https://localhost/dev_app/v1"
    }
  ],
  "tags": [
    {
      "name": "dev_app"
27
    }
28
  ],
29 30 31
  "paths": {
    "/app_list": {
      "get": {
32
        "tags": [
Michel Roy's avatar
Michel Roy committed
33
          "dev_app"
34
        ],
Michel Roy's avatar
Michel Roy committed
35 36 37
        "summary": "Get available application information.",
        "description": "Used to query information about the available MEC applications.",
        "operationId": "meAppListGET",
38 39
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
40
            "$ref": "#/components/parameters/Query.appName"
41 42
          },
          {
Michel Roy's avatar
Michel Roy committed
43
            "$ref": "#/components/parameters/Query.appProvider"
44 45
          },
          {
Michel Roy's avatar
Michel Roy committed
46
            "$ref": "#/components/parameters/Query.appSoftVersion"
47 48
          },
          {
Michel Roy's avatar
Michel Roy committed
49
            "$ref": "#/components/parameters/Query.vendorId"
50 51
          },
          {
Michel Roy's avatar
Michel Roy committed
52
            "$ref": "#/components/parameters/Query.serviceCont"
53 54 55 56
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
57 58 59 60
            "description": "The response body contains an array of the user applications available to the querying device application.",
            "content": {
              "application/json": {
                "schema": {
Michel Roy's avatar
Michel Roy committed
61
                  "$ref": "#/components/schemas/ApplicationList"
Michel Roy's avatar
Michel Roy committed
62 63 64
                }
              }
            }
65 66
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
67
            "$ref": "#/components/responses/400"
68 69
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
70
            "$ref": "#/components/responses/401"
71 72
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
73
            "$ref": "#/components/responses/403"
74 75
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
76
            "$ref": "#/components/responses/404"
77
          }
78
        }
79
      }
80
    },
81 82
    "/app_contexts": {
      "post": {
83
        "tags": [
Michel Roy's avatar
Michel Roy committed
84
          "dev_app"
85
        ],
Michel Roy's avatar
Michel Roy committed
86 87 88
        "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",
89
        "requestBody": {
Michel Roy's avatar
Michel Roy committed
90 91 92 93 94
          "description": "Entity body in the request contains the Application Context as requested by the device application.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
Michel Roy's avatar
Michel Roy committed
95
                "$ref": "#/components/schemas/AppContext"
Michel Roy's avatar
Michel Roy committed
96 97 98
              }
            }
          }
99
        },
Michel Roy's avatar
Michel Roy committed
100
        "parameters": [],
101 102
        "responses": {
          "201": {
Michel Roy's avatar
Michel Roy committed
103 104 105 106
            "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": {
Michel Roy's avatar
Michel Roy committed
107
                  "$ref": "#/components/schemas/AppContext"
Michel Roy's avatar
Michel Roy committed
108 109 110
                }
              }
            }
111 112
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
113
            "$ref": "#/components/responses/400"
114 115
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
116
            "$ref": "#/components/responses/401"
117 118
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
119
            "$ref": "#/components/responses/403"
120 121
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
122
            "$ref": "#/components/responses/404"
123
          }
124 125
        },
        "callbacks": {
Michel Roy's avatar
Michel Roy committed
126 127 128 129 130 131 132 133 134 135 136 137
          "notification": {
            "{$request.body#/appContext.callbackReference}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "Notification with content based on subscription type",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
Michel Roy's avatar
Michel Roy committed
138 139 140 141 142
                        "$ref": "#/components/schemas/InlineNotification"
                      },
                      "example": {
                        "notificationType": "ApplicationContextDeleteNotification",
                        "contextId": "contextId123"
Michel Roy's avatar
Michel Roy committed
143 144 145 146 147 148 149 150 151 152 153
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
154
          }
155
        }
156
      }
157
    },
158 159
    "/app_contexts/{contextId}": {
      "put": {
160
        "tags": [
Michel Roy's avatar
Michel Roy committed
161
          "dev_app"
162
        ],
Michel Roy's avatar
Michel Roy committed
163 164 165
        "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",
166
        "requestBody": {
Michel Roy's avatar
Michel Roy committed
167 168 169 170 171
          "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": {
Michel Roy's avatar
Michel Roy committed
172
                "$ref": "#/components/schemas/AppContext"
Michel Roy's avatar
Michel Roy committed
173 174 175
              }
            }
          }
176
        },
Michel Roy's avatar
Michel Roy committed
177 178 179 180 181
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.contextId"
          }
        ],
182 183
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
184
            "$ref": "#/components/responses/204"
185 186
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
187
            "$ref": "#/components/responses/400"
188 189
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
190
            "$ref": "#/components/responses/401"
191 192
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
193
            "$ref": "#/components/responses/403"
194 195
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
196
            "$ref": "#/components/responses/404"
197
          }
198 199 200
        }
      },
      "delete": {
201
        "tags": [
Michel Roy's avatar
Michel Roy committed
202
          "dev_app"
Michel Roy's avatar
Michel Roy committed
203 204 205 206 207 208 209 210
        ],
        "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"
          }
211 212 213
        ],
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
            "$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
234
          "dev_app"
Michel Roy's avatar
Michel Roy committed
235 236 237 238 239 240 241 242 243 244
        ],
        "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": {
Michel Roy's avatar
Michel Roy committed
245
                "$ref": "#/components/schemas/ApplicationLocationAvailability"
Michel Roy's avatar
Michel Roy committed
246 247 248 249 250 251 252 253 254 255 256
              }
            }
          }
        },
        "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": {
Michel Roy's avatar
Michel Roy committed
257
                  "$ref": "#/components/schemas/ApplicationLocationAvailability"
Michel Roy's avatar
Michel Roy committed
258 259 260
                }
              }
            }
261 262
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
263
            "$ref": "#/components/responses/400"
264 265
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
266
            "$ref": "#/components/responses/401"
267 268
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
269
            "$ref": "#/components/responses/403"
270 271
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
272
            "$ref": "#/components/responses/404"
273 274 275 276 277
          }
        }
      }
    }
  },
278
  "components": {
Michel Roy's avatar
Michel Roy committed
279 280 281 282 283 284 285
    "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": {
Michel Roy's avatar
Michel Roy committed
286
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
287
            "schema": {
Michel Roy's avatar
Michel Roy committed
288
              "$ref": "#/components/schemas/ProblemDetails"
289 290 291
            }
          }
        }
Michel Roy's avatar
Michel Roy committed
292 293 294 295
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
Michel Roy's avatar
Michel Roy committed
296
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
297
            "schema": {
Michel Roy's avatar
Michel Roy committed
298
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
299 300 301 302 303 304 305
            }
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
Michel Roy's avatar
Michel Roy committed
306
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
307
            "schema": {
Michel Roy's avatar
Michel Roy committed
308
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
309 310
            }
          }
311 312
        }
      },
Michel Roy's avatar
Michel Roy committed
313 314 315
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
Michel Roy's avatar
Michel Roy committed
316
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
317
            "schema": {
Michel Roy's avatar
Michel Roy committed
318
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
319 320
            }
          }
321 322 323
        }
      }
    },
324
    "parameters": {
Michel Roy's avatar
Michel Roy committed
325
      "Query.appName": {
326 327
        "name": "appName",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
328
        "description": "Name to identify the MEC application.",
329 330 331 332
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
333 334
            "type": "string",
            "maxLength": 32
335 336 337
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
338
      "Query.appProvider": {
339 340
        "name": "appProvider",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
341
        "description": "Provider of the MEC application.",
342 343 344 345
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
346 347
            "type": "string",
            "maxLength": 32
348 349 350
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
351
      "Query.appSoftVersion": {
352 353
        "name": "appSoftVersion",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
354
        "description": "Software version of the MEC application.",
355 356 357 358
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
359 360
            "type": "string",
            "maxLength": 32
361 362 363
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
364
      "Query.vendorId": {
365 366 367 368 369 370 371
        "name": "vendorId",
        "in": "query",
        "description": "Vendor identifier",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
372 373
            "type": "string",
            "maxLength": 32
374 375 376
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390
      "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": {
391 392
        "name": "contextId",
        "in": "path",
Michel Roy's avatar
Michel Roy committed
393
        "description": "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system.",
394 395 396
        "required": true,
        "schema": {
          "type": "string"
397 398 399
        }
      }
    },
Michel Roy's avatar
Michel Roy committed
400 401 402 403 404 405 406 407
    "schemas": {
      "AddressChangeNotification": {
        "properties": {
          "appInstanceId": {
            "description": "Identifier of the user application instance.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
408
          },
Michel Roy's avatar
Michel Roy committed
409 410 411 412 413
          "contextId": {
            "description": "Uniquely identifies the application context in the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
414
          },
Michel Roy's avatar
Michel Roy committed
415 416 417 418 419
          "notificationType": {
            "description": "Shall be set to \"AddressChangeNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
420
          },
Michel Roy's avatar
Michel Roy committed
421 422 423 424 425 426
          "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"
427
          }
Michel Roy's avatar
Michel Roy committed
428 429 430 431 432 433 434
        },
        "required": [
          "notificationType",
          "contextId",
          "appInstanceId",
          "referenceURI"
        ],
435
        "type": "object",
Michel Roy's avatar
Michel Roy committed
436 437 438
        "x-etsi-ref": "6.4.2"
      },
      "AppContext": {
439
        "properties": {
Michel Roy's avatar
Michel Roy committed
440 441 442 443 444
          "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"
445
          },
Michel Roy's avatar
Michel Roy committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 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 502 503 504 505 506 507
          "appInfo": {
            "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
508
                      "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
                    },
                    "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)"
534
          },
Michel Roy's avatar
Michel Roy committed
535 536 537 538 539
          "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"
540
          },
Michel Roy's avatar
Michel Roy committed
541 542 543 544 545 546
          "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"
547
          },
Michel Roy's avatar
Michel Roy committed
548 549 550 551 552 553 554 555 556 557 558 559 560
          "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"
561
          }
Michel Roy's avatar
Michel Roy committed
562 563 564 565 566
        },
        "required": [
          "associateDevAppId",
          "appInfo"
        ],
567
        "type": "object",
Michel Roy's avatar
Michel Roy committed
568 569 570 571
        "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": {
572
        "properties": {
Michel Roy's avatar
Michel Roy committed
573 574 575 576 577
          "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"
578
          },
Michel Roy's avatar
Michel Roy committed
579 580 581 582 583
          "notificationType": {
            "description": "Shall be set to \"ApplicationContextDeleteNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
584
          }
Michel Roy's avatar
Michel Roy committed
585
        },
586
        "required": [
Michel Roy's avatar
Michel Roy committed
587 588
          "notificationType",
          "contextId"
589
        ],
Michel Roy's avatar
Michel Roy committed
590 591 592 593
        "type": "object",
        "x-etsi-ref": "6.4.3"
      },
      "ApplicationContextUpdateNotification": {
594 595
        "properties": {
          "contextId": {
Michel Roy's avatar
Michel Roy committed
596 597 598 599
            "description": "Uniquely identifies the application context in the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
600
          },
Michel Roy's avatar
Michel Roy committed
601 602 603 604 605
          "notificationType": {
            "description": "Shall be set to \"ApplicationContextUpdateNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
606
          },
Michel Roy's avatar
Michel Roy committed
607 608 609 610 611 612 613 614 615 616 617 618
          "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
619
                  "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
                },
                "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)"
638
          }
Michel Roy's avatar
Michel Roy committed
639
        },
640 641
        "type": "object",
        "required": [
Michel Roy's avatar
Michel Roy committed
642 643 644
          "notificationType",
          "contextId",
          "userAppInstanceInfo"
645
        ],
Michel Roy's avatar
Michel Roy committed
646 647 648
        "x-etsi-ref": "6.4.4"
      },
      "ApplicationList": {
649
        "properties": {
Michel Roy's avatar
Michel Roy committed
650 651 652 653 654 655 656 657 658 659 660 661 662
          "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. ",
Michel Roy's avatar
Michel Roy committed
663
                          "format": "uint32",
Michel Roy's avatar
Michel Roy committed
664 665 666 667 668 669
                          "type": "integer",
                          "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.",
Michel Roy's avatar
Michel Roy committed
670
                          "format": "uint32",
Michel Roy's avatar
Michel Roy committed
671 672 673 674 675 676
                          "type": "integer",
                          "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.",
Michel Roy's avatar
Michel Roy committed
677
                          "format": "uint32",
Michel Roy's avatar
Michel Roy committed
678 679 680 681 682 683 684 685 686 687
                          "type": "integer",
                          "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
688
                          "type": "integer",
Michel Roy's avatar
Michel Roy committed
689 690 691 692 693
                          "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.",
Michel Roy's avatar
Michel Roy committed
694
                          "format": "uint32",
Michel Roy's avatar
Michel Roy committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 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
                          "type": "integer",
                          "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))"
794
          }
Michel Roy's avatar
Michel Roy committed
795 796 797 798
        },
        "type": "object",
        "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"
799
      },
Michel Roy's avatar
Michel Roy committed
800
      "ApplicationLocationAvailability": {
801
        "properties": {
Michel Roy's avatar
Michel Roy committed
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
          "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
852
                      "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
                    }
                  }
                },
                "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"
877
          }
Michel Roy's avatar
Michel Roy committed
878
        },
879
        "required": [
Michel Roy's avatar
Michel Roy committed
880 881
          "associateDevAppId",
          "appInfo"
882
        ],
Michel Roy's avatar
Michel Roy committed
883 884 885 886
        "type": "object",
        "x-etsi-ref": "6.2.4"
      },
      "ApplicationLocationAvailabilityNotification": {
887
        "properties": {
Michel Roy's avatar
Michel Roy committed
888 889 890 891 892 893
          "availableLocations": {
            "description": "Locations available to the MEC application.",
            "items": {
              "type": "object",
              "properties": {
                "appLocation": {
Michel Roy's avatar
Michel Roy committed
894
                  "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
895 896 897 898 899 900 901 902 903 904
                }
              }
            },
            "minItems": 1,
            "required": [
              "appLocation"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "array (Structure (inline))"
905
          },
Michel Roy's avatar
Michel Roy committed
906 907 908 909 910
          "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"
911
          },
Michel Roy's avatar
Michel Roy committed
912 913 914 915 916
          "notificationType": {
            "description": "Shall be set to \"ApplicationLocationAvailabilityNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
917
          }
Michel Roy's avatar
Michel Roy committed
918
        },
919 920
        "type": "object",
        "required": [
Michel Roy's avatar
Michel Roy committed
921 922
          "notificationType",
          "availableLocations"
923
        ],
Michel Roy's avatar
Michel Roy committed
924 925
        "x-etsi-ref": "6.4.5"
      },
Michel Roy's avatar
Michel Roy committed
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
      "InlineNotification": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/AddressChangeNotification"
          },
          {
            "$ref": "#/components/schemas/ApplicationContextDeleteNotification"
          },
          {
            "$ref": "#/components/schemas/ApplicationContextUpdateNotification"
          },
          {
            "$ref": "#/components/schemas/ApplicationLocationAvailabilityNotification"
          }
        ],
        "discriminator": {
          "propertyName": "notificationType"
        }
      },
Michel Roy's avatar
Michel Roy committed
945
      "LocationConstraints": {
946
        "properties": {
Michel Roy's avatar
Michel Roy committed
947
          "area": {
Michel Roy's avatar
Michel Roy committed
948
            "$ref": "#/components/schemas/Polygon"
949
          },
Michel Roy's avatar
Michel Roy committed
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
          "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)"
977
          },
Michel Roy's avatar
Michel Roy committed
978 979 980 981 982 983
          "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"
984
          }
Michel Roy's avatar
Michel Roy committed
985
        },
986
        "type": "object",
Michel Roy's avatar
Michel Roy committed
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
        "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"
          }
        },
        "type": "object"
      },
      "ProblemDetails": {
1012
        "properties": {
Michel Roy's avatar
Michel Roy committed
1013 1014 1015 1016 1017
          "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"
1018
          },
Michel Roy's avatar
Michel Roy committed
1019 1020 1021 1022 1023 1024
          "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"
1025
          },
Michel Roy's avatar
Michel Roy committed
1026 1027
          "status": {
            "description": "The HTTP status code for this occurrence of the problem",
Michel Roy's avatar
Michel Roy committed
1028
            "format": "uint32",
Michel Roy's avatar
Michel Roy committed
1029 1030 1031
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
1032
          },
Michel Roy's avatar
Michel Roy committed
1033 1034 1035 1036 1037
          "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"
1038
          },
Michel Roy's avatar
Michel Roy committed
1039 1040 1041 1042 1043 1044
          "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"
1045
          }
Michel Roy's avatar
Michel Roy committed
1046 1047
        },
        "type": "object"
1048
      }
1049
    }
1050
  }
Michel Roy's avatar
Michel Roy committed
1051
}