Newer
Older
Walter Featherstone
committed
description: Available NTP servers
type: array
items:
$ref: '#/components/schemas/TimingCaps.NtpServers'
ptpMasters:
description: Available PTP Masters
type: array
items:
$ref: '#/components/schemas/TimingCaps_PtpMasters'
Walter Featherstone
committed
TrafficFilter.Address:
description: Identify the traffic ip address.
type: string
Walter Featherstone
committed
example: '192.168.1.1'
Walter Featherstone
committed
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
TrafficFilter.DSCP:
description: >-
Used to match all IPv4 packets that have the same Differentiated
Services Code Point (DSCP)
type: integer
format: uint32
example: 0
TrafficFilter.Port:
description: A port
type: string
example: '8080'
TrafficFilter.Protocol:
description: Protocol of the traffic filter
type: string
example: '?'
TrafficFilter.QCI:
description: >-
Used to match all packets that have the same Quality Class Indicator
(QCI).
type: integer
format: uint32
example: 1
TrafficFilter.TC:
description: Used to match all IPv6 packets that have the same Traffic Class.
type: integer
format: uint32
example: 1
TrafficFilter.Token:
description: Used for token based traffic rule
type: string
example: '?'
TrafficFilter.TunnelAddress:
description: Used for GTP tunnel based traffic rule
type: string
example: '?'
TrafficFilter.TunnelPort:
description: Used for GTP tunnel based traffic rule
type: string
example: '?'
TrafficFilter:
description: This type represents the traffic filter.
type: object
properties:
srcAddress:
description: >-
An IP address or a range of IP address. For IPv4, the IP address
could be an IP address plus mask, or an individual IP address, or a
range of IP addresses. For IPv6, the IP address could be an IP
prefix, or a range of IP prefixes.
type: array
items:
$ref: '#/components/schemas/TrafficFilter.Address'
dstAddress:
description: >-
An IP address or a range of IP address. For IPv4, the IP address
could be an IP address plus mask, or an individual IP address, or a
range of IP addresses. For IPv6, the IP address could be an IP
prefix, or a range of IP prefixes.
type: array
items:
$ref: '#/components/schemas/TrafficFilter.Address'
srcPort:
description: A port or a range of ports
type: array
items:
$ref: '#/components/schemas/TrafficFilter.Port'
dstPort:
description: A port or a range of ports
type: array
items:
$ref: '#/components/schemas/TrafficFilter.Port'
protocol:
description: Specify the protocol of the traffic filter
type: array
items:
$ref: '#/components/schemas/TrafficFilter.Protocol'
token:
description: Used for token based traffic rule
type: array
items:
$ref: '#/components/schemas/TrafficFilter.Token'
srcTunnelAddress:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/components/schemas/TrafficFilter.TunnelAddress'
tgtTunnelAddress:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/components/schemas/TrafficFilter.TunnelAddress'
srcTunnelPort:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/components/schemas/TrafficFilter.TunnelPort'
dstTunnelPort:
description: Used for GTP tunnel based traffic rule
type: array
items:
$ref: '#/components/schemas/TrafficFilter.TunnelPort'
qCI:
$ref: '#/components/schemas/TrafficFilter.QCI'
dSCP:
$ref: '#/components/schemas/TrafficFilter.DSCP'
tC:
$ref: '#/components/schemas/TrafficFilter.TC'
TrafficRule.Action:
description: >-
The action of the ME host data plane when a packet matches the
trafficFilter
type: string
enum:
- DROP
- FORWARD_DECAPSULATED
- FORWARD_AS_IS
- PASSTHROUGH
- DUPLICATE_DECAPSULATED
- DUPLICATE_AS_IS
Walter Featherstone
committed
example: 'DROP'
Walter Featherstone
committed
TrafficRule.FilterType:
description: >-
Definition of filter per FLOW or PACKET. If flow the filter match
UE->EPC packet and the reverse packet is handled in the same context
type: string
enum:
- FLOW
- PACKET
example: FLOW
TrafficRule.Id:
description: Identify the traffic rule.
type: string
Walter Featherstone
committed
example: 'TrafficRule1'
TrafficRule_Priority:
Walter Featherstone
committed
description: >-
Priority of this traffic rule. If traffic rule conflicts, the one with
higher priority take precedence
type: integer
format: uint32
example: 1
TrafficRule.State:
description: Contains the traffic rule state
type: string
enum:
- ACTIVE
- INACTIVE
Walter Featherstone
committed
example: 'ACTIVE'
Walter Featherstone
committed
TrafficRule:
description: This type represents the general information of a traffic rule.
type: object
required:
- trafficRuleId
- filterType
- priority
- trafficFilter
- action
- state
properties:
trafficRuleId:
$ref: '#/components/schemas/TrafficRule.Id'
filterType:
$ref: '#/components/schemas/TrafficRule.FilterType'
priority:
$ref: '#/components/schemas/TrafficRule_Priority'
Walter Featherstone
committed
trafficFilter:
Walter Featherstone
committed
type: array
items:
$ref: '#/components/schemas/TrafficFilter'
Walter Featherstone
committed
action:
$ref: '#/components/schemas/TrafficRule.Action'
dstInterface:
$ref: '#/components/schemas/DestinationInterface'
state:
$ref: '#/components/schemas/TrafficRule.State'
TransportInfo.Description:
description: Human-readable description of this transport
type: string
Walter Featherstone
committed
example: 'REST API'
Walter Featherstone
committed
TransportInfo.Id:
description: The identifier of this transport
type: string
Walter Featherstone
committed
example: 'TransId12345'
Walter Featherstone
committed
TransportInfo.ImplSpecificInfo:
description: Additional implementation specific details of the transport
type: object
TransportInfo.Name:
description: The name of this transport
type: string
Walter Featherstone
committed
example: 'REST'
Walter Featherstone
committed
TransportInfo.Protocol:
description: The name of the protocol used. Shall be set to HTTP for a REST API.
type: string
Walter Featherstone
committed
example: 'HTTP'
Walter Featherstone
committed
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
TransportInfo.Version:
description: The version of the protocol used
type: string
example: '2.0'
TransportInfo:
description: This type represents the general information of a mobile edge service.
type: object
required:
- id
- name
- type
- protocol
- version
- endpoint
- security
properties:
id:
$ref: '#/components/schemas/TransportInfo.Id'
name:
$ref: '#/components/schemas/TransportInfo.Name'
description:
$ref: '#/components/schemas/TransportInfo.Description'
type:
$ref: '#/components/schemas/TransportTypes'
protocol:
$ref: '#/components/schemas/TransportInfo.Protocol'
version:
$ref: '#/components/schemas/TransportInfo.Version'
endpoint:
description: This type represents information about a transport endpoint
type: object
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
Walter Featherstone
committed
security:
$ref: '#/components/schemas/SecurityInfo'
implSpecificInfo:
$ref: '#/components/schemas/TransportInfo.ImplSpecificInfo'
TransportTypes:
description: The enumeration TransportTypes represents types of transports
type: string
enum:
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
Walter Featherstone
committed
example: 'REST_HTTP'
Walter Featherstone
committed
TunnelInfo.TunnelDstAddress:
description: Destination address of the tunnel
type: string
example: '?'
TunnelInfo.TunnelSrcAddress:
description: Source address of the tunnel
type: string
example: '?'
TunnelInfo.TunnelType:
description: This type represents the tunnel information.
type: string
enum:
- GTP_U
- GRE
Walter Featherstone
committed
example: 'GTP_U'
Walter Featherstone
committed
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
TunnelInfo:
description: This type represents the tunnel information.
type: object
required:
- tunnelType
properties:
tunnelType:
$ref: '#/components/schemas/TunnelInfo.TunnelType'
tunnelDstAddress:
$ref: '#/components/schemas/TunnelInfo.TunnelDstAddress'
tunnelSrcAddress:
$ref: '#/components/schemas/TunnelInfo.TunnelSrcAddress'
parameters:
Path.AppInstanceId:
name: appInstanceId
description: >-
Represents a mobile edge application instance. Note that the
appInstanceId is allocated by the mobile edge platform manager.
in: path
required: true
schema:
Walter Featherstone
committed
Path.DnsRuleId:
name: dnsRuleId
description: Represents a DNS rule.
in: path
required: true
schema:
Walter Featherstone
committed
Path.SubscriptionId:
name: subscriptionId
description: >-
Represents a subscription to the notifications from the mobile edge
platform.
in: path
required: true
schema:
Walter Featherstone
committed
Path.SubscriptionType:
name: subscriptionType
description: >-
Represents a subscription type to the notifications from the mobile edge
platform.
in: path
required: true
schema:
type: string
enum:
- AppTerminationNotificationSubscription
- SerAvailabilityNotificationSubscription
Walter Featherstone
committed
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
Path.ServiceId:
name: serviceId
description: Represents a mobile edge service instance.
in: path
required: true
schema:
type: string
Path.TrafficRuleId:
name: trafficRuleId
description: Represents a traffic rule.
in: path
required: true
schema:
type: string
Query.Ser_category_id:
name: ser_category_id
description: >-
A mobile edge application instance may use ser_category_id as an input
parameter to query the availability of a list of mobile edge service
instances in a serCategory. Either "ser_instance_id" or "ser_name" or
"ser_category_id" or none of them shall be present.
in: query
required: false
schema:
type: string
Query.Ser_instance_id:
name: ser_instance_id
description: >-
A mobile edge application instance may use multiple ser_instance_ids as
an input parameter to query the availability of a list of mobile edge
service instances. Either "ser_instance_id" or "ser_name" or
"ser_category_id" or none of them shall be present.
in: query
required: false
schema:
Walter Featherstone
committed
type: string
Query.Ser_name:
name: ser_name
description: >-
A mobile edge application instance may use multiple ser_names as an
input parameter to query the availability of a list of mobile edge
service instances. Either "ser_instance_id" or "ser_name" or
"ser_category_id" or none of them shall be present.
in: query
required: false
schema:
Walter Featherstone
committed
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
type: string
responses:
ApplicationsDnsRules.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/DnsRule'
examples:
DnsRules:
$ref: '#/components/examples/DnsRules'
links:
getIndividualMeDNSRule:
$ref: '#/components/links/GetIndividualMeDNSRule'
putIndividualMeDNSRule:
$ref: '#/components/links/PutIndividualMeDNSRule'
ApplicationsDnsRule.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
DnsRule:
$ref: '#/components/examples/DnsRule'
ApplicationsSubscriptions.200:
description: >-
Upon success, a response body containing the list of links to the
requested subscriptions is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/Mp1SubscriptionLinkList'
links:
getIndividualMeMp1SubscriptionLinkList:
$ref: '#/components/links/GetIndividualMeMp1SubscriptionLinkList'
delIndividualMeMp1SubscriptionLinkList:
$ref: '#/components/links/DelIndividualMeMp1SubscriptionLinkList'
ApplicationsSubscriptions.201:
description: >-
Entity body in the request contains a subscription to the mobile
edge service availability notifications that is to be created.
headers:
location:
description: The resource URI of the created resource
schema:
type: string
format: uri
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppTerminationNotificationSubscription'
- $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
links:
getIndividualMeMp1Subscription:
$ref: '#/components/links/GetIndividualMeMp1Subscription'
delIndividualMeMp1Subscription:
$ref: '#/components/links/DelIndividualMeMp1Subscription'
ApplicationsSubscription.200:
description: >-
Upon success, a response body containing the requested subscription
is returned.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppTerminationNotificationSubscription'
- $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
ApplicationsTrafficRules.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/TrafficRule'
examples:
TrafficRules:
$ref: '#/components/examples/TrafficRules'
links:
getIndividualMeTrafficRule:
$ref: '#/components/links/GetIndividualMeTrafficRule'
putIndividualMeTrafficRule:
$ref: '#/components/links/PutIndividualMeTrafficRule'
ApplicationsTrafficRule.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
TrafficRule:
$ref: '#/components/examples/TrafficRule'
Services.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfoList:
$ref: '#/components/examples/ServiceInfoList'
links:
getIndividualMeService:
$ref: '#/components/links/GetIndividualMeService'
putIndividualMeService:
$ref: '#/components/links/PutIndividualMeService'
Services.201:
description: >-
Upon success, the HTTP response shall include a Location HTTP header
that contains the resource URI of the created resource.
headers:
location:
description: The resource URI of the created resource
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfo:
$ref: '#/components/examples/ServiceInfo'
links:
getIndividualMeService:
$ref: '#/components/links/GetIndividualMeService'
putIndividualMeService:
$ref: '#/components/links/PutIndividualMeService'
ServicesServiceId.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfo:
$ref: '#/components/examples/ServiceInfo'
TimingCurrentTime.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentTime'
TimingCaps.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/TimingCaps'
Transports.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/TransportInfo'
links:
getTransportInfo:
$ref: '#/components/links/GetTransportInfo'
Walter Featherstone
committed
Error.400:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
schema:
$ref: '#/components/schemas/Empty'
Error.403:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Error.404:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
schema:
$ref: '#/components/schemas/Empty'
Error.412:
description: Precondition Failed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
schema:
$ref: '#/components/schemas/Empty'
requestBodies:
ApplicationsDnsRule:
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
description: The updated state is included in the entity body of the request.
required: true
ApplicationsSubscriptions:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppTerminationNotificationSubscription'
- $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
description: >-
Entity body in the request contains a subscription to the mobile edge
application termination notifications that is to be created.
required: true
ApplicationsTrafficRule:
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
description: One or more updated attributes that are allowed to be changed
required: true
Services:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
required: true
Services.Post:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo.Post'
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
required: true
Walter Featherstone
committed
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
ServicesServiceId:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
required: true
AppTerminationNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotification'
required: true
ServiceAvailabilityNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAvailabilityNotification'
required: true
callbacks:
AppTerminationNotification:
'$request.body#/callbackReference':
post:
requestBody:
$ref: '#/components/requestBodies/AppTerminationNotification'
responses:
'200':
description: Expected responses from callback consumer, if it accepts the callback
ServiceAvailabilityNotification:
'$request.body#/callbackReference':
post:
requestBody:
$ref: '#/components/requestBodies/ServiceAvailabilityNotification'
responses:
'200':
description: Expected responses from callback consumer, if it accepts the callback
links:
GetIndividualMeService:
operationId: ServicesServiceId_GET
Walter Featherstone
committed
description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}`
parameters:
serviceId: '$response.body#/serviceId'
PutIndividualMeService:
operationId: ServicesServiceId_PUT
Walter Featherstone
committed
description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}`
parameters:
serviceId: '$response.body#/serviceId'
GetIndividualMeDNSRule:
operationId: ApplicationsDnsRule_GET
Walter Featherstone
committed
description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `GET /applications/{appInstanceId}/dns_rules/{dnsRuleId}`
parameters:
dnsRuleId: '$response.body#/dnsRuleId'
PutIndividualMeDNSRule:
operationId: ApplicationsDnsRule_PUT
Walter Featherstone
committed
description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `PUT /applications/{appInstanceId}/dns_rules/{dnsRuleId}`
parameters:
dnsRuleId: '$response.body#/dnsRuleId'
GetIndividualMeTrafficRule:
operationId: ApplicationsTrafficRule_GET
Walter Featherstone
committed
description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `GET /applications/{appInstanceId}/traffic_rules/{trafficRuleId}`
parameters:
trafficRuleId: '$response.body#/trafficRuleId'
PutIndividualMeTrafficRule:
operationId: ApplicationsTrafficRule_PUT
Walter Featherstone
committed
description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `PUT /applications/{appInstanceId}/traffic_rules/{trafficRuleId}`
parameters:
trafficRuleId: '$response.body#/trafficRuleId'
GetTransportInfo:
operationId: AppServices_POST
description: The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported
parameters:
transportId: '$response.body#/0/id'
Walter Featherstone
committed
GetIndividualMeMp1Subscription:
operationId: ApplicationsSubscription_GET
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
DelIndividualMeMp1Subscription:
operationId: ApplicationsSubscription_DELETE
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
GetIndividualMeMp1SubscriptionLinkList:
operationId: ApplicationsSubscription_GET
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
DelIndividualMeMp1SubscriptionLinkList:
operationId: ApplicationsSubscription_DELETE
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
examples:
DnsRule:
value:
Walter Featherstone
committed
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
Walter Featherstone
committed
ttl: 300
Walter Featherstone
committed
state: 'ACTIVE'
Walter Featherstone
committed
DnsRules:
value:
Walter Featherstone
committed
- dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
Walter Featherstone
committed
ttl: 300
Walter Featherstone
committed
state: 'ACTIVE'
Walter Featherstone
committed
ServiceInfo:
value:
Walter Featherstone
committed
serInstanceId: 'ServiceInstance123'
serName: 'ExampleService'
Walter Featherstone
committed
serCategory:
Walter Featherstone
committed
href: 'catItem1'
id: 'id12345'
name: 'RNI'
version: 'version1'
version: 'ServiceVersion1'
state: 'ACTIVE'
Walter Featherstone
committed
transportInfo:
Walter Featherstone
committed
id: 'TransId12345'
name: 'REST'
description: 'REST API'
type: 'REST_HTTP'
protocol: 'HTTP'
Walter Featherstone
committed
version: '2.0'
endpoint:
uris:
Walter Featherstone
committed
- '/meMp1/service/EntryPoint'
Walter Featherstone
committed
security:
oAuth2Info:
Walter Featherstone
committed
grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: 'JSON'
Walter Featherstone
committed
ServiceInfoList:
value:
Walter Featherstone
committed
- serInstanceId: 'ServiceInstance123'
serName: 'ExampleService'
Walter Featherstone
committed
serCategory:
Walter Featherstone
committed
href: 'catItem1'
id: 'id12345'
name: 'RNI'
version: 'version1'
version: 'ServiceVersion1'
state: 'ACTIVE'
Walter Featherstone
committed
transportInfo:
Walter Featherstone
committed
id: 'TransId12345'
name: 'REST'
description: 'REST API'
type: 'REST_HTTP'
protocol: 'HTTP'
Walter Featherstone
committed
version: '2.0'
endpoint:
addresses:
Walter Featherstone
committed
- host: '192.0.2.0'
port: 8080
Walter Featherstone
committed
security:
oAuth2Info:
Walter Featherstone
committed
grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: 'JSON'
Walter Featherstone
committed
TrafficRule:
value:
Walter Featherstone
committed
trafficRuleId: 'TrafficRule123'
serName: 'ExampleService'
filterType: 'FLOW'
Walter Featherstone
committed
priority: 1
trafficFilter:
Walter Featherstone
committed
- srcAddress:
- '192.168.2.0/24'
- '192.168.3.0/24'
dstAddress:
- '192.127.4.100/32'
dstPort:
- '80'
action: 'FORWARD_DECAPSULATED'
Walter Featherstone
committed
dstInterface:
Walter Featherstone
committed
interfaceType: 'IP'
dstIpAddress: '20.1.1.1'
state: 'ACTIVE'
Walter Featherstone
committed
TrafficRules:
value:
Walter Featherstone
committed
- trafficRuleId: 'TrafficRule123'
serName: 'ExampleService'
filterType: 'FLOW'
Walter Featherstone
committed
priority: 1
trafficFilter:
Walter Featherstone
committed
- srcAddress:
- '192.168.2.0/24'
- '192.168.3.0/24'
dstAddress:
- '192.127.4.100/32'
dstPort:
- '80'
action: 'FORWARD_DECAPSULATED'
Walter Featherstone
committed
dstInterface:
Walter Featherstone
committed
interfaceType: 'IP'
dstIpAddress: '20.1.1.1'
state: 'ACTIVE'