Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
'403':
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
/transports:
get:
tags:
- transports
summary: Transports_GET
description: This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the MEC platform in the "transport information query" procedure
operationId: Transports_GET
parameters: []
responses:
'200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
minItems: 0
type: array
items:
$ref: '#/components/schemas/TransportInfo'
description: ''
contentMediaType: application/json
'400':
description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
'403':
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
type: object
description: Empty schema
contentMediaType: text/plain
deprecated: false
parameters: []
components:
schemas:
CategoryRef:
title: CategoryRef
required:
- href
- id
- name
- version
type: object
properties:
href:
type: string
description: Reference of the catalogue
examples:
- /example/catalogue1
id:
type: string
description: Unique identifier of the category
examples:
- id12345
name:
type: string
description: Name of the category, example values include RNI, Location & Bandwidth Management
examples:
- RNI
version:
type: string
description: Category version
examples:
- version1
description: This type represents the category reference
EndPointInfo.Address:
title: EndPointInfo.Address
required:
- host
- port
type: object
properties:
host:
type: string
description: Host portion of the address
examples:
- 192.0.2.0
port:
type: integer
description: Port portion of the address
contentEncoding: int32
examples:
- 8080
description: A IP address and port pair
EndPointInfo.Addresses:
title: EndPointInfo.Addresses
required:
- addresses
type: object
properties:
addresses:
minItems: 0
type: array
items:
$ref: '#/components/schemas/EndPointInfo.Address'
description: ''
description: Entry point information of the service as one or more pairs of IP address and port
EndPointInfo.Alternative:
title: EndPointInfo.Alternative
required:
- alternative
type: object
properties:
alternative:
type: object
description: Entry point information of the service in a format defined by an implementation, or in an external specification.
EndPointInfo.Uris:
title: EndPointInfo.Uris
required:
- uris
type: object
properties:
uris:
minItems: 0
type: array
items:
type: string
description: ''
description: Entry point information of the service as string, formatted according to URI syntax
LinkType:
title: LinkType
type: object
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecSerMgmtApi/example
description: This type represents a type of link and may be referenced from data structures
MecServiceMgmtApiSubscriptionLinkList.Links:
title: MecServiceMgmtApiSubscriptionLinkList.Links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Subscription'
description: The MEC application instance's subscriptions
description: Self-referring URI.
MecServiceMgmtApiSubscriptionLinkList.Subscription:
title: MecServiceMgmtApiSubscriptionLinkList.Subscription
required:
- href
- rel
type: object
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecSerMgmtApi/example
rel:
type: string
description: The value shall be se to SerAvailabilityNotificationSubscription.
description: A link to a subscription.
MecServiceMgmtApiSubscriptionLinkList:
title: MecServiceMgmtApiSubscriptionLinkList
required:
- _links
type: object
properties:
_links:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Links'
description: This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.
ProblemDetails:
title: ProblemDetails
type: object
properties:
type:
type: string
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
instance:
type: string
description: A URI reference that identifies the specific occurrence of the problem
SecurityInfo.OAuth2Info.GrantType:
title: SecurityInfo.OAuth2Info.GrantType
enum:
- OAUTH2_AUTHORIZATION_CODE
- OAUTH2_IMPLICIT_GRANT
- OAUTH2_RESOURCE_OWNER
- OAUTH2_CLIENT_CREDENTIALS
type: string
description: OAuth 2.0 grant type
examples:
- OAUTH2_CLIENT_CREDENTIALS
SecurityInfo.OAuth2Info:
title: SecurityInfo.OAuth2Info
required:
- grantTypes
- tokenEndpoint
type: object
properties:
grantTypes:
maxItems: 4
minItems: 1
type: array
items:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantType'
description: List of supported OAuth 2.0 grant types.
tokenEndpoint:
type: string
description: The token endpoint
examples:
- /mecSerMgmtApi/security/TokenEndPoint
description: Parameters related to use of OAuth 2.0
SecurityInfo:
title: SecurityInfo
type: object
properties:
oAuth2Info:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info'
description: This type represents security information related to a transport
Self:
title: Self
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Self-referring URI.
SerAvailabilityNotificationSubscription:
title: SerAvailabilityNotificationSubscription
required:
- subscriptionType
- callbackReference
- _links
type: object
properties:
subscriptionType:
type: string
description: Shall be set to SerAvailabilityNotificationSubscription.
examples:
- SerAvailabilityNotificationSubscription
callbackReference:
type: string
description: URI selected by the MEC application instance to receive notifications on the subscribed MEC service availability information. This shall be included in both the request and the response.
_links:
$ref: '#/components/schemas/Self'
filteringCriteria:
type: 'null'
not:
type: object
description: Filtering criteria to match services for which events are requested to be reported. If absent, matches all services. All child attributes are combined with the logical "AND" operation.
description: This type represents a subscription to the notifications from the MEC platform regarding the availability of a MEC service or a list of MEC services.
SerAvailabilityNotificationSubscription.FilteringCriteria:
title: SerAvailabilityNotificationSubscription.FilteringCriteria
type: object
properties:
serInstanceIds:
minItems: 0
type: array
items:
type: string
description: Identifiers of service instances about which to report events.
serNames:
minItems: 0
type: array
items:
type: string
description: Names of services about which to report events.
serCategories:
minItems: 0
type: array
items:
$ref: '#/components/schemas/CategoryRef'
description: Categories of services about which to report events.
states:
minItems: 0
type: array
items:
$ref: '#/components/schemas/ServiceState'
description: States of the services about which to report events. If the event is a state change, this filter represents the state after the change.
isLocal:
type: boolean
description: Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
examples:
- true
description: Filtering criteria to match services for which events are requested to be reported. If absent, matches all services. All child attributes are combined with the logical "AND" operation.
ServiceAvailabilityNotification:
title: ServiceAvailabilityNotification
required:
- notificationType
- serviceReferences
- _links
type: object
properties:
notificationType:
type: string
description: Shall be set to SerAvailabilityNotificationSubscription.
examples:
- SerAvailabilityNotificationSubscription
serviceReferences:
type: array
items:
$ref: '#/components/schemas/ServiceAvailabilityNotification.ServiceReferences'
description: ''
_links:
$ref: '#/components/schemas/Subscription'
description: This type represents the service availability information.
ServiceAvailabilityNotification.ServiceReferences:
title: ServiceAvailabilityNotification.ServiceReferences
required:
- serName
- serInstanceId
- state
- changeType
type: object
properties:
link:
$ref: '#/components/schemas/LinkType'
serName:
type: string
description: The name of the service. This is how the service producing MEC application identifies the service instance it produces.
examples:
- ExampleService
serInstanceId:
type: string
description: Identifier of the service instance assigned by the MEC platform.
examples:
- ServiceInstance123
state:
$ref: '#/components/schemas/ServiceState'
changeType:
$ref: '#/components/schemas/ServiceAvailabilityNotification.ChangeType'
description: List of links to services whose availability has changed.
ServiceAvailabilityNotification.ChangeType:
title: ServiceAvailabilityNotification.ChangeType
enum:
- ADDED
- REMOVED
- STATE_CHANGED
- ATTRIBUTES_CHANGED
type: string
description: "Type of the change. Valid values:\n ADDED: The service was newly added.\n REMOVED: The service was removed.\n STATE_CHANGED: Only the state of the service was changed. \n ATTRIBUTES_CHANGED: At least one attribute of the service other than state was changed. The change may or may not include changing the state."
examples:
- ADDED
SerializerType:
title: SerializerType
enum:
- JSON
- XML
- PROTOBUF3
type: string
description: The enumeration represents types of serializers
examples:
- JSON
LocalityType:
title: LocalityType
enum:
- MEC_SYSTEM
- MEC_HOST
- NFVI_POP
- ZONE
- ZONE_GROUP
- NFVI_NODE
type: string
description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST
examples:
- MEC_SYSTEM
ServiceState:
title: ServiceState
enum:
- ACTIVE
- INACTIVE
type: string
description: This enumeration defines the possible states of a service.
examples:
- ACTIVE
ServiceInfo.Post:
title: ServiceInfo.Post
required:
- serName
- version
- state
- serializer
type: object
properties:
serInstanceId:
type: string
description: Identifier of the service instance assigned by the MEC platform.
examples:
- ServiceInstance123
serName:
type: string
description: The name of the service. This is how the service producing MEC application identifies the service instance it produces.
examples:
- ExampleService
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
type: string
description: Service version
examples:
- ServiceVersion1
state:
$ref: '#/components/schemas/ServiceState'
transportId:
type: string
description: Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the "Transport information query" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.
examples:
- Rest1
transportInfo:
$ref: '#/components/schemas/TransportInfo'
serializer:
$ref: '#/components/schemas/SerializerType'
scopeOfLocality:
$ref: '#/components/schemas/LocalityType'
consumedLocalOnly:
type: boolean
description: Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.
examples:
- false
isLocal:
type: boolean
description: Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
examples:
- true
description: This type represents the general information of a MEC service.
ServiceInfo:
title: ServiceInfo
required:
- serName
- version
- state
- transportInfo
- serializer
type: object
properties:
serInstanceId:
type: string
description: Identifier of the service instance assigned by the MEC platform.
examples:
- ServiceInstance123
serName:
type: string
description: The name of the service. This is how the service producing MEC application identifies the service instance it produces.
examples:
- ExampleService
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
type: string
description: Service version
examples:
- ServiceVersion1
state:
$ref: '#/components/schemas/ServiceState'
transportInfo:
$ref: '#/components/schemas/TransportInfo'
serializer:
$ref: '#/components/schemas/SerializerType'
scopeOfLocality:
$ref: '#/components/schemas/LocalityType'
consumedLocalOnly:
type: boolean
description: Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.
examples:
- false
isLocal:
type: boolean
description: Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
examples:
- true
description: This type represents the general information of a MEC service.
Subscription:
title: Subscription
required:
- subscription
type: object
properties:
subscription:
$ref: '#/components/schemas/LinkType'
description: A link to the related subscription
TransportInfo:
title: TransportInfo
required:
- id
- name
- type
- protocol
- version
- endpoint
- security
type: object
properties:
id:
type: string
description: The identifier of this transport
examples:
- TransId12345
name:
type: string
description: The name of this transport
examples:
- REST
description:
type: string
description: Human-readable description of this transport
examples:
- REST API
type:
$ref: '#/components/schemas/TransportType'
protocol:
type: string
description: The name of the protocol used. Shall be set to HTTP for a REST API.
examples:
- HTTP
version:
type: string
description: The version of the protocol used
examples:
- '2.0'
endpoint:
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
description: This type represents information about a transport endpoint
security:
$ref: '#/components/schemas/SecurityInfo'
implSpecificInfo:
type: object
description: Additional implementation specific details of the transport
description: This type represents the general information of a MEC service.
TransportType:
title: TransportType
enum:
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
type: string
description: The enumeration TransportType represents types of transports
examples:
- REST_HTTP
security:
- {}
tags:
- name: appSubscriptions
- name: appServices
- name: services
- name: transports
- name: callbacks
externalDocs:
description: ETSI GS MEC011 Application Enablement API, V2.1.1
url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf