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

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

parent 241380e2
...@@ -175,16 +175,18 @@ ...@@ -175,16 +175,18 @@
} }
}, },
"examples": { "examples": {
"application/json": [{ "application/json": [
"DnsRule": { {
"dnsRuleId": "DnsRule1", "DnsRule": {
"domainName": "www.example.com", "dnsRuleId": "DnsRule1",
"ipAddressType": "IP_V4", "domainName": "www.example.com",
"ipAddress": "146.241.7.3", "ipAddressType": "IP_V4",
"ttl": 300, "ipAddress": "146.241.7.3",
"state": "ACTIVE" "ttl": 300,
"state": "ACTIVE"
}
} }
}] ]
} }
}, },
"400": { "400": {
...@@ -652,32 +654,36 @@ ...@@ -652,32 +654,36 @@
} }
}, },
"examples": { "examples": {
"application/json": [{ "application/json": [
"TrafficRule": { {
"trafficRuleId": "TrafficRule123", "TrafficRule": {
"serName": "ExampleService", "trafficRuleId": "TrafficRule123",
"filterType": "FLOW", "serName": "ExampleService",
"priority": 1, "filterType": "FLOW",
"trafficFilter": { "priority": 1,
"srcAddress": [ "trafficFilter": [
"192.168.2.0/24", {
"192.168.3.0/24" "srcAddress": [
], "192.168.2.0/24",
"dstAddress": [ "192.168.3.0/24"
"192.127.4.100/32" ],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
], ],
"dstPort": [ "action": "FORWARD_DECAPSULATED",
80 "dstInterface": {
] "interfaceType": "IP",
}, "dstIpAddress": "20.1.1.1"
"action": "FORWARD_DECAPSULATED", },
"dstInterface": { "state": "ACTIVE"
"interfaceType": "IP", }
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
} }
}] ]
} }
}, },
"400": { "400": {
...@@ -752,18 +758,20 @@ ...@@ -752,18 +758,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",
...@@ -841,18 +849,20 @@ ...@@ -841,18 +849,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",
...@@ -946,47 +956,49 @@ ...@@ -946,47 +956,49 @@
} }
}, },
"examples": { "examples": {
"application/json": [{ "application/json": [
"ServiceInfo": { {
"serInstanceId": "ServiceInstance123", "ServiceInfo": {
"serName": "ExampleService", "serInstanceId": "ServiceInstance123",
"serCategory": { "serName": "ExampleService",
"href": "catItem1", "serCategory": {
"id": "id12345", "href": "catItem1",
"name": "RNI", "id": "id12345",
"version": "version1" "name": "RNI",
}, "version": "version1"
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportId": "Rest1",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "JSON",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"uris": [
"/meMp1/service/EntryPoint"
],
"addresses": [
{
"host": "192.0.2.0",
"port": "8080"
}
]
}, },
"security": { "version": "ServiceVersion1",
"oAuth2Info": { "state": "ACTIVE",
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS", "transportId": "Rest1",
"tokenEndpoint": "/meMp1/security/TokenEndPoint" "transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "JSON",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"uris": [
"/meMp1/service/EntryPoint"
],
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
"tokenEndpoint": "/meMp1/security/TokenEndPoint"
}
} }
} },
}, "serializer": "JSON"
"serializer": "JSON" }
} }
}] ]
} }
}, },
"400": { "400": {
...@@ -1074,7 +1086,7 @@ ...@@ -1074,7 +1086,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": {
...@@ -1084,7 +1096,7 @@ ...@@ -1084,7 +1096,7 @@
"addresses": [ "addresses": [
{ {
"host": "192.0.2.0", "host": "192.0.2.0",
"port": "8080" "port": 8080
} }
] ]
}, },
...@@ -1180,7 +1192,7 @@ ...@@ -1180,7 +1192,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": {
...@@ -1190,7 +1202,7 @@ ...@@ -1190,7 +1202,7 @@
"addresses": [ "addresses": [
{ {
"host": "192.0.2.0", "host": "192.0.2.0",
"port": "8080" "port": 8080
} }
] ]
}, },
...@@ -1284,7 +1296,7 @@ ...@@ -1284,7 +1296,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": {
...@@ -1294,7 +1306,7 @@ ...@@ -1294,7 +1306,7 @@
"addresses": [ "addresses": [
{ {
"host": "192.0.2.0", "host": "192.0.2.0",
"port": "8080" "port": 8080
} }
] ]
}, },
...@@ -1541,7 +1553,7 @@ ...@@ -1541,7 +1553,7 @@
"definitions": { "definitions": {
"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
}, },
...@@ -1808,7 +1820,7 @@ ...@@ -1808,7 +1820,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",
...@@ -2502,7 +2514,10 @@ ...@@ -2502,7 +2514,10 @@
"$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"
...@@ -2598,7 +2613,7 @@ ...@@ -2598,7 +2613,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",
......
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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment