Skip to content

M
MEC Application Support API and MEC Service Management API
Commit 3d5df733 authored by Walter Featherstone's avatar Walter Featherstone
Browse files
Options

Single apostrophe for string. Traffic Filter within TrafficRule changed to array

parent 241380e2
Expand all Show whitespace changes
Inline Side-by-side
Showing with 564 additions and 528 deletions
Mp1.json
View file @ 3d5df733
......@@ -175,7 +175,8 @@
}
},
"examples": {
"application/json": [{
"application/json": [
{
"DnsRule": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
......@@ -184,7 +185,8 @@
"ttl": 300,
"state": "ACTIVE"
}
}]
}
]
}
},
"400": {
......@@ -652,13 +654,15 @@
}
},
"examples": {
"application/json": [{
"application/json": [
{
"TrafficRule": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": {
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
......@@ -667,9 +671,10 @@
"192.127.4.100/32"
],
"dstPort": [
80
"80"
]
},
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
......@@ -677,7 +682,8 @@
},
"state": "ACTIVE"
}
}]
}
]
}
},
"400": {
......@@ -752,7 +758,8 @@
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": {
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
......@@ -761,9 +768,10 @@
"192.127.4.100/32"
],
"dstPort": [
80
"80"
]
},
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
......@@ -841,7 +849,8 @@
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": {
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
......@@ -850,9 +859,10 @@
"192.127.4.100/32"
],
"dstPort": [
80
"80"
]
},
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
......@@ -946,7 +956,8 @@
}
},
"examples": {
"application/json": [{
"application/json": [
{
"ServiceInfo": {
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
......@@ -973,7 +984,7 @@
"addresses": [
{
"host": "192.0.2.0",
"port": "8080"
"port": 8080
}
]
},
......@@ -986,7 +997,8 @@
},
"serializer": "JSON"
}
}]
}
]
}
},
"400": {
......@@ -1074,7 +1086,7 @@
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "JSON",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
......@@ -1084,7 +1096,7 @@
"addresses": [
{
"host": "192.0.2.0",
"port": "8080"
"port": 8080
}
]
},
......@@ -1180,7 +1192,7 @@
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "JSON",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
......@@ -1190,7 +1202,7 @@
"addresses": [
{
"host": "192.0.2.0",
"port": "8080"
"port": 8080
}
]
},
......@@ -1284,7 +1296,7 @@
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "JSON",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
......@@ -1294,7 +1306,7 @@
"addresses": [
{
"host": "192.0.2.0",
"port": "8080"
"port": 8080
}
]
},
......@@ -1541,7 +1553,7 @@
"definitions": {
"AppTerminationNotification.MaxGracefulTimeout": {
"description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
"type": "string",
"type": "integer",
"format": "uint32",
"example": 10
},
......@@ -1808,7 +1820,7 @@
"description": "Port portion of the address",
"type": "integer",
"format": "uint32",
"example": "8080"
"example": 8080
},
"EndPointInfo.Address": {
"description": "A IP address and port pair",
......@@ -2502,7 +2514,10 @@
"$ref": "#/definitions/TrafficRule.Priority"
},
"trafficFilter": {
"type": "array",
"items": {
"$ref": "#/definitions/TrafficFilter"
}
},
"action": {
"$ref": "#/definitions/TrafficRule.Action"
......@@ -2598,7 +2613,7 @@
"RPC_STREAMING",
"WEBSOCKET"
],
"example": "JSON"
"example": "REST_HTTP"
},
"TunnelInfo.TunnelDstAddress": {
"description": "Destination address of the tunnel",
......
Mp1.yaml
View file @ 3d5df733
This diff is collapsed.
definitions/AppTerminationNotification.MaxGracefulTimeout.yaml
View file @ 3d5df733
description: Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
type: string
format: uint32
example: 10
\ No newline at end of file
example: '10'
\ No newline at end of file
definitions/AppTerminationNotification.NotificationType.yaml
View file @ 3d5df733
description: Shall be set to AppTerminationNotification.
type: string
example: AppTerminationNotification
\ No newline at end of file
example: 'AppTerminationNotification'
\ No newline at end of file
definitions/AppTerminationNotificationSubscription.AppInstanceId.yaml
View file @ 3d5df733
description: It is used as the filtering criterion for the subscribed events.
type: string
example: ID1
\ No newline at end of file
example: 'ID1'
\ No newline at end of file
definitions/AppTerminationNotificationSubscription.SubscriptionType.yaml
View file @ 3d5df733
description: Shall be set to AppTerminationNotificationSubscription.
type: string
example: AppTerminationNotificationSubscription
\ No newline at end of file
example: 'AppTerminationNotificationSubscription'
\ No newline at end of file
definitions/CategoryRef.Href.yaml
View file @ 3d5df733
description: Reference of the catalogue
type: string
example: catItem1
\ No newline at end of file
example: 'catItem1'
\ No newline at end of file
definitions/CategoryRef.Id.yaml
View file @ 3d5df733
description: Unique identifier of the category
type: string
example: id12345
\ No newline at end of file
example: 'id12345'
\ No newline at end of file
definitions/CategoryRef.Name.yaml
View file @ 3d5df733
description: Name of the category
type: string
example: RNI
\ No newline at end of file
example: 'RNI'
\ No newline at end of file
definitions/CategoryRef.Version.yaml
View file @ 3d5df733
description: Category version
type: string
example: version1
\ No newline at end of file
example: 'version1'
\ No newline at end of file
definitions/CurrentTime.yaml
View file @ 3d5df733
......@@ -25,4 +25,4 @@ properties:
- 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
example: TRACEABLE
\ No newline at end of file
example: 'TRACEABLE'
\ No newline at end of file
definitions/DestinationInterface.InterfaceType.yaml
View file @ 3d5df733
......@@ -4,4 +4,4 @@ enum:
- TUNNEL
- MAC
- IP
example: TUNNEL
\ No newline at end of file
example: 'TUNNEL'
\ No newline at end of file
definitions/DnsRule.DomainName.yaml
View file @ 3d5df733
description: FQDN resolved by the DNS rule
type: string
example: www.example.com
\ No newline at end of file
example: 'www.example.com'
\ No newline at end of file
definitions/DnsRule.Id.yaml
View file @ 3d5df733
description: Identifies the DNS Rule
type: string
example: dnsRule1
\ No newline at end of file
example: 'dnsRule1'
\ No newline at end of file
definitions/DnsRule.IpAddress.yaml
View file @ 3d5df733
description: IP address associated with the FQDN resolved by the DNS rule
type: string
example: "192.0.2.0"
\ No newline at end of file
example: '192.0.2.0'
\ No newline at end of file
definitions/DnsRule.IpAddressType.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- IP_V6
- IP_V4
example: "IP_V6"
\ No newline at end of file
example: 'IP_V6'
\ No newline at end of file
definitions/DnsRule.State.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- ACTIVE
- INACTIVE
example: "ACTIVE"
\ No newline at end of file
example: 'ACTIVE'
\ No newline at end of file
definitions/DnsRule.Ttl.yaml
View file @ 3d5df733
description: Time to live value
type: integer
format: uint32
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/EndPointInfo.Address.Port.yaml
View file @ 3d5df733
description: Port portion of the address
type: integer
format: uint32
example: '8080'
\ No newline at end of file
example: 8080
\ No newline at end of file
definitions/SecurityInfo.OAuth2Info.GrantTypes.yaml
View file @ 3d5df733
......@@ -5,4 +5,4 @@ enum:
- OAUTH2_IMPLICIT_GRANT
- OAUTH2_RESOURCE_OWNER
- OAUTH2_CLIENT_CREDENTIALS
example: OAUTH2_CLIENT_CREDENTIALS
\ No newline at end of file
example: 'OAUTH2_CLIENT_CREDENTIALS'
\ No newline at end of file
definitions/SerAvailabilityNotificationSubscription.SubscriptionType.yaml
View file @ 3d5df733
description: Shall be set to SerAvailabilityNotificationSubscription.
type: string
example: SerAvailabilityNotificationSubscription
\ No newline at end of file
example: 'SerAvailabilityNotificationSubscription'
\ No newline at end of file
definitions/SerializerTypes.yaml
View file @ 3d5df733
......@@ -4,4 +4,4 @@ enum:
- JSON
- XML
- PROTOBUF3
example: JSON
\ No newline at end of file
example: 'JSON'
\ No newline at end of file
definitions/ServiceAvailabilityNotification.NotificationType.yaml
View file @ 3d5df733
description: Shall be set to SerAvailabilityNotification.
type: string
example: SerAvailabilityNotification
\ No newline at end of file
example: 'SerAvailabilityNotification'
\ No newline at end of file
definitions/ServiceInfo.SerInstanceId.yaml
View file @ 3d5df733
description: Identifier of the service instance assigned by the MEPM / mobile edge platform.
type: string
example: ServiceInstance123
\ No newline at end of file
example: 'ServiceInstance123'
\ No newline at end of file
definitions/ServiceInfo.SerName.yaml
View file @ 3d5df733
description: The name of the service. This is how the service producing mobile edge application identifies the service instance it produces.
type: string
example: ExampleService
\ No newline at end of file
example: 'ExampleService'
\ No newline at end of file
definitions/ServiceInfo.State.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- ACTIVE
- INACTIVE
example: ACTIVE
\ No newline at end of file
example: 'ACTIVE'
\ No newline at end of file
definitions/ServiceInfo.TransportId.yaml
View file @ 3d5df733
description: Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the "Transport information query" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.
type: string
example: Rest1
\ No newline at end of file
example: 'Rest1'
\ No newline at end of file
definitions/ServiceInfo.Version.yaml
View file @ 3d5df733
description: Service version
type: string
example: ServiceVersion1
\ No newline at end of file
example: 'ServiceVersion1'
\ No newline at end of file
definitions/TimingCaps.NtpServers.AuthenticationOption.yaml
View file @ 3d5df733
......@@ -4,4 +4,4 @@ enum:
- NONE
- SYMMETRIC_KEY
- AUTO_KEY
example: NONE
\ No newline at end of file
example: 'NONE'
\ No newline at end of file
definitions/TimingCaps.NtpServers.NtpServerAddr.yaml
View file @ 3d5df733
description: NTP server address
type: string
example: 192.0.2.0
\ No newline at end of file
example: '192.0.2.0'
\ No newline at end of file
definitions/TimingCaps.NtpServers.NtpServerAddrType.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- IP_ADDRESS
- DNS_NAME
example: IP_ADDRESS
\ No newline at end of file
example: 'IP_ADDRESS'
\ No newline at end of file
definitions/TimingCaps.NtpServers.PtpMasterIpAddress.yaml
View file @ 3d5df733
description: PTP Master IP Address
type: string
example: 192.0.2.0
\ No newline at end of file
example: '192.0.2.0'
\ No newline at end of file
definitions/TrafficFilter.Address.yaml
View file @ 3d5df733
description: Identify the traffic ip address.
type: string
example: 192.168.1.1
\ No newline at end of file
example: '192.168.1.1'
\ No newline at end of file
definitions/TrafficFilter.Port.yaml
View file @ 3d5df733
description: A port
type: string
example: "8080"
\ No newline at end of file
example: '8080'
\ No newline at end of file
definitions/TrafficFilter.Protocol.yaml
View file @ 3d5df733
description: Protocol of the traffic filter
type: string
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/TrafficFilter.Token.yaml
View file @ 3d5df733
description: Used for token based traffic rule
type: string
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/TrafficFilter.TunnelAddress.yaml
View file @ 3d5df733
description: Used for GTP tunnel based traffic rule
type: string
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/TrafficFilter.TunnelPort.yaml
View file @ 3d5df733
description: Used for GTP tunnel based traffic rule
type: string
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/TrafficRule.Action.yaml
View file @ 3d5df733
......@@ -7,4 +7,4 @@ enum:
- PASSTHROUGH
- DUPLICATE_DECAPSULATED
- DUPLICATE_AS_IS
example: DROP
\ No newline at end of file
example: 'DROP'
\ No newline at end of file
definitions/TrafficRule.FilterType.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- FLOW
- PACKET
example: FLOW
\ No newline at end of file
example: 'FLOW'
\ No newline at end of file
definitions/TrafficRule.Id.yaml
View file @ 3d5df733
description: Identify the traffic rule.
type: string
example: TrafficRule1
\ No newline at end of file
example: 'TrafficRule1'
\ No newline at end of file
definitions/TrafficRule.State.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- ACTIVE
- INACTIVE
example: ACTIVE
\ No newline at end of file
example: 'ACTIVE'
\ No newline at end of file
definitions/TrafficRule.yaml
View file @ 3d5df733
......@@ -15,6 +15,8 @@ properties:
priority:
$ref: '#/definitions/TrafficRule.Priority'
trafficFilter:
type: array
items:
$ref: '#/definitions/TrafficFilter'
action:
$ref: '#/definitions/TrafficRule.Action'
......
definitions/TransportInfo.Description.yaml
View file @ 3d5df733
description: Human-readable description of this transport
type: string
example: REST API
\ No newline at end of file
example: 'REST API'
\ No newline at end of file
definitions/TransportInfo.Id.yaml
View file @ 3d5df733
description: The identifier of this transport
type: string
example: TransId12345
\ No newline at end of file
example: 'TransId12345'
\ No newline at end of file
definitions/TransportInfo.Name.yaml
View file @ 3d5df733
description: The name of this transport
type: string
example: REST
\ No newline at end of file
example: 'REST'
\ No newline at end of file
definitions/TransportInfo.Protocol.yaml
View file @ 3d5df733
description: The name of the protocol used. Shall be set to HTTP for a REST API.
type: string
example: HTTP
\ No newline at end of file
example: 'HTTP'
\ No newline at end of file
definitions/TransportTypes.yaml
View file @ 3d5df733
......@@ -8,4 +8,4 @@ enum:
- RPC
- RPC_STREAMING
- WEBSOCKET
example: JSON
\ No newline at end of file
example: 'REST_HTTP'
\ No newline at end of file
definitions/TunnelInfo.TunnelDstAddress.yaml
View file @ 3d5df733
description: Destination address of the tunnel
type: string
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/TunnelInfo.TunnelSrcAddress.yaml
View file @ 3d5df733
description: Source address of the tunnel
type: string
example: "?"
\ No newline at end of file
example: '?'
\ No newline at end of file
definitions/TunnelInfo.TunnelType.yaml
View file @ 3d5df733
......@@ -3,4 +3,4 @@ type: string
enum:
- GTP_U
- GRE
example: GTP_U
\ No newline at end of file
example: 'GTP_U'
\ No newline at end of file
examples/DnsRule.json
View file @ 3d5df733
......@@ -7,4 +7,4 @@
"ttl": 300,
"state": "ACTIVE"
}
}
\ No newline at end of file
}
\ No newline at end of file
examples/DnsRule.yaml
View file @ 3d5df733
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
state: ACTIVE
state: 'ACTIVE'
examples/ServiceInfo.json
View file @ 3d5df733
......@@ -15,7 +15,7 @@
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "JSON",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
......@@ -25,7 +25,7 @@
"addresses": [
{
"host": "192.0.2.0",
"port": "8080"
"port": 8080
}
]
},
......
examples/ServiceInfo.yaml
View file @ 3d5df733
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serInstanceId: 'ServiceInstance123'
serName: 'ExampleService'
serCategory:
href: catItem1
id: id12345
name: RNI
version: version1
version: ServiceVersion1
state: ACTIVE
transportId: Rest1
href: 'catItem1'
id: 'id12345'
name: 'RNI'
version: 'version1'
version: 'ServiceVersion1'
state: 'ACTIVE'
transportId: 'Rest1'
transportInfo:
id: TransId12345
name: REST
description: REST API
type: JSON
id: 'TransId12345'
name: 'REST'
description: 'REST API'
type: 'REST_HTTP'
protocol: HTTP
version: '2.0'
endpoint:
uris:
- /meMp1/service/EntryPoint
- '/meMp1/service/EntryPoint'
addresses:
- host: '192.0.2.0'
port: '8080'
port: 8080
security:
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security/TokenEndPoint
serializer: JSON
grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: 'JSON'
examples/TrafficRule.json
View file @ 3d5df733
......@@ -4,7 +4,8 @@
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": {
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
......@@ -13,9 +14,10 @@
"192.127.4.100/32"
],
"dstPort": [
80
"80"
]
},
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
......@@ -23,4 +25,4 @@
},
"state": "ACTIVE"
}
}
\ No newline at end of file
}
\ No newline at end of file
examples/TrafficRule.yaml
View file @ 3d5df733
TrafficRule:
trafficRuleId: TrafficRule123
serName: ExampleService
filterType: FLOW
trafficRuleId: 'TrafficRule123'
serName: 'ExampleService'
filterType: 'FLOW'
priority: 1
trafficFilter:
srcAddress: [192.168.2.0/24, 192.168.3.0/24]
dstAddress: [192.127.4.100/32]
dstPort: [80]
action: FORWARD_DECAPSULATED
- srcAddress:
- '192.168.2.0/24'
- '192.168.3.0/24'
dstAddress:
- '192.127.4.100/32'
dstPort:
- '80'
action: 'FORWARD_DECAPSULATED'
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
interfaceType: 'IP'
dstIpAddress: '20.1.1.1'
state: 'ACTIVE'
\ No newline at end of file
paths/ApplicationsDnsRule.GET.yaml
View file @ 3d5df733
......@@ -14,12 +14,12 @@ responses:
examples:
application/json:
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
state: ACTIVE
state: 'ACTIVE'
400:
description: Bad Request
schema:
......
paths/ApplicationsDnsRule.PUT.yaml
View file @ 3d5df733
......@@ -16,12 +16,12 @@ responses:
examples:
application/json:
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
ttl: 300
state: ACTIVE
state: 'ACTIVE'
400:
description: Bad Request
schema:
......
paths/ApplicationsDnsRules.GET.yaml
View file @ 3d5df733
......@@ -16,12 +16,12 @@ responses:
examples:
application/json:
- DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
dnsRuleId: 'DnsRule1'