Skip to content
GitLab
Commit 241380e2 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Bug 83 OpenAPI examples and documentation mismatch 



Signed-off-by: Walter Featherstone's avatarfeatherstone <walter.featherstone@viavisolutions.com>
parent 1f01c74f
Hide whitespace changes
Inline Side-by-side
Mp1.json
View file @ 241380e2
...@@ -175,7 +175,7 @@ ...@@ -175,7 +175,7 @@
} }
}, },
"examples": { "examples": {
"application/json": { "application/json": [{
"DnsRule": { "DnsRule": {
"dnsRuleId": "DnsRule1", "dnsRuleId": "DnsRule1",
"domainName": "www.example.com", "domainName": "www.example.com",
...@@ -184,7 +184,7 @@ ...@@ -184,7 +184,7 @@
"ttl": 300, "ttl": 300,
"state": "ACTIVE" "state": "ACTIVE"
} }
} }]
} }
}, },
"400": { "400": {
...@@ -652,7 +652,7 @@ ...@@ -652,7 +652,7 @@
} }
}, },
"examples": { "examples": {
"application/json": { "application/json": [{
"TrafficRule": { "TrafficRule": {
"trafficRuleId": "TrafficRule123", "trafficRuleId": "TrafficRule123",
"serName": "ExampleService", "serName": "ExampleService",
...@@ -677,7 +677,7 @@ ...@@ -677,7 +677,7 @@
}, },
"state": "ACTIVE" "state": "ACTIVE"
} }
} }]
} }
}, },
"400": { "400": {
...@@ -946,7 +946,7 @@ ...@@ -946,7 +946,7 @@
} }
}, },
"examples": { "examples": {
"application/json": { "application/json": [{
"ServiceInfo": { "ServiceInfo": {
"serInstanceId": "ServiceInstance123", "serInstanceId": "ServiceInstance123",
"serName": "ExampleService", "serName": "ExampleService",
...@@ -986,7 +986,7 @@ ...@@ -986,7 +986,7 @@
}, },
"serializer": "JSON" "serializer": "JSON"
} }
} }]
} }
}, },
"400": { "400": {
......
Mp1.yaml
View file @ 241380e2
...@@ -139,13 +139,13 @@ paths: ...@@ -139,13 +139,13 @@ paths:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
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:
...@@ -439,24 +439,24 @@ paths: ...@@ -439,24 +439,24 @@ paths:
$ref: '#/definitions/TrafficRule' $ref: '#/definitions/TrafficRule'
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: srcAddress:
- 192.168.2.0/24 - 192.168.2.0/24
- 192.168.3.0/24 - 192.168.3.0/24
dstAddress: dstAddress:
- 192.127.4.100/32 - 192.127.4.100/32
dstPort: dstPort:
- 80 - 80
action: FORWARD_DECAPSULATED action: FORWARD_DECAPSULATED
dstInterface: dstInterface:
interfaceType: IP interfaceType: IP
dstIpAddress: 20.1.1.1 dstIpAddress: 20.1.1.1
state: ACTIVE state: ACTIVE
'400': '400':
description: Bad Request description: Bad Request
schema: schema:
...@@ -627,35 +627,35 @@ paths: ...@@ -627,35 +627,35 @@ paths:
$ref: '#/definitions/ServiceInfo' $ref: '#/definitions/ServiceInfo'
examples: examples:
application/json: application/json:
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: JSON
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
'400': '400':
description: Bad Request description: Bad Request
schema: schema:
......
paths/ApplicationsDnsRules.GET.yaml
View file @ 241380e2
...@@ -15,13 +15,13 @@ responses: ...@@ -15,13 +15,13 @@ responses:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
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:
......
paths/ApplicationsTrafficRule.GET.yaml
View file @ 241380e2
...@@ -13,20 +13,20 @@ responses: ...@@ -13,20 +13,20 @@ responses:
$ref: '#/definitions/TrafficRule' $ref: '#/definitions/TrafficRule'
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: [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
dstIpAddress: 20.1.1.1 dstIpAddress: 20.1.1.1
state: ACTIVE state: ACTIVE
400: 400:
description: Bad Request description: Bad Request
schema: schema:
......
paths/Services.GET.yaml
View file @ 241380e2
...@@ -19,35 +19,35 @@ responses: ...@@ -19,35 +19,35 @@ responses:
$ref: '#/definitions/ServiceInfo' $ref: '#/definitions/ServiceInfo'
examples: examples:
application/json: application/json:
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: JSON
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
400: 400:
description: Bad Request description: Bad Request
schema: schema:
......
Supports Markdown
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