Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
MEC - Multi-access Edge Computing
MEC Application Support API and MEC Service Management API
Commits
9d2c84ca
Commit
9d2c84ca
authored
Jan 28, 2019
by
Walter Featherstone
Browse files
Single apostrophe for string. Traffic Filter within TrafficRule changed to array
parent
17bdb30b
Changes
2
Hide whitespace changes
Inline
Side-by-side
Mp1.json
View file @
9d2c84ca
...
@@ -2,10 +2,10 @@
...
@@ -2,10 +2,10 @@
"openapi"
:
"3.0.0"
,
"openapi"
:
"3.0.0"
,
"servers"
:
[
"servers"
:
[
{
{
"url"
:
"http://127.0.0.1:8081/
exampleAPI/
mp1/v1/"
"url"
:
"http://127.0.0.1:8081/mp1/v1/"
},
},
{
{
"url"
:
"https://127.0.0.1:8081/
exampleAPI/
mp1/v1/"
"url"
:
"https://127.0.0.1:8081/mp1/v1/"
}
}
],
],
"info"
:
{
"info"
:
{
...
@@ -445,7 +445,7 @@
...
@@ -445,7 +445,7 @@
},
},
"AppTerminationNotification.MaxGracefulTimeout"
:
{
"AppTerminationNotification.MaxGracefulTimeout"
:
{
"description"
:
"Maximum timeout value in seconds for graceful termination or graceful stop of an application instance."
,
"description"
:
"Maximum timeout value in seconds for graceful termination or graceful stop of an application instance."
,
"type"
:
"
string
"
,
"type"
:
"
integer
"
,
"format"
:
"uint32"
,
"format"
:
"uint32"
,
"example"
:
10
"example"
:
10
},
},
...
@@ -712,7 +712,7 @@
...
@@ -712,7 +712,7 @@
"description"
:
"Port portion of the address"
,
"description"
:
"Port portion of the address"
,
"type"
:
"integer"
,
"type"
:
"integer"
,
"format"
:
"uint32"
,
"format"
:
"uint32"
,
"example"
:
"
8080
"
"example"
:
8080
},
},
"EndPointInfo.Address"
:
{
"EndPointInfo.Address"
:
{
"description"
:
"A IP address and port pair"
,
"description"
:
"A IP address and port pair"
,
...
@@ -1441,7 +1441,10 @@
...
@@ -1441,7 +1441,10 @@
"$ref"
:
"#/components/schemas/TrafficRule_Priority"
"$ref"
:
"#/components/schemas/TrafficRule_Priority"
},
},
"trafficFilter"
:
{
"trafficFilter"
:
{
"$ref"
:
"#/components/schemas/TrafficFilter"
"type"
:
"array"
,
"items"
:
{
"$ref"
:
"#/components/schemas/TrafficFilter"
}
},
},
"action"
:
{
"action"
:
{
"$ref"
:
"#/components/schemas/TrafficRule.Action"
"$ref"
:
"#/components/schemas/TrafficRule.Action"
...
@@ -1537,7 +1540,7 @@
...
@@ -1537,7 +1540,7 @@
"RPC_STREAMING"
,
"RPC_STREAMING"
,
"WEBSOCKET"
"WEBSOCKET"
],
],
"example"
:
"
JSON
"
"example"
:
"
REST_HTTP
"
},
},
"TunnelInfo.TunnelDstAddress"
:
{
"TunnelInfo.TunnelDstAddress"
:
{
"description"
:
"Destination address of the tunnel"
,
"description"
:
"Destination address of the tunnel"
,
...
@@ -2214,7 +2217,7 @@
...
@@ -2214,7 +2217,7 @@
"id"
:
"TransId12345"
,
"id"
:
"TransId12345"
,
"name"
:
"REST"
,
"name"
:
"REST"
,
"description"
:
"REST API"
,
"description"
:
"REST API"
,
"type"
:
"
JSON
"
,
"type"
:
"
REST_HTTP
"
,
"protocol"
:
"HTTP"
,
"protocol"
:
"HTTP"
,
"version"
:
"2.0"
,
"version"
:
"2.0"
,
"endpoint"
:
{
"endpoint"
:
{
...
@@ -2224,7 +2227,7 @@
...
@@ -2224,7 +2227,7 @@
"addresses"
:
[
"addresses"
:
[
{
{
"host"
:
"192.0.2.0"
,
"host"
:
"192.0.2.0"
,
"port"
:
"
8080
"
"port"
:
8080
}
}
]
]
},
},
...
@@ -2256,7 +2259,7 @@
...
@@ -2256,7 +2259,7 @@
"id"
:
"TransId12345"
,
"id"
:
"TransId12345"
,
"name"
:
"REST"
,
"name"
:
"REST"
,
"description"
:
"REST API"
,
"description"
:
"REST API"
,
"type"
:
"
JSON
"
,
"type"
:
"
REST_HTTP
"
,
"protocol"
:
"HTTP"
,
"protocol"
:
"HTTP"
,
"version"
:
"2.0"
,
"version"
:
"2.0"
,
"endpoint"
:
{
"endpoint"
:
{
...
@@ -2266,7 +2269,7 @@
...
@@ -2266,7 +2269,7 @@
"addresses"
:
[
"addresses"
:
[
{
{
"host"
:
"192.0.2.0"
,
"host"
:
"192.0.2.0"
,
"port"
:
"
8080
"
"port"
:
8080
}
}
]
]
},
},
...
@@ -2287,18 +2290,20 @@
...
@@ -2287,18 +2290,20 @@
"serName"
:
"ExampleService"
,
"serName"
:
"ExampleService"
,
"filterType"
:
"FLOW"
,
"filterType"
:
"FLOW"
,
"priority"
:
1
,
"priority"
:
1
,
"trafficFilter"
:
{
"trafficFilter"
:
[
"srcAddress"
:
[
{
"192.168.2.0/24"
,
"srcAddress"
:
[
"192.168.3.0/24"
"192.168.2.0/24"
,
],
"192.168.3.0/24"
"dstAddress"
:
[
],
"192.127.4.100/32"
"dstAddress"
:
[
],
"192.127.4.100/32"
"dstPort"
:
[
],
80
"dstPort"
:
[
]
"80"
},
]
}
],
"action"
:
"FORWARD_DECAPSULATED"
,
"action"
:
"FORWARD_DECAPSULATED"
,
"dstInterface"
:
{
"dstInterface"
:
{
"interfaceType"
:
"IP"
,
"interfaceType"
:
"IP"
,
...
@@ -2314,18 +2319,20 @@
...
@@ -2314,18 +2319,20 @@
"serName"
:
"ExampleService"
,
"serName"
:
"ExampleService"
,
"filterType"
:
"FLOW"
,
"filterType"
:
"FLOW"
,
"priority"
:
1
,
"priority"
:
1
,
"trafficFilter"
:
{
"trafficFilter"
:
[
"srcAddress"
:
[
{
"192.168.2.0/24"
,
"srcAddress"
:
[
"192.168.3.0/24"
"192.168.2.0/24"
,
],
"192.168.3.0/24"
"dstAddress"
:
[
],
"192.127.4.100/32"
"dstAddress"
:
[
],
"192.127.4.100/32"
"dstPort"
:
[
],
80
"dstPort"
:
[
]
"80"
},
]
}
],
"action"
:
"FORWARD_DECAPSULATED"
,
"action"
:
"FORWARD_DECAPSULATED"
,
"dstInterface"
:
{
"dstInterface"
:
{
"interfaceType"
:
"IP"
,
"interfaceType"
:
"IP"
,
...
...
Mp1.yaml
View file @
9d2c84ca
openapi
:
3.0.0
openapi
:
3.0.0
servers
:
servers
:
-
url
:
'
http://127.0.0.1:8081/
exampleAPI/
mp1/v1/'
-
url
:
'
http://127.0.0.1:8081/mp1/v1/'
-
url
:
'
https://127.0.0.1:8081/
exampleAPI/
mp1/v1/'
-
url
:
'
https://127.0.0.1:8081/mp1/v1/'
info
:
info
:
title
:
Mp1 API
title
:
Mp1 API
version
:
1.1.1
version
:
1.1.1
...
@@ -316,13 +316,13 @@ components:
...
@@ -316,13 +316,13 @@ components:
description
:
>-
description
:
>-
Maximum timeout value in seconds for graceful termination or graceful
Maximum timeout value in seconds for graceful termination or graceful
stop of an application instance.
stop of an application instance.
type
:
string
type
:
integer
format
:
uint32
format
:
uint32
example
:
10
example
:
10
AppTerminationNotification.NotificationType
:
AppTerminationNotification.NotificationType
:
description
:
Shall be set to AppTerminationNotification.
description
:
Shall be set to AppTerminationNotification.
type
:
string
type
:
string
example
:
AppTerminationNotification
example
:
'
AppTerminationNotification
'
AppTerminationNotification
:
AppTerminationNotification
:
description
:
>-
description
:
>-
This type represents the information that the mobile edge platform
This type represents the information that the mobile edge platform
...
@@ -343,7 +343,7 @@ components:
...
@@ -343,7 +343,7 @@ components:
AppTerminationNotificationSubscription.AppInstanceId
:
AppTerminationNotificationSubscription.AppInstanceId
:
description
:
It is used as the filtering criterion for the subscribed events.
description
:
It is used as the filtering criterion for the subscribed events.
type
:
string
type
:
string
example
:
ID1
example
:
'
ID1
'
AppTerminationNotificationSubscription.CallbackReference
:
AppTerminationNotificationSubscription.CallbackReference
:
description
:
>-
description
:
>-
URI selected by the mobile edge application instance to receive
URI selected by the mobile edge application instance to receive
...
@@ -378,23 +378,23 @@ components:
...
@@ -378,23 +378,23 @@ components:
AppTerminationNotificationSubscription.SubscriptionType
:
AppTerminationNotificationSubscription.SubscriptionType
:
description
:
Shall be set to AppTerminationNotificationSubscription.
description
:
Shall be set to AppTerminationNotificationSubscription.
type
:
string
type
:
string
example
:
AppTerminationNotificationSubscription
example
:
'
AppTerminationNotificationSubscription
'
CategoryRef.Href
:
CategoryRef.Href
:
description
:
Reference of the catalogue
description
:
Reference of the catalogue
type
:
string
type
:
string
example
:
catItem1
example
:
'
catItem1
'
CategoryRef.Id
:
CategoryRef.Id
:
description
:
Unique identifier of the category
description
:
Unique identifier of the category
type
:
string
type
:
string
example
:
id12345
example
:
'
id12345
'
CategoryRef.Name
:
CategoryRef.Name
:
description
:
Name of the category
description
:
Name of the category
type
:
string
type
:
string
example
:
RNI
example
:
'
RNI
'
CategoryRef.Version
:
CategoryRef.Version
:
description
:
Category version
description
:
Category version
type
:
string
type
:
string
example
:
version1
example
:
'
version1
'
CategoryRef
:
CategoryRef
:
description
:
This type represents the category reference
description
:
This type represents the category reference
type
:
object
type
:
object
...
@@ -445,7 +445,7 @@ components:
...
@@ -445,7 +445,7 @@ components:
Platform Time Source status. 1 = TRACEABLE - time source is locked
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. 2 = NONTRACEABLE - time source is not locked
to the UTC time source
to the UTC time source
example
:
TRACEABLE
example
:
'
TRACEABLE
'
DestinationInterface.InterfaceType
:
DestinationInterface.InterfaceType
:
description
:
Type of the interface
description
:
Type of the interface
type
:
string
type
:
string
...
@@ -453,15 +453,15 @@ components:
...
@@ -453,15 +453,15 @@ components:
-
TUNNEL
-
TUNNEL
-
MAC
-
MAC
-
IP
-
IP
example
:
TUNNEL
example
:
'
TUNNEL
'
DestinationInterface.IpAddress
:
DestinationInterface.IpAddress
:
description
:
IP address of the remote destination
description
:
IP address of the remote destination
type
:
string
type
:
string
example
:
192.0.2.0
example
:
'
192.0.2.0
'
DestinationInterface.MacAddress
:
DestinationInterface.MacAddress
:
description
:
Source address identifies the MAC address of the interface
description
:
Source address identifies the MAC address of the interface
type
:
string
type
:
string
example
:
02-00-00-00-00-00
example
:
'
02-00-00-00-00-00
'
DestinationInterface
:
DestinationInterface
:
description
:
This type represents the destination interface.
description
:
This type represents the destination interface.
type
:
object
type
:
object
...
@@ -481,29 +481,29 @@ components:
...
@@ -481,29 +481,29 @@ components:
DnsRule.DomainName
:
DnsRule.DomainName
:
description
:
FQDN resolved by the DNS rule
description
:
FQDN resolved by the DNS rule
type
:
string
type
:
string
example
:
www.example.com
example
:
'
www.example.com
'
DnsRule.Id
:
DnsRule.Id
:
description
:
Identifies the DNS Rule
description
:
Identifies the DNS Rule
type
:
string
type
:
string
example
:
dnsRule1
example
:
'
dnsRule1
'
DnsRule.IpAddress
:
DnsRule.IpAddress
:
description
:
IP address associated with the FQDN resolved by the DNS rule
description
:
IP address associated with the FQDN resolved by the DNS rule
type
:
string
type
:
string
example
:
192.0.2.0
example
:
'
192.0.2.0
'
DnsRule.IpAddressType
:
DnsRule.IpAddressType
:
description
:
IP address type
description
:
IP address type
type
:
string
type
:
string
enum
:
enum
:
-
IP_V6
-
IP_V6
-
IP_V4
-
IP_V4
example
:
IP_V6
example
:
'
IP_V6
'
DnsRule.State
:
DnsRule.State
:
description
:
DNS rule state
description
:
DNS rule state
type
:
string
type
:
string
enum
:
enum
:
-
ACTIVE
-
ACTIVE
-
INACTIVE
-
INACTIVE
example
:
ACTIVE
example
:
'
ACTIVE
'
DnsRule.Ttl
:
DnsRule.Ttl
:
description
:
Time to live value
description
:
Time to live value
type
:
integer
type
:
integer
...
@@ -534,12 +534,12 @@ components:
...
@@ -534,12 +534,12 @@ components:
EndPointInfo.Address.Host
:
EndPointInfo.Address.Host
:
description
:
Host portion of the address
description
:
Host portion of the address
type
:
string
type
:
string
example
:
192.0.2.0
example
:
'
192.0.2.0
'
EndPointInfo.Address_Port
:
EndPointInfo.Address_Port
:
description
:
Port portion of the address
description
:
Port portion of the address
type
:
integer
type
:
integer
format
:
uint32
format
:
uint32
example
:
'
8080
'
example
:
8080
EndPointInfo.Address
:
EndPointInfo.Address
:
description
:
A IP address and port pair
description
:
A IP address and port pair
type
:
object
type
:
object
...
@@ -564,7 +564,7 @@ components:
...
@@ -564,7 +564,7 @@ components:
description
:
Entry point information of the service
description
:
Entry point information of the service
type
:
string
type
:
string
format
:
uri
format
:
uri
example
:
/meMp1/service/EntryPoint
example
:
'
/meMp1/service/EntryPoint
'
EndPointInfo.Uris
:
EndPointInfo.Uris
:
description
:
>-
description
:
>-
Entry point information of the service as string, formatted according to
Entry point information of the service as string, formatted according to
...
@@ -592,7 +592,7 @@ components:
...
@@ -592,7 +592,7 @@ components:
description
:
URI referring to a resource
description
:
URI referring to a resource
type
:
string
type
:
string
format
:
uri
format
:
uri
example
:
/meMp1/example
example
:
'
/meMp1/example
'
Mp1SubscriptionLinkList.Links
:
Mp1SubscriptionLinkList.Links
:
description
:
Self-referring URI.
description
:
Self-referring URI.
type
:
object
type
:
object
...
@@ -675,12 +675,12 @@ components:
...
@@ -675,12 +675,12 @@ components:
-
OAUTH2_IMPLICIT_GRANT
-
OAUTH2_IMPLICIT_GRANT
-
OAUTH2_RESOURCE_OWNER
-
OAUTH2_RESOURCE_OWNER
-
OAUTH2_CLIENT_CREDENTIALS
-
OAUTH2_CLIENT_CREDENTIALS
example
:
OAUTH2_CLIENT_CREDENTIALS
example
:
'
OAUTH2_CLIENT_CREDENTIALS
'
SecurityInfo.OAuth2Info.TokenEndpoint
:
SecurityInfo.OAuth2Info.TokenEndpoint
:
description
:
The token endpoint
description
:
The token endpoint
type
:
string
type
:
string
format
:
uri
format
:
uri
example
:
/meMp1/security/TokenEndPoint
example
:
'
/meMp1/security/TokenEndPoint
'
SecurityInfo.OAuth2Info
:
SecurityInfo.OAuth2Info
:
description
:
Parameters related to use of OAuth
2.0
description
:
Parameters related to use of OAuth
2.0
required
:
required
:
...
@@ -742,7 +742,7 @@ components:
...
@@ -742,7 +742,7 @@ components:
SerAvailabilityNotificationSubscription.SubscriptionType
:
SerAvailabilityNotificationSubscription.SubscriptionType
:
description
:
Shall be set to SerAvailabilityNotificationSubscription.
description
:
Shall be set to SerAvailabilityNotificationSubscription.
type
:
string
type
:
string
example
:
SerAvailabilityNotificationSubscription
example
:
'
SerAvailabilityNotificationSubscription
'
ServiceAvailabilityNotification
:
ServiceAvailabilityNotification
:
description
:
>-
description
:
>-
This type represents the service availability information.
This type represents the service availability information.
...
@@ -775,20 +775,20 @@ components:
...
@@ -775,20 +775,20 @@ components:
platform.
platform.
type
:
string
type
:
string
readOnly
:
true
readOnly
:
true
example
:
ServiceInstance123
example
:
'
ServiceInstance123
'
ServiceInfo.SerName
:
ServiceInfo.SerName
:
description
:
>-
description
:
>-
The name of the service. This is how the service producing mobile edge
The name of the service. This is how the service producing mobile edge
application identifies the service instance it produces.
application identifies the service instance it produces.
type
:
string
type
:
string
example
:
ExampleService
example
:
'
ExampleService
'
ServiceInfo.State
:
ServiceInfo.State
:
description
:
Contains the state
description
:
Contains the state
type
:
string
type
:
string
enum
:
enum
:
-
ACTIVE
-
ACTIVE
-
INACTIVE
-
INACTIVE
example
:
ACTIVE
example
:
'
ACTIVE
'
ServiceInfo.TransportId
:
ServiceInfo.TransportId
:
description
:
>-
description
:
>-
Identifier of the platform-provided transport to be used by the service.
Identifier of the platform-provided transport to be used by the service.
...
@@ -797,11 +797,11 @@ components:
...
@@ -797,11 +797,11 @@ components:
platform-provided transport for the service, and shall be absent
platform-provided transport for the service, and shall be absent
otherwise.
otherwise.
type
:
string
type
:
string
example
:
Rest1
example
:
'
Rest1
'
ServiceInfo.Version
:
ServiceInfo.Version
:
description
:
Service version
description
:
Service version
type
:
string
type
:
string
example
:
ServiceVersion1
example
:
'
ServiceVersion1
'
ServiceInfo
:
ServiceInfo
:
description
:
This type represents the general information of a mobile edge service.
description
:
This type represents the general information of a mobile edge service.
type
:
object
type
:
object
...
@@ -847,7 +847,7 @@ components:
...
@@ -847,7 +847,7 @@ components:
-
NONE
-
NONE
-
SYMMETRIC_KEY
-
SYMMETRIC_KEY
-
AUTO_KEY
-
AUTO_KEY
example
:
NONE
example
:
'
NONE
'
TimingCaps.NtpServers.DelayReqMaxRate
:
TimingCaps.NtpServers.DelayReqMaxRate
:
description
:
Acceptable maximum rate of the Delay_Req messages in packets per second
description
:
Acceptable maximum rate of the Delay_Req messages in packets per second
type
:
integer
type
:
integer
...
@@ -875,18 +875,18 @@ components:
...
@@ -875,18 +875,18 @@ components:
TimingCaps.NtpServers.NtpServerAddr
:
TimingCaps.NtpServers.NtpServerAddr
:
description
:
NTP server address
description
:
NTP server address
type
:
string
type
:
string
example
:
192.0.2.0
example
:
'
192.0.2.0
'
TimingCaps.NtpServers.NtpServerAddrType
:
TimingCaps.NtpServers.NtpServerAddrType
:
description
:
Address type of NTP server
description
:
Address type of NTP server
type
:
string
type
:
string
enum
:
enum
:
-
IP_ADDRESS
-
IP_ADDRESS
-
DNS_NAME
-
DNS_NAME
example
:
IP_ADDRESS
example
:
'
IP_ADDRESS
'
TimingCaps.NtpServers_PtpMasterIpAddress
:
TimingCaps.NtpServers_PtpMasterIpAddress
:
description
:
PTP Master IP Address
description
:
PTP Master IP Address
type
:
string
type
:
string
example
:
192.0.2.0
example
:
'
192.0.2.0
'
TimingCaps.NtpServers_PtpMasterLocalPriority
:
TimingCaps.NtpServers_PtpMasterLocalPriority
:
description
:
PTP Master local priority
description
:
PTP Master local priority
type
:
integer
type
:
integer
...
@@ -974,7 +974,7 @@ components:
...
@@ -974,7 +974,7 @@ components:
TrafficFilter.Address
:
TrafficFilter.Address
:
description
:
Identify the traffic ip address.
description
:
Identify the traffic ip address.
type
:
string
type
:
string
example
:
192.168.1.1
example
:
'
192.168.1.1
'
TrafficFilter.DSCP
:
TrafficFilter.DSCP
:
description
:
>-
description
:
>-
Used to match all IPv4 packets that have the same Differentiated
Used to match all IPv4 packets that have the same Differentiated
...
@@ -1094,7 +1094,7 @@ components:
...
@@ -1094,7 +1094,7 @@ components:
-
PASSTHROUGH
-
PASSTHROUGH
-
DUPLICATE_DECAPSULATED
-
DUPLICATE_DECAPSULATED
-
DUPLICATE_AS_IS
-
DUPLICATE_AS_IS
example
:
DROP
example
:
'
DROP
'
TrafficRule.FilterType
:
TrafficRule.FilterType
:
description
:
>-
description
:
>-
Definition of filter per FLOW or PACKET. If flow the filter match
Definition of filter per FLOW or PACKET. If flow the filter match
...
@@ -1107,7 +1107,7 @@ components:
...
@@ -1107,7 +1107,7 @@ components:
TrafficRule.Id
:
TrafficRule.Id
:
description
:
Identify the traffic rule.
description
:
Identify the traffic rule.
type
:
string
type
:
string
example
:
TrafficRule1
example
:
'
TrafficRule1
'
TrafficRule_Priority
:
TrafficRule_Priority
:
description
:
>-
description
:
>-
Priority of this traffic rule. If traffic rule conflicts, the one with
Priority of this traffic rule. If traffic rule conflicts, the one with
...
@@ -1121,7 +1121,7 @@ components:
...
@@ -1121,7 +1121,7 @@ components:
enum
:
enum
:
-
ACTIVE
-
ACTIVE
-
INACTIVE
-
INACTIVE
example
:
ACTIVE
example
:
'
ACTIVE
'
TrafficRule
:
TrafficRule
:
description
:
This type represents the general information of a traffic rule.
description
:
This type represents the general information of a traffic rule.
type
:
object
type
:
object
...
@@ -1140,7 +1140,9 @@ components:
...
@@ -1140,7 +1140,9 @@ components:
priority
:
priority
:
$ref
:
'
#/components/schemas/TrafficRule_Priority'
$ref
:
'
#/components/schemas/TrafficRule_Priority'
trafficFilter
:
trafficFilter
:
$ref
:
'
#/components/schemas/TrafficFilter'
type
:
array
items
:
$ref
:
'
#/components/schemas/TrafficFilter'
action
:
action
:
$ref
:
'
#/components/schemas/TrafficRule.Action'
$ref
:
'
#/components/schemas/TrafficRule.Action'
dstInterface
:
dstInterface
:
...
@@ -1150,22 +1152,22 @@ components:
...
@@ -1150,22 +1152,22 @@ components:
TransportInfo.Description
:
TransportInfo.Description
:
description
:
Human-readable description of this transport
description
:
Human-readable description of this transport
type
:
string
type
:
string