Commit 3d5df733 authored by Walter Featherstone's avatar Walter Featherstone

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

parent 241380e2
This diff is collapsed.
This diff is collapsed.
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: string
format: uint32 format: uint32
example: 10 example: '10'
\ No newline at end of file \ No newline at end of file
description: Shall be set to AppTerminationNotification. description: Shall be set to AppTerminationNotification.
type: string type: string
example: AppTerminationNotification example: 'AppTerminationNotification'
\ No newline at end of file \ No newline at end of file
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'
\ No newline at end of file \ No newline at end of file
description: Shall be set to AppTerminationNotificationSubscription. description: Shall be set to AppTerminationNotificationSubscription.
type: string type: string
example: AppTerminationNotificationSubscription example: 'AppTerminationNotificationSubscription'
\ No newline at end of file \ No newline at end of file
description: Reference of the catalogue description: Reference of the catalogue
type: string type: string
example: catItem1 example: 'catItem1'
\ No newline at end of file \ No newline at end of file
description: Unique identifier of the category description: Unique identifier of the category
type: string type: string
example: id12345 example: 'id12345'
\ No newline at end of file \ No newline at end of file
description: Name of the category description: Name of the category
type: string type: string
example: RNI example: 'RNI'
\ No newline at end of file \ No newline at end of file
description: Category version description: Category version
type: string type: string
example: version1 example: 'version1'
\ No newline at end of file \ No newline at end of file
...@@ -25,4 +25,4 @@ properties: ...@@ -25,4 +25,4 @@ properties:
- TRACEABLE - TRACEABLE
- NONTRACEABLE - 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 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 example: 'TRACEABLE'
\ No newline at end of file \ No newline at end of file
...@@ -4,4 +4,4 @@ enum: ...@@ -4,4 +4,4 @@ enum:
- TUNNEL - TUNNEL
- MAC - MAC
- IP - IP
example: TUNNEL example: 'TUNNEL'
\ No newline at end of file \ No newline at end of file
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'
\ No newline at end of file \ No newline at end of file
description: Identifies the DNS Rule description: Identifies the DNS Rule
type: string type: string
example: dnsRule1 example: 'dnsRule1'
\ No newline at end of file \ No newline at end of file
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'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- IP_V6 - IP_V6
- IP_V4 - IP_V4
example: "IP_V6" example: 'IP_V6'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- ACTIVE - ACTIVE
- INACTIVE - INACTIVE
example: "ACTIVE" example: 'ACTIVE'
\ No newline at end of file \ No newline at end of file
description: Time to live value description: Time to live value
type: integer type: integer
format: uint32 format: uint32
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
description: Port portion of the address description: Port portion of the address
type: integer type: integer
format: uint32 format: uint32
example: '8080' example: 8080
\ No newline at end of file \ No newline at end of file
...@@ -5,4 +5,4 @@ enum: ...@@ -5,4 +5,4 @@ enum:
- 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'
\ No newline at end of file \ No newline at end of file
description: Shall be set to SerAvailabilityNotificationSubscription. description: Shall be set to SerAvailabilityNotificationSubscription.
type: string type: string
example: SerAvailabilityNotificationSubscription example: 'SerAvailabilityNotificationSubscription'
\ No newline at end of file \ No newline at end of file
...@@ -4,4 +4,4 @@ enum: ...@@ -4,4 +4,4 @@ enum:
- JSON - JSON
- XML - XML
- PROTOBUF3 - PROTOBUF3
example: JSON example: 'JSON'
\ No newline at end of file \ No newline at end of file
description: Shall be set to SerAvailabilityNotification. description: Shall be set to SerAvailabilityNotification.
type: string type: string
example: SerAvailabilityNotification example: 'SerAvailabilityNotification'
\ No newline at end of file \ No newline at end of file
description: Identifier of the service instance assigned by the MEPM / mobile edge platform. description: Identifier of the service instance assigned by the MEPM / mobile edge platform.
type: string type: string
example: ServiceInstance123 example: 'ServiceInstance123'
\ No newline at end of file \ No newline at end of file
description: The name of the service. This is how the service producing mobile edge application identifies the service instance it produces. description: The name of the service. This is how the service producing mobile edge application identifies the service instance it produces.
type: string type: string
example: ExampleService example: 'ExampleService'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- ACTIVE - ACTIVE
- INACTIVE - INACTIVE
example: ACTIVE example: 'ACTIVE'
\ No newline at end of file \ No newline at end of file
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. 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 type: string
example: Rest1 example: 'Rest1'
\ No newline at end of file \ No newline at end of file
description: Service version description: Service version
type: string type: string
example: ServiceVersion1 example: 'ServiceVersion1'
\ No newline at end of file \ No newline at end of file
...@@ -4,4 +4,4 @@ enum: ...@@ -4,4 +4,4 @@ enum:
- NONE - NONE
- SYMMETRIC_KEY - SYMMETRIC_KEY
- AUTO_KEY - AUTO_KEY
example: NONE example: 'NONE'
\ No newline at end of file \ No newline at end of file
description: NTP server address description: NTP server address
type: string type: string
example: 192.0.2.0 example: '192.0.2.0'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- IP_ADDRESS - IP_ADDRESS
- DNS_NAME - DNS_NAME
example: IP_ADDRESS example: 'IP_ADDRESS'
\ No newline at end of file \ No newline at end of file
description: PTP Master IP Address description: PTP Master IP Address
type: string type: string
example: 192.0.2.0 example: '192.0.2.0'
\ No newline at end of file \ No newline at end of file
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'
\ No newline at end of file \ No newline at end of file
description: A port description: A port
type: string type: string
example: "8080" example: '8080'
\ No newline at end of file \ No newline at end of file
description: Protocol of the traffic filter description: Protocol of the traffic filter
type: string type: string
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
description: Used for token based traffic rule description: Used for token based traffic rule
type: string type: string
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
description: Used for GTP tunnel based traffic rule description: Used for GTP tunnel based traffic rule
type: string type: string
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
description: Used for GTP tunnel based traffic rule description: Used for GTP tunnel based traffic rule
type: string type: string
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
...@@ -7,4 +7,4 @@ enum: ...@@ -7,4 +7,4 @@ enum:
- PASSTHROUGH - PASSTHROUGH
- DUPLICATE_DECAPSULATED - DUPLICATE_DECAPSULATED
- DUPLICATE_AS_IS - DUPLICATE_AS_IS
example: DROP example: 'DROP'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- FLOW - FLOW
- PACKET - PACKET
example: FLOW example: 'FLOW'
\ No newline at end of file \ No newline at end of file
description: Identify the traffic rule. description: Identify the traffic rule.
type: string type: string
example: TrafficRule1 example: 'TrafficRule1'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- ACTIVE - ACTIVE
- INACTIVE - INACTIVE
example: ACTIVE example: 'ACTIVE'
\ No newline at end of file \ No newline at end of file
...@@ -15,7 +15,9 @@ properties: ...@@ -15,7 +15,9 @@ properties:
priority: priority:
$ref: '#/definitions/TrafficRule.Priority' $ref: '#/definitions/TrafficRule.Priority'
trafficFilter: trafficFilter:
$ref: '#/definitions/TrafficFilter' type: array
items:
$ref: '#/definitions/TrafficFilter'
action: action:
$ref: '#/definitions/TrafficRule.Action' $ref: '#/definitions/TrafficRule.Action'
dstInterface: dstInterface:
......
description: Human-readable description of this transport description: Human-readable description of this transport
type: string type: string
example: REST API example: 'REST API'
\ No newline at end of file \ No newline at end of file
description: The identifier of this transport description: The identifier of this transport
type: string type: string
example: TransId12345 example: 'TransId12345'
\ No newline at end of file \ No newline at end of file
description: The name of this transport description: The name of this transport
type: string type: string
example: REST example: 'REST'
\ No newline at end of file \ No newline at end of file
description: The name of the protocol used. Shall be set to HTTP for a REST API. description: The name of the protocol used. Shall be set to HTTP for a REST API.
type: string type: string
example: HTTP example: 'HTTP'
\ No newline at end of file \ No newline at end of file
...@@ -8,4 +8,4 @@ enum: ...@@ -8,4 +8,4 @@ enum:
- RPC - RPC
- RPC_STREAMING - RPC_STREAMING
- WEBSOCKET - WEBSOCKET
example: JSON example: 'REST_HTTP'
\ No newline at end of file \ No newline at end of file
description: Destination address of the tunnel description: Destination address of the tunnel
type: string type: string
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
description: Source address of the tunnel description: Source address of the tunnel
type: string type: string
example: "?" example: '?'
\ No newline at end of file \ No newline at end of file
...@@ -3,4 +3,4 @@ type: string ...@@ -3,4 +3,4 @@ type: string
enum: enum:
- GTP_U - GTP_U
- GRE - GRE
example: GTP_U example: 'GTP_U'
\ No newline at end of file \ No newline at end of file
{ {
"DnsRule": { "DnsRule": {
"dnsRuleId": "DnsRule1", "dnsRuleId": "DnsRule1",
"domainName": "www.example.com", "domainName": "www.example.com",
"ipAddressType": "IP_V4", "ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3", "ipAddress": "146.241.7.3",
"ttl": 300, "ttl": 300,
"state": "ACTIVE" "state": "ACTIVE"
} }
} }
\ No newline at end of file \ No newline at end of file
DnsRule: DnsRule:
dnsRuleId: DnsRule1 dnsRuleId: 'DnsRule1'
domainName: www.example.com domainName: 'www.example.com'
ipAddressType: IP_V4 ipAddressType: 'IP_V4'
ipAddress: 146.241.7.3 ipAddress: '146.241.7.3'
ttl: 300 ttl: 300
state: ACTIVE state: 'ACTIVE'
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,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": {
...@@ -25,7 +25,7 @@ ...@@ -25,7 +25,7 @@
"addresses": [ "addresses": [
{ {
"host": "192.0.2.0", "host": "192.0.2.0",
"port": "8080" "port": 8080
} }
] ]
}, },
...@@ -38,4 +38,4 @@ ...@@ -38,4 +38,4 @@
}, },
"serializer": "JSON" "serializer": "JSON"
} }
} }
\ No newline at end of file
ServiceInfo: ServiceInfo:
serInstanceId: ServiceInstance123 serInstanceId: 'ServiceInstance123'
serName: ExampleService serName: 'ExampleService'
serCategory: serCategory:
href: catItem1 href: 'catItem1'
id: id12345 id: 'id12345'
name: RNI name: 'RNI'
version: version1 version: 'version1'
version: ServiceVersion1 version: 'ServiceVersion1'
state: ACTIVE state: 'ACTIVE'
transportId: Rest1 transportId: 'Rest1'
transportInfo: transportInfo:
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:
uris: uris:
- /meMp1/service/EntryPoint - '/meMp1/service/EntryPoint'
addresses: addresses:
- host: '192.0.2.0' - host: '192.0.2.0'
port: '8080' port: 8080
security: security:
oAuth2Info: oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: /meMp1/security/TokenEndPoint tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: JSON serializer: 'JSON'
{ {
"TrafficRule": { "TrafficRule": {
"trafficRuleId": "TrafficRule123", "trafficRuleId": "TrafficRule123",
"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", }
"dstInterface": { ],
"interfaceType": "IP", "action": "FORWARD_DECAPSULATED",
"dstIpAddress": "20.1.1.1" "dstInterface": {
}, "interfaceType": "IP",
"state": "ACTIVE" "dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
} }
} }
\ No newline at end of file \ No newline at end of file
TrafficRule: TrafficRule:
trafficRuleId: TrafficRule123 trafficRuleId: 'TrafficRule123'
serName: ExampleService serName: 'ExampleService'
filterType: FLOW filterType: 'FLOW'
priority: 1 priority: 1
trafficFilter: trafficFilter:
srcAddress: [192.168.2.0/24, 192.168.3.0/24] - srcAddress:
dstAddress: [192.127.4.100/32] - '192.168.2.0/24'
dstPort: [80] - '192.168.3.0/24'
action: FORWARD_DECAPSULATED dstAddress:
- '192.127.4.100/32'
dstPort:
- '80'
action: 'FORWARD_DECAPSULATED'
dstInterface: dstInterface:
interfaceType: IP interfaceType: 'IP'
dstIpAddress: 20.1.1.1 dstIpAddress: '20.1.1.1'
state: ACTIVE state: 'ACTIVE'
\ No newline at end of file
...@@ -14,12 +14,12 @@ responses: ...@@ -14,12 +14,12 @@ responses:
examples: examples:
application/json: application/json:
DnsRule: DnsRule:
dnsRuleId: DnsRule1 dnsRuleId: 'DnsRule1'
domainName: www.example.com domainName: 'www.example.com'
ipAddressType: IP_V4 ipAddressType: 'IP_V4'
ipAddress: 146.241.7.3 ipAddress: '146.241.7.3'
ttl: 300 ttl: 300
state: ACTIVE state: 'ACTIVE'
400: 400:
description: Bad Request description: Bad Request
schema: schema:
......
...@@ -16,12 +16,12 @@ responses: ...@@ -16,12 +16,12 @@ responses:
examples: examples:
application/json: application/json:
DnsRule: DnsRule:
dnsRuleId: DnsRule1 dnsRuleId: 'DnsRule1'
domainName: www.example.com domainName: 'www.example.com'
ipAddressType: IP_V4 ipAddressType: 'IP_V4'
ipAddress: 146.241.7.3 ipAddress: '146.241.7.3'
ttl: 300 ttl: 300
state: ACTIVE state: 'ACTIVE'
400: 400:
description: Bad Request description: Bad Request
schema: schema:
......
...@@ -16,12 +16,12 @@ responses: ...@@ -16,12 +16,12 @@ responses:
examples: examples:
application/json: application/json:
- DnsRule: - DnsRule:
dnsRuleId: DnsRule1 dnsRuleId: 'DnsRule1'
domainName: www.example.com domainName: 'www.example.com'
ipAddressType: IP_V4 ipAddressType: 'IP_V4'
ipAddress: 146.241.7.3 ipAddress: '146.241.7.3'
ttl: 300 ttl: 300
state: ACTIVE state: 'ACTIVE'
400: 400:
description: Bad Request description: Bad Request
schema: schema:
......
...@@ -14,19 +14,23 @@ responses: ...@@ -14,19 +14,23 @@ responses:
examples: examples:
application/json: application/json:
- TrafficRule: - TrafficRule:
trafficRuleId: TrafficRule123 trafficRuleId: 'TrafficRule123'
serName: ExampleService serName: 'ExampleService'
filterType: FLOW filterType: 'FLOW'
priority: 1 priority: 1
trafficFilter: trafficFilter:
srcAddress: [192.168.2.0/24, 192.168.3.0/24] - srcAddress:
dstAddress: [192.127.4.100/32] - '192.168.2.0/24'
dstPort: [80] - '192.168.3.0/24'
action: FORWARD_DECAPSULATED dstAddress:
dstInterface: - '192.127.4.100/32'
interfaceType: IP dstPort:
dstIpAddress: 20.1.1.1 - '80'
state: ACTIVE action: 'FORWARD_DECAPSULATED'
dstInterface:
interfaceType: 'IP'
dstIpAddress: '20.1.1.1'
state: 'ACTIVE'
400: 400:
description: Bad Request description: Bad Request
schema: schema:
......