Commit 536efb7c authored by Walter Featherstone's avatar Walter Featherstone

Fixes to response codes and explicit inclusion of examples

Change-Id: Ib659e383574036e6b7cbf7cc2476f2d9f9a6eaf1
parent d743aa66
This diff is collapsed.
type: string
description: >-
A human-readable explanation specific to this occurrence of the problem
type: string
format: uri
description: >-
A URI reference that identifies the specific occurrence of the problem
type: integer
format: uint32
description: >-
The HTTP status code for this occurrence of the problem
type: string
description: >-
A short, human-readable summary of the problem type
type: string
format: uri
description: >-
A URI reference according to IETF RFC 3986 that identifies the problem type
type: object
properties:
type:
$ref: '#/definitions/Problem.type'
title:
$ref: '#/definitions/Problem.title'
status:
$ref: '#/definitions/Problem.status'
detail:
$ref: '#/definitions/Problem.detail'
instance:
$ref: '#/definitions/Problem.instance'
......@@ -7,7 +7,7 @@ required:
- protocol
- version
- endpoint
- security
- security.mp1
properties:
id:
$ref: '#/definitions/TransportInfo.Id'
......@@ -23,7 +23,7 @@ properties:
$ref: '#/definitions/TransportInfo.Version'
endpoint:
$ref: '#/definitions/EndPointInfo'
security:
security.mp1:
$ref: '#/definitions/SecurityInfo'
implSpecificInfo:
$ref: '#/definitions/TransportInfo.ImplSpecificInfo'
\ No newline at end of file
......@@ -72,6 +72,18 @@ Mp1SubscriptionLinkList.Subscription:
$ref: ./Mp1SubscriptionLinkList.Subscription.yaml
Mp1SubscriptionLinkList:
$ref: ./Mp1SubscriptionLinkList.yaml
ProblemDetails:
$ref: ./ProblemDetails.yaml
Problem.detail:
$ref: ./Problem.detail.yaml
Problem.instance:
$ref: ./Problem.instance.yaml
Problem.status:
$ref: ./Problem.status.yaml
Problem.title:
$ref: ./Problem.title.yaml
Problem.type:
$ref: ./Problem.type.yaml
SecurityInfo.OAuth2Info.GrantTypes:
$ref: ./SecurityInfo.OAuth2Info.GrantTypes.yaml
SecurityInfo.OAuth2Info.TokenEndpoint:
......
......@@ -29,10 +29,10 @@
}
]
},
"security": {
"security.mp1": {
"oAuth2Info": {
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
"tokenEndpoint": "/meMp1/mp1.security/TokenEndPoint"
"tokenEndpoint": "/meMp1/security.mp1/TokenEndPoint"
}
}
},
......
......@@ -22,8 +22,8 @@ ServiceInfo:
addresses:
- host: '192.0.2.0'
port: '8080'
security:
security.mp1:
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/mp1.security/TokenEndPoint
tokenEndpoint: /meMp1/security.mp1/TokenEndPoint
serializer: JSON
......@@ -13,4 +13,33 @@ responses:
$ref: '#/definitions/DnsRule'
examples:
application/json:
$ref: '../examples/DnsRule.json'
\ No newline at end of file
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -12,8 +12,43 @@ responses:
type: object
properties:
DnsRule:
$ref: '#/definitions/DnsRule'
$ref: '#/definitions/DnsRule'
examples:
application/json:
$ref: '../examples/DnsRule.json'
\ No newline at end of file
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
412:
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -12,4 +12,36 @@ responses:
type: object
properties:
DnsRule:
$ref: '#/definitions/DnsRule'
\ No newline at end of file
$ref: '#/definitions/DnsRule'
examples:
application/json:
DnsRule:
dnsRuleId: DnsRule1
domainName: www.example.com
ipAddressType: IP_V4
ipAddress: 146.241.7.3
ttl: 300
state: ACTIVE
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -5,4 +5,20 @@ produces:
responses:
204:
description: No Content
\ No newline at end of file
description: No Content
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -13,4 +13,27 @@ responses:
$ref: '#/definitions/SerAvailabilityNotificationSubscription.Response'
# The alternative response
# AppTerminationNotificationSubscription:
# $ref: '#/definitions/AppTerminationNotificationSubscription.Response'
\ No newline at end of file
# $ref: '#/definitions/AppTerminationNotificationSubscription.Response'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -10,4 +10,27 @@ responses:
type: object
properties:
Mp1SubscriptionLinkList:
$ref: '#/definitions/Mp1SubscriptionLinkList'
\ No newline at end of file
$ref: '#/definitions/Mp1SubscriptionLinkList'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -8,7 +8,7 @@ parameters:
#- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription'
responses:
200:
201:
description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
schema:
type: object
......@@ -17,4 +17,27 @@ responses:
$ref: '#/definitions/AppTerminationNotificationSubscription.Response'
# The alternative response
# SerAvailabilityNotificationSubscription:
# $ref: '#/definitions/SerAvailabilityNotificationSubscription'
\ No newline at end of file
# $ref: '#/definitions/SerAvailabilityNotificationSubscription'
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -13,4 +13,40 @@ responses:
$ref: '#/definitions/TrafficRule'
examples:
application/json:
$ref: '../examples/TrafficRule.json'
\ No newline at end of file
TrafficRule:
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
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -15,4 +15,47 @@ responses:
$ref: '#/definitions/TrafficRule'
examples:
application/json:
$ref: '../examples/TrafficRule.json'
\ No newline at end of file
TrafficRule:
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
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
412:
description: Precondition Failed
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -12,4 +12,43 @@ responses:
type: object
properties:
TrafficRule:
$ref: '#/definitions/TrafficRule'
\ No newline at end of file
$ref: '#/definitions/TrafficRule'
examples:
application/json:
TrafficRule:
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
dstInterface:
interfaceType: IP
dstIpAddress: 20.1.1.1
state: ACTIVE
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -16,4 +16,58 @@ responses:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
\ No newline at end of file
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
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.mp1:
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security.mp1/TokenEndPoint
serializer: JSON
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -12,4 +12,58 @@ responses:
type: object
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
\ No newline at end of file
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
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.mp1:
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security.mp1/TokenEndPoint
serializer: JSON
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -11,7 +11,57 @@ responses:
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
$ref: '../examples/ServiceInfo.json'
\ No newline at end of file
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
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.mp1:
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security.mp1/TokenEndPoint
serializer: JSON
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
\ No newline at end of file
......@@ -13,7 +13,64 @@ responses:
properties:
ServiceInfo:
$ref: '#/definitions/ServiceInfo'
examples:
application/json:
$ref: '../examples/ServiceInfo.json'
\ No newline at end of file
ServiceInfo:
serInstanceId: ServiceInstance123
serName: ExampleService
serCategory:
href: catItem1
id: id12345
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.mp1:
oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/security.mp1/TokenEndPoint
serializer: JSON
400:
description: Bad Request
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
403:
description: Forbidden
schema:
type: object
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
404:
description: Not Found
schema:
type: object
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
412: