Newer
Older
description: >-
A URI reference according to IETF RFC 3986 that identifies the
problem type
Walter Featherstone
committed
title:
description: 'A short, human-readable summary of the problem type'
Walter Featherstone
committed
status:
type: integer
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
Walter Featherstone
committed
detail:
description: >-
A human-readable explanation specific to this occurrence of the
problem
Walter Featherstone
committed
instance:
description: >-
A URI reference that identifies the specific occurrence of the
problem
Walter Featherstone
committed
Self:
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
self:
$ref: '#/components/schemas/LinkType'
Walter Featherstone
committed
TimingCaps.NtpServers.AuthenticationOption:
title: TimingCaps.NtpServers.AuthenticationOption
Walter Featherstone
committed
enum:
- NONE
- SYMMETRIC_KEY
- AUTO_KEY
Walter Featherstone
committed
type: string
description: NTP authentication option
examples:
Walter Featherstone
committed
TimingCaps.NtpServers.NtpServerAddrType:
title: TimingCaps.NtpServers.NtpServerAddrType
Walter Featherstone
committed
enum:
- IP_ADDRESS
- DNS_NAME
Walter Featherstone
committed
type: string
description: Address type of NTP server
examples:
Walter Featherstone
committed
TimingCaps.NtpServers:
Walter Featherstone
committed
required:
- ntpServerAddrType
- ntpServerAddr
- minPollingInterval
- maxPollingInterval
- localPriority
- authenticationOption
Walter Featherstone
committed
properties:
ntpServerAddrType:
$ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType'
ntpServerAddr:
type: string
description: NTP server address
examples:
Walter Featherstone
committed
minPollingInterval:
description: >-
Minimum poll interval for NTP messages, in seconds as a power of
two. Range 3 to 17
contentEncoding: int32
examples:
Walter Featherstone
committed
maxPollingInterval:
description: >-
Maximum poll interval for NTP messages, in seconds as a power of
two. Range 3 to 17
contentEncoding: int32
examples:
Walter Featherstone
committed
localPriority:
type: integer
description: NTP server local priority
contentEncoding: int32
examples:
Walter Featherstone
committed
authenticationOption:
$ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationOption'
authenticationKeyNum:
description: >-
Authentication key number. This configuration is valid and shall be
present if authenticationOption is set to SYMMETRIC_KEY
contentEncoding: int32
examples:
Walter Featherstone
committed
description: NTP server detail.
TimingCaps_PtpMasters:
title: TimingCaps_PtpMasters
Walter Featherstone
committed
required:
- ptpMasterIpAddress
- ptpMasterLocalPriority
- delayReqMaxRate
Walter Featherstone
committed
properties:
ptpMasterIpAddress:
description: PTP Server (referred to as "master" in IEEE 1588-2019) IP Address
Walter Featherstone
committed
ptpMasterLocalPriority:
description: >-
PTP Server (referred to as "master" in IEEE 1588-2019 ) local
priority
contentEncoding: int32
examples:
Walter Featherstone
committed
delayReqMaxRate:
description: >-
Acceptable maximum rate of the Delay_Req messages in packets per
second
contentEncoding: int32
examples:
Walter Featherstone
committed
TimingCaps.TimeStamp:
Walter Featherstone
committed
required:
- seconds
- nanoSeconds
Walter Featherstone
committed
properties:
seconds:
type: integer
description: >-
The seconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
contentEncoding: int32
examples:
Walter Featherstone
committed
nanoSeconds:
type: integer
description: >-
The nanoseconds part of the time. Time is defined as Unix-time since
January 1, 1970, 00:00:00 UTC
contentEncoding: int32
examples:
Walter Featherstone
committed
TimingCaps:
Walter Featherstone
committed
type: object
properties:
timeStamp:
$ref: '#/components/schemas/TimingCaps.TimeStamp'
ntpServers:
type: array
items:
$ref: '#/components/schemas/TimingCaps.NtpServers'
Walter Featherstone
committed
ptpMasters:
type: array
items:
$ref: '#/components/schemas/TimingCaps_PtpMasters'
description: >-
Number of available PTP Servers (referred to as "masters" in IEEE
1588-2019)
description: >-
This type represents the information provided by the MEC platform in
response to the Timing capabilities Query message.
Walter Featherstone
committed
TrafficFilter:
Walter Featherstone
committed
type: object
properties:
srcAddress:
type: array
items:
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.
Walter Featherstone
committed
dstAddress:
type: array
items:
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.
Walter Featherstone
committed
srcPort:
type: array
items:
Walter Featherstone
committed
description: A port or a range of ports
Walter Featherstone
committed
type: array
items:
type: string
description: A port or a range of ports
Walter Featherstone
committed
protocol:
type: array
items:
type: string
description: Specify the protocol of the traffic filter
Walter Featherstone
committed
type: array
items:
type: string
description: Used for token based traffic rule
Walter Featherstone
committed
srcTunnelAddress:
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
Walter Featherstone
committed
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
type: array
items:
type: string
description: Used for GTP tunnel based traffic rule
Walter Featherstone
committed
qCI:
description: >-
Used to match all packets that have the same Quality Class Indicator
(QCI).
contentEncoding: int32
examples:
Walter Featherstone
committed
dSCP:
description: >-
Used to match all IPv4 packets that have the same Differentiated
Services Code Point (DSCP)
contentEncoding: int32
examples:
Walter Featherstone
committed
tC:
type: integer
description: Used to match all IPv6 packets that have the same Traffic Class.
contentEncoding: int32
examples:
description: This type represents the traffic filter.
Walter Featherstone
committed
TrafficRule.Action:
Walter Featherstone
committed
enum:
- DROP
- FORWARD_DECAPSULATED
- FORWARD_ENCAPSULATED
- PASSTHROUGH
- DUPLICATE_DECAPSULATED
- DUPLICATE_ENCAPSULATED
Walter Featherstone
committed
type: string
description: >-
The action of the MEC host data plane when a packet matches the
trafficFilter
TrafficRule.FilterType:
title: TrafficRule.FilterType
Walter Featherstone
committed
enum:
Walter Featherstone
committed
type: string
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
Walter Featherstone
committed
TrafficRule.State:
Walter Featherstone
committed
enum:
description: >-
Contains the traffic rule state. This attribute may be updated using
HTTP PUT method
Walter Featherstone
committed
TrafficRule:
Walter Featherstone
committed
required:
- trafficRuleId
- filterType
- priority
- trafficFilter
- action
- state
Walter Featherstone
committed
properties:
trafficRuleId:
type: string
description: Identify the traffic rule.
examples:
Walter Featherstone
committed
filterType:
$ref: '#/components/schemas/TrafficRule.FilterType'
priority:
description: >-
Priority of this traffic rule within the range 0 to 255. If traffic
rules conflict, the one with higher priority take precedence. Value
indicates the priority in descending order, i.e. with 0 as the
highest priority and 255 as the lowest priority.
contentEncoding: int32
examples:
Walter Featherstone
committed
trafficFilter:
Walter Featherstone
committed
type: array
items:
$ref: '#/components/schemas/TrafficFilter'
Walter Featherstone
committed
action:
$ref: '#/components/schemas/TrafficRule.Action'
dstInterface:
type: array
items:
$ref: '#/components/schemas/DestinationInterface'
maxItems: 2
Walter Featherstone
committed
state:
$ref: '#/components/schemas/TrafficRule.State'
description: This type represents the general information of a traffic rule.
x-etsi-notes: "NOTE 1:\tValue indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest priority.\nNOTE 2:\tSome applications (like inline/tap) require two interfaces. The first interface in the case of inline/tap is on the client (e.g. UE) side and the second on the core network (e.g. EPC) side."
Walter Featherstone
committed
TunnelInfo.TunnelType:
Walter Featherstone
committed
enum:
Walter Featherstone
committed
description: This type represents the tunnel information.
Walter Featherstone
committed
required:
Walter Featherstone
committed
properties:
tunnelType:
$ref: '#/components/schemas/TunnelInfo.TunnelType'
tunnelDstAddress:
type: string
description: Destination address of the tunnel
Walter Featherstone
committed
examples:
tunnelSrcAddress:
type: string
description: Source address of the tunnel
Walter Featherstone
committed
examples:
description: This type represents the tunnel information.
TimeSourceStatus:
title: TimeSourceStatus
enum:
- TRACEABLE
- NONTRACEABLE
description: >-
Platform Time Source status. 1 = TRACEABLE - time source is locked to
the UTC time source. 2 = NONTRACEABLE - time source is not locked to the
UTC time source
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
- TRACEABLE
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:
type: array
items:
$ref: '#/components/schemas/EndPointInfo.Address'
description: >-
Entry point information of the service as one or more pairs of IP
address and port. See note.
description: This type represents information about a transport endpoint.
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. See note.
description: This type represents information about a transport endpoint.
EndPointInfo.Uris:
title: EndPointInfo.Uris
required:
- uris
type: object
properties:
uris:
type: array
items:
type: string
description: >-
Entry point information of the service as string, formatted
according to URI syntax
description: This type represents information about a transport endpoint.
EndPointInfo.Fqdn:
title: EndPointInfo.Fqdn
required:
- fqdn
type: object
properties:
fqdn:
type: array
items:
type: string
description: Fully Qualified Domain Name of the service. See note.
description: 'This type represents information about a transport endpoint. '
ServiceDependency:
properties:
requestedPermissions:
description: >-
Requested permissions regarding the access of the application to the
service. See clause 8.2 of ETSI GS MEC 009 [4].
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
The format of this attribute is left for the data model design
stage.
items:
$ref: '#/components/schemas/Not_specified'
minItems: 0
type: array
serCategory:
$ref: '#/components/schemas/CategoryRef'
serName:
description: 'The name of the service, for example, RNIS, LocationService, etc.'
type: string
serTransportDependencies:
description: >-
Indicates transport and serialization format dependencies of
consuming the service. Defaults to REST + JSON if absent. See note.
items:
$ref: '#/components/schemas/TransportDependency'
minItems: 0
type: array
version:
description: The version of the service.
type: string
required:
- serName
- version
type: object
x-etsi-notes: "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application."
TransportDependency:
properties:
labels:
description: >-
Set of labels that allow to define groups of transport bindings. The
mechanism of the grouping is defined below this table.
items:
type: string
minItems: 1
type: array
serializers:
description: >-
Information about the serializers in this transport binding, as
defined in the SerializerType type in ETSI GS MEC 011 [i.4]. Support
for at least one of the entries is required in conjunction with the
transport.
items:
$ref: '#/components/schemas/SerializerType'
minItems: 1
type: array
transport:
$ref: '#/components/schemas/TransportDescriptor'
required:
- transport
- serializers
- labels
type: object
TransportDescriptor:
properties:
protocol:
description: >-
The name of the protocol used. Shall be set to "HTTP" for a REST
API.
type: string
security:
$ref: '#/components/schemas/SecurityInfo'
type:
$ref: '#/components/schemas/TransportType'
version:
description: The version of the protocol used.
type: string
required:
- type
- protocol
- version
- security
type: object
SerializerType:
title: SerializerType
enum:
- JSON
- XML
- PROTOBUF3
type: string
description: The enumeration represents types of serializers
examples:
- JSON
SecurityInfo:
title: SecurityInfo
type: object
properties:
oAuth2Info:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info'
description: This type represents security information related to a transport
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.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
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
FeatureDependency:
properties:
featureName:
description: 'The name of the feature, for example, UserApps, UEIdentity, etc.'
type: string
version:
description: The version of the feature.
type: string
required:
- featureName
- version
type: object
AppProfile:
type: object
required:
- easId
- endPt
- acIds
- scheds
- permLvl
- easFeats
- svcContSupp
- appLocs
properties:
easId:
description: The identifier of the EAS
type: string
examples:
- appName
endPt:
description: The version of the feature.
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Fqdn'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
acIds:
type: array
items:
type: string
minItems: 1
description: Identities of the Application Clients that can be served by the EAS
provId:
type: string
description: Identifier of the ASP that provides the EAS.
examples:
- appProvider1
type:
description: The category or type of EAS.
type: string
scheds:
type: array
items:
type: string
minItems: 1
description: The availability schedule of the EAS.
svcArea:
type: string
description: >-
The list of geographical and topological areas that the EAS serves.
ACs in the UE that are outside the area will not be served.
svcKpi:
type: string
description: Service characteristics provided by the EAS.
permLvl:
type: array
items:
type: string
minItems: 1
description: level of service permissions supported by the EAS.
easFeats:
type: array
items:
type: string
minItems: 1
description: Service features supported by the EAS.
svcContSupp:
type: array
items:
type: string
minItems: 1
description: The ACR scenarios supported by the EAS for service continuity.
appLocs:
type: array
items:
type: string
minItems: 1
description: >-
List of DNAI(s) and the N6 traffic information associated with the
EAS.
avlRep:
type: integer
description: >-
The period indicating to the EES, how often the EES needs to check
the EAS's availability after a successful registration.
contentEncoding: int32
examples:
- 1577836800
status:
type: string
description: 'EAS status information. '
requestBodies:
AppTerminationNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotification'
required: true