Newer
Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
"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": {
"AppReadyConfirmation": {
"title": "AppReadyConfirmation",
"required": [
"indication"
],
"type": "object",
"properties": {
"indication": {
"const": "READY",
"type": "string",
"description": "Indication about the MEC application instance.",
"examples": [
"READY"
]
}
},
"description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running."
},
"AppInfo": {
"title": "AppInfo",
"required": [
"appName"
],
"type": "object",
"properties": {
"appName": {
"title": "appName",
"type": "string",
"description": "Name of the application. It shall be consistent with the appName in the AppD, if an AppD is available.",
"examples": [
"appName"
]
},
"appProvider": {
"title": "appProvider",
"type": "string",
"description": "Provider of the application. It shall be consistent with the appProvider in the AppD, if an AppD is available. See note 1.",
"examples": [
"appProvider1"
]
},
"appCategory": {
"$ref": "#/components/schemas/CategoryRef"
},
"appDId": {
"title": "appDId",
"type": "string",
"description": "The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. Shall be present if the application instance is instantiated by the MEC Management.",
"examples": [
"appDId"
]
},
"appInstanceId": {
"title": "appInstanceId",
"type": "string",
"description": "Identifier of the application instance. Shall be present if the application instance is instantiated by the MEC Management.",
"examples": [
"ID1"
]
},
"endpoint": {
"oneOf": [
{
"$ref": "#/components/schemas/EndPointInfo.Uris"
},
{
"$ref": "#/components/schemas/EndPointInfo.Fqdn"
},
{
"$ref": "#/components/schemas/EndPointInfo.Addresses"
},
{
"$ref": "#/components/schemas/EndPointInfo.Alternative"
}
],
"description": "This type represents information about a transport endpoint",
"x-etsi-notes": "NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type."
},
"appServiceRequired": {
"title": "appServiceRequired",
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceDependency"
},
"description": "Describes services a MEC application requires to run. ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available."
},
"appServiceOptional": {
"title": "appServiceOptional",
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceDependency"
},
"description": "Describes services a MEC application may use if available. ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available."
},
"appFeatureRequired": {
"title": "appFeatureRequired",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureDependency"
},
"description": "Describes features a MEC application requires to run. FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available."
},
"appFeatureOptional": {
"title": "appFeatureOptional",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureDependency"
},
"description": "Describes features a MEC application may use if available. FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available."
},
"isInsByMec": {
"type": "boolean",
"description": "Indicate whether the application instance is instantiated by the MEC Management.\nDefault to FALSE if absent.",
"examples": [
false
]
},
"appProfile": {
"$ref": "#/components/schemas/AppProfile"
}
},
"description": "This type represents the information provided by the MEC application instance as part of the \"application registration request\" and \"application registration update\" messages.",
"x-etsi-notes": "NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type."
},
"AppTerminationConfirmation": {
"title": "AppTerminationConfirmation",
"required": [
"operationAction"
],
"type": "object",
"properties": {
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
}
},
"description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop."
},
"AppTerminationNotification.Links": {
"title": "AppTerminationNotification.Links",
"required": [
"subscription"
],
"type": "object",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"confirmTermination": {
"$ref": "#/components/schemas/LinkType.ConfirmTermination"
},
"description": "Object containing hyperlinks related to the resource."
Walter Featherstone
committed
},
"AppTerminationNotification": {
Walter Featherstone
committed
"required": [
"notificationType",
Walter Featherstone
committed
"maxGracefulTimeout",
"_links"
],
Walter Featherstone
committed
"properties": {
"notificationType": {
"type": "string",
"description": "Shall be set to AppTerminationNotification.",
"examples": [
"AppTerminationNotification"
]
Walter Featherstone
committed
},
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
},
Walter Featherstone
committed
"maxGracefulTimeout": {
"type": "integer",
"description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
"contentEncoding": "int32",
"examples": [
10
]
Walter Featherstone
committed
},
"_links": {
"$ref": "#/components/schemas/AppTerminationNotification.Links"
Walter Featherstone
committed
}
},
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop."
Walter Featherstone
committed
},
"AppTerminationNotificationSubscription": {
"title": "AppTerminationNotificationSubscription",
Walter Featherstone
committed
"required": [
"subscriptionType",
"callbackReference",
"_links",
"appInstanceId"
],
Walter Featherstone
committed
"properties": {
"subscriptionType": {
"type": "string",
"description": "Shall be set to AppTerminationNotificationSubscription.",
"examples": [
"AppTerminationNotificationSubscription"
]
Walter Featherstone
committed
},
"callbackReference": {
"type": "string",
"description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response."
Walter Featherstone
committed
},
"_links": {
"$ref": "#/components/schemas/Self"
},
"appInstanceId": {
"type": "string",
"description": "It is used as the filtering criterion for the subscribed events.",
"examples": [
"ID1"
]
Walter Featherstone
committed
}
},
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop."
Walter Featherstone
committed
},
"CurrentTime": {
Walter Featherstone
committed
"required": [
"seconds",
Walter Featherstone
committed
"timeSourceStatus"
],
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": [
1577836800
]
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": [
0
]
Walter Featherstone
committed
},
"timeSourceStatus": {
"$ref": "#/components/schemas/TimeSourceStatus"
Walter Featherstone
committed
}
},
"description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message."
Walter Featherstone
committed
},
"DestinationInterface.InterfaceType": {
"title": "DestinationInterface.InterfaceType",
Walter Featherstone
committed
"enum": [
"TUNNEL",
"MAC",
"IP"
],
"type": "string",
"description": "Type of the interface",
"examples": [
"TUNNEL"
]
Walter Featherstone
committed
},
"DestinationInterface": {
Walter Featherstone
committed
"required": [
"interfaceType"
],
Walter Featherstone
committed
"properties": {
"interfaceType": {
"$ref": "#/components/schemas/DestinationInterface.InterfaceType"
},
"tunnelInfo": {
"$ref": "#/components/schemas/TunnelInfo"
},
"srcMacAddress": {
"type": "string",
"description": "Source address identifies the MAC address of the interface",
"examples": [
"02-00-00-00-00-00"
]
Walter Featherstone
committed
},
"dstMacAddress": {
"type": "string",
"description": "Source address identifies the MAC address of the interface",
"examples": [
"02-00-00-00-00-00"
]
Walter Featherstone
committed
},
"dstIpAddress": {
"type": "string",
"description": "IP address of the remote destination",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
}
},
"description": "This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided."
Walter Featherstone
committed
},
"DnsRule.IpAddressType": {
Walter Featherstone
committed
"enum": [
"IP_V6",
"IP_V4"
],
"type": "string",
"description": "IP address type",
"examples": [
"IP_V6"
]
Walter Featherstone
committed
},
"DnsRule.State": {
Walter Featherstone
committed
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"description": "DNS rule state. This attribute may be updated using HTTP PUT method",
"examples": [
"ACTIVE"
]
Walter Featherstone
committed
},
"DnsRule": {
Walter Featherstone
committed
"required": [
"dnsRuleId",
"domainName",
"ipAddressType",
"ipAddress",
"state"
],
Walter Featherstone
committed
"properties": {
"dnsRuleId": {
"type": "string",
"description": "Identifies the DNS Rule",
"examples": [
"dnsRule1"
]
Walter Featherstone
committed
},
"domainName": {
"type": "string",
"description": "FQDN resolved by the DNS rule",
"examples": [
"www.example.com"
]
Walter Featherstone
committed
},
"ipAddressType": {
"$ref": "#/components/schemas/DnsRule.IpAddressType"
},
"ipAddress": {
"type": "string",
"description": "IP address associated with the FQDN resolved by the DNS rule",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
},
"ttl": {
"type": "integer",
"description": "Time to live value",
"contentEncoding": "int32"
Walter Featherstone
committed
},
"state": {
"$ref": "#/components/schemas/DnsRule.State"
}
"description": "This type represents the general information of a DNS rule.",
"x-etsi-notes": "NOTE:\tIf no ttl value is provided, the DnsRule shall not expire."
Walter Featherstone
committed
},
"type": "object",
"properties": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
},
"description": "This type represents a type of link and may be referenced from data structures"
Walter Featherstone
committed
},
Walter Featherstone
committed
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
Walter Featherstone
committed
}
},
"description": "Link to the task resource where to confirm termination in case the application is ready to be terminated before expiry of the timeout."
Walter Featherstone
committed
},
"title": "MecAppSuptApiSubscriptionLinkList.Links",
Walter Featherstone
committed
"required": [
"self"
],
Walter Featherstone
committed
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
Walter Featherstone
committed
"type": "array",
"items": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription"
},
"description": "The MEC application instance's subscriptions"
Walter Featherstone
committed
}
},
"description": "Self-referring URI."
Walter Featherstone
committed
},
"MecAppSuptApiSubscriptionLinkList.Subscription": {
"title": "MecAppSuptApiSubscriptionLinkList.Subscription",
Walter Featherstone
committed
"required": [
"href",
Walter Featherstone
committed
],
Walter Featherstone
committed
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
Walter Featherstone
committed
},
"description": "Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different Mp1 event subscription data type."
Walter Featherstone
committed
}
},
"description": "A link to a subscription."
Walter Featherstone
committed
},
"title": "MecAppSuptApiSubscriptionLinkList",
Walter Featherstone
committed
"required": [
"_links"
],
Walter Featherstone
committed
"properties": {
"_links": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links"
Walter Featherstone
committed
}
},
"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."
Walter Featherstone
committed
},
"enum": [
"STOPPING",
"TERMINATING"
],
"type": "string",
"description": "Operation that is being performed on the MEC application instance.",
"examples": [
"TERMINATING"
]
Walter Featherstone
committed
"ProblemDetails": {
Walter Featherstone
committed
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
Walter Featherstone
committed
},
"title": {
"type": "string",
"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": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
Walter Featherstone
committed
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
Walter Featherstone
committed
}
}
},
Walter Featherstone
committed
"required": [
Walter Featherstone
committed
],
Walter Featherstone
committed
"properties": {
Walter Featherstone
committed
"$ref": "#/components/schemas/LinkType"
}
Walter Featherstone
committed
},
"TimingCaps.NtpServers.AuthenticationOption": {
"title": "TimingCaps.NtpServers.AuthenticationOption",
Walter Featherstone
committed
"enum": [
"NONE",
"SYMMETRIC_KEY",
"AUTO_KEY"
],
"type": "string",
"description": "NTP authentication option",
"examples": [
"NONE"
]
},
Walter Featherstone
committed
"TimingCaps.NtpServers.NtpServerAddrType": {
"title": "TimingCaps.NtpServers.NtpServerAddrType",
Walter Featherstone
committed
"enum": [
"IP_ADDRESS",
"DNS_NAME"
],
"type": "string",
"description": "Address type of NTP server",
"examples": [
"IP_ADDRESS"
]
Walter Featherstone
committed
},
"TimingCaps.NtpServers": {
Walter Featherstone
committed
"required": [
"ntpServerAddrType",
"ntpServerAddr",
"minPollingInterval",
"maxPollingInterval",
"localPriority",
Walter Featherstone
committed
],
Walter Featherstone
committed
"properties": {
"ntpServerAddrType": {
"$ref": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType"
},
"ntpServerAddr": {
"type": "string",
"description": "NTP server address",
"examples": [
"192.0.2.0"
]
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": [
3
]
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": [
17
]
Walter Featherstone
committed
},
"localPriority": {
"type": "integer",
"description": "NTP server local priority",
"contentEncoding": "int32",
"examples": [
1
]
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": [
1
]
Walter Featherstone
committed
}
},
"description": "NTP server detail."
Walter Featherstone
committed
},
"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": [
1
]
Walter Featherstone
committed
},
"delayReqMaxRate": {
"type": "integer",
"description": "Acceptable maximum rate of the Delay_Req messages in packets per second",
"contentEncoding": "int32",
"examples": [
10
]
Walter Featherstone
committed
}
},
"description": "NTP server detail."
Walter Featherstone
committed
},
"TimingCaps.TimeStamp": {
Walter Featherstone
committed
"required": [
Walter Featherstone
committed
],
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": [
1577836800
]
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": [
0
]
Walter Featherstone
committed
}
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"
},
"description": "Available NTP servers"
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)"
Walter Featherstone
committed
}
},
"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": {
"type": "string"
},
"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": {
"type": "string"
},
"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": {
"type": "string"
},
"description": "A port or a range of ports"
Walter Featherstone
committed
},
"dstPort": {
"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
},
Walter Featherstone
committed
"type": "array",
"items": {
"type": "string"
},
"description": "Used for token based traffic rule"
Walter Featherstone
committed
},
"srcTunnelAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"tgtTunnelAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"srcTunnelPort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"dstTunnelPort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used for GTP tunnel based traffic rule"
Walter Featherstone
committed
},
"qCI": {
"type": "integer",
"description": "Used to match all packets that have the same Quality Class Indicator (QCI).",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
},
"dSCP": {
"type": "integer",
"description": "Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)",
"contentEncoding": "int32",
"examples": [
0
]
Walter Featherstone
committed
},
"tC": {
"type": "integer",
"description": "Used to match all IPv6 packets that have the same Traffic Class.",
"contentEncoding": "int32",
"examples": [
1
]
Walter Featherstone
committed
}
},
"description": "This type represents the traffic filter."
Walter Featherstone
committed
},
"TrafficRule.Action": {
Walter Featherstone
committed
"enum": [
"DROP",
"FORWARD_DECAPSULATED",
Walter Featherstone
committed
"PASSTHROUGH",
"DUPLICATE_DECAPSULATED",
Walter Featherstone
committed
],
"type": "string",
"description": "The action of the MEC host data plane when a packet matches the trafficFilter",
"examples": [
"DROP"
]
Walter Featherstone
committed
},
"TrafficRule.FilterType": {
Walter Featherstone
committed
"enum": [
"FLOW",
"PACKET"
],
"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",
"examples": [
"FLOW"
]
Walter Featherstone
committed
},
"TrafficRule.State": {
Walter Featherstone
committed
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"description": "Contains the traffic rule state. This attribute may be updated using HTTP PUT method",
"examples": [
"ACTIVE"
]
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": [
"TrafficRule1"
]
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": [
1
]
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": [
"GTP_U",
"GRE"
],
"type": "string",
"description": "This type represents the tunnel information.",
"examples": [
"GTP_U"
]
Walter Featherstone
committed
},
"TunnelInfo": {
Walter Featherstone
committed
"required": [
"tunnelType"
],
Walter Featherstone
committed
"properties": {
"tunnelType": {
"$ref": "#/components/schemas/TunnelInfo.TunnelType"
},
"tunnelDstAddress": {
"type": "string",
"description": "Destination address of the tunnel",
"examples": [
"?"
]
Walter Featherstone
committed
},
"tunnelSrcAddress": {
"type": "string",
"description": "Source address of the tunnel",
"examples": [
"?"
]
Walter Featherstone
committed
}
"description": "This type represents the tunnel information."
Walter Featherstone
committed
},
"TimeSourceStatus": {
"title": "TimeSourceStatus",
"enum": [
"TRACEABLE",
"NONTRACEABLE"
],
"type": "string",
"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",
"examples": [
"TRACEABLE"
]
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
},
"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"
},