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

Fixes to response codes and explicit inclusion of examples

Change-Id: Ib659e383574036e6b7cbf7cc2476f2d9f9a6eaf1
parent d743aa66
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
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: ...@@ -7,7 +7,7 @@ required:
- protocol - protocol
- version - version
- endpoint - endpoint
- security - security.mp1
properties: properties:
id: id:
$ref: '#/definitions/TransportInfo.Id' $ref: '#/definitions/TransportInfo.Id'
...@@ -23,7 +23,7 @@ properties: ...@@ -23,7 +23,7 @@ properties:
$ref: '#/definitions/TransportInfo.Version' $ref: '#/definitions/TransportInfo.Version'
endpoint: endpoint:
$ref: '#/definitions/EndPointInfo' $ref: '#/definitions/EndPointInfo'
security: security.mp1:
$ref: '#/definitions/SecurityInfo' $ref: '#/definitions/SecurityInfo'
implSpecificInfo: implSpecificInfo:
$ref: '#/definitions/TransportInfo.ImplSpecificInfo' $ref: '#/definitions/TransportInfo.ImplSpecificInfo'
\ No newline at end of file
...@@ -72,6 +72,18 @@ Mp1SubscriptionLinkList.Subscription: ...@@ -72,6 +72,18 @@ Mp1SubscriptionLinkList.Subscription:
$ref: ./Mp1SubscriptionLinkList.Subscription.yaml $ref: ./Mp1SubscriptionLinkList.Subscription.yaml
Mp1SubscriptionLinkList: Mp1SubscriptionLinkList:
$ref: ./Mp1SubscriptionLinkList.yaml $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: SecurityInfo.OAuth2Info.GrantTypes:
$ref: ./SecurityInfo.OAuth2Info.GrantTypes.yaml $ref: ./SecurityInfo.OAuth2Info.GrantTypes.yaml
SecurityInfo.OAuth2Info.TokenEndpoint: SecurityInfo.OAuth2Info.TokenEndpoint:
......
...@@ -29,10 +29,10 @@ ...@@ -29,10 +29,10 @@
} }
] ]
}, },
"security": { "security.mp1": {
"oAuth2Info": { "oAuth2Info": {
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS", "grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
"tokenEndpoint": "/meMp1/mp1.security/TokenEndPoint" "tokenEndpoint": "/meMp1/security.mp1/TokenEndPoint"
} }
} }
}, },
......
...@@ -22,8 +22,8 @@ ServiceInfo: ...@@ -22,8 +22,8 @@ ServiceInfo:
addresses: addresses:
- host: '192.0.2.0' - host: '192.0.2.0'
port: '8080' port: '8080'
security: security.mp1:
oAuth2Info: oAuth2Info:
grantTypes: OAUTH2_CLIENT_CREDENTIALS grantTypes: OAUTH2_CLIENT_CREDENTIALS
tokenEndpoint: /meMp1/mp1.security/TokenEndPoint tokenEndpoint: /meMp1/security.mp1/TokenEndPoint
serializer: JSON serializer: JSON
...@@ -13,4 +13,33 @@ responses: ...@@ -13,4 +13,33 @@ responses:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
examples: examples:
application/json: application/json:
$ref: '../examples/DnsRule.json' DnsRule:
\ No newline at end of file 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: ...@@ -12,8 +12,43 @@ responses:
type: object type: object
properties: properties:
DnsRule: DnsRule:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
examples: examples:
application/json: application/json:
$ref: '../examples/DnsRule.json' DnsRule:
\ No newline at end of file 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: ...@@ -12,4 +12,36 @@ responses:
type: object type: object
properties: properties:
DnsRule: DnsRule:
$ref: '#/definitions/DnsRule' $ref: '#/definitions/DnsRule'
\ No newline at end of file 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: ...@@ -5,4 +5,20 @@ produces:
responses: responses:
204: 204:
description: No Content description: No Content
\ No newline at end of file 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: ...@@ -13,4 +13,27 @@ responses:
$ref: '#/definitions/SerAvailabilityNotificationSubscription.Response' $ref: '#/definitions/SerAvailabilityNotificationSubscription.Response'
# The alternative response # The alternative response
# AppTerminationNotificationSubscription: # AppTerminationNotificationSubscription:
# $ref: '#/definitions/AppTerminationNotificationSubscription.Response' # $ref: '#/definitions/AppTerminationNotificationSubscription.Response'
\ No newline at end of file 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: ...@@ -10,4 +10,27 @@ responses:
type: object type: object
properties: properties:
Mp1SubscriptionLinkList: Mp1SubscriptionLinkList:
$ref: '#/definitions/Mp1SubscriptionLinkList' $ref: '#/definitions/Mp1SubscriptionLinkList'
\ No newline at end of file 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: ...@@ -8,7 +8,7 @@ parameters:
#- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription' #- $ref: '#/parameters/Body.SerAvailabilityNotificationSubscription'
responses: responses:
200: 201:
description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created. description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
schema: schema:
type: object type: object
...@@ -17,4 +17,27 @@ responses: ...@@ -17,4 +17,27 @@ responses:
$ref: '#/definitions/AppTerminationNotificationSubscription.Response' $ref: '#/definitions/AppTerminationNotificationSubscription.Response'
# The alternative response # The alternative response
# SerAvailabilityNotificationSubscription: # SerAvailabilityNotificationSubscription:
# $ref: '#/definitions/SerAvailabilityNotificationSubscription' # $ref: '#/definitions/SerAvailabilityNotificationSubscription'
\ No newline at end of file 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: ...@@ -13,4 +13,40 @@ responses:
$ref: '#/definitions/TrafficRule' $ref: '#/definitions/TrafficRule'
examples: examples:
application/json: application/json:
$ref: '../examples/TrafficRule.json' TrafficRule:
\ No newline at end of file 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
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