Skip to content
GitLab
Commit 31e4151d authored by Muhammad Hamza's avatar Muhammad Hamza
Browse files

Update example keywords for OAS 3.1.0

parent 3fc69032
Pipeline #9676 failed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
LocationAPI.json
View file @ 31e4151d
...@@ -1954,20 +1954,22 @@ ...@@ -1954,20 +1954,22 @@
"userTrackingSubscription": { "userTrackingSubscription": {
"$ref": "#/components/schemas/UserTrackingSubscription" "$ref": "#/components/schemas/UserTrackingSubscription"
} }
} },
}, "examples": [
"example": { {
"userTrackingSubscription": { "userTrackingSubscription": {
"clientCorrelator": "0123", "clientCorrelator": "0123",
"callbackReference": { "callbackReference": {
"notifyURL": "http://my.callback.com/location_notifications/some-id" "notifyURL": "http://my.callback.com/location_notifications/some-id"
}, },
"address": "acr:10.0.0.1", "address": "acr:10.0.0.1",
"userEventCriteria": [ "userEventCriteria": [
"Transferring" "Transferring"
], ],
"resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123" "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123"
} }
}
]
} }
} }
} }
...@@ -2355,20 +2357,22 @@ ...@@ -2355,20 +2357,22 @@
"zonalTrafficSubscription": { "zonalTrafficSubscription": {
"$ref": "#/components/schemas/ZonalTrafficSubscription" "$ref": "#/components/schemas/ZonalTrafficSubscription"
} }
} },
}, "examples": [
"example": { {
"zonalTrafficSubscription": { "zonalTrafficSubscription": {
"clientCorrelator": "0123", "clientCorrelator": "0123",
"callbackReference": { "callbackReference": {
"notifyURL": "http://my.callback.com/location_notifications/some-id" "notifyURL": "http://my.callback.com/location_notifications/some-id"
}, },
"zoneId": "zone01", "zoneId": "zone01",
"userEventCriteria": [ "userEventCriteria": [
"Transferring" "Transferring"
], ],
"resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123" "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123"
} }
}
]
} }
} }
} }
...@@ -2750,21 +2754,23 @@ ...@@ -2750,21 +2754,23 @@
"zoneStatusSubscription": { "zoneStatusSubscription": {
"$ref": "#/components/schemas/ZoneStatusSubscription" "$ref": "#/components/schemas/ZoneStatusSubscription"
} }
} },
}, "examples": [
"example": { {
"zoneStatusSubscription": { "zoneStatusSubscription": {
"clientCorrelator": "0123", "clientCorrelator": "0123",
"callbackReference": { "callbackReference": {
"notifyURL": "http://my.callback.com/location_notifications/some-id" "notifyURL": "http://my.callback.com/location_notifications/some-id"
}, },
"zoneId": "zone01", "zoneId": "zone01",
"numberOfUsersZoneThreshold": 500, "numberOfUsersZoneThreshold": 500,
"operationStatus": [ "operationStatus": [
"Serviceable" "Serviceable"
], ],
"resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123" "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123"
} }
}
]
} }
} }
} }
...@@ -2922,16 +2928,18 @@ ...@@ -2922,16 +2928,18 @@
"content": { "content": {
"application/problem+json": { "application/problem+json": {
"schema": { "schema": {
"$ref": "#/components/schemas/ProblemDetails" "$ref": "#/components/schemas/ProblemDetails",
}, "examples": [
"example": { {
"application/problem+json": { "application/problem+json": {
"type": "https://meAppServer.example.com/rni/v2/probs/too-many targets", "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
"title": "Too many targets", "title": "Too many targets",
"status": "422", "status": "422",
"detail": "The target area for the request is considered too large", "detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc" "instance": "/meAppClient.example.com/77777/msgs/abc"
} }
}
]
} }
} }
} }
......
LocationAPI.yaml
View file @ 31e4151d
...@@ -1257,14 +1257,14 @@ paths: ...@@ -1257,14 +1257,14 @@ paths:
properties: properties:
userTrackingSubscription: userTrackingSubscription:
$ref: '#/components/schemas/UserTrackingSubscription' $ref: '#/components/schemas/UserTrackingSubscription'
example: examples:
userTrackingSubscription: - userTrackingSubscription:
clientCorrelator: '0123' clientCorrelator: '0123'
callbackReference: callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id' notifyURL: 'http://my.callback.com/location_notifications/some-id'
address: 'acr:10.0.0.1' address: 'acr:10.0.0.1'
userEventCriteria: ["Transferring"] userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123' resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
'400': '400':
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
'401': '401':
...@@ -1503,14 +1503,14 @@ paths: ...@@ -1503,14 +1503,14 @@ paths:
properties: properties:
zonalTrafficSubscription: zonalTrafficSubscription:
$ref: '#/components/schemas/ZonalTrafficSubscription' $ref: '#/components/schemas/ZonalTrafficSubscription'
example: examples:
zonalTrafficSubscription: - zonalTrafficSubscription:
clientCorrelator: '0123' clientCorrelator: '0123'
callbackReference: callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id' notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01' zoneId: 'zone01'
userEventCriteria: ["Transferring"] userEventCriteria: ["Transferring"]
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123' resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
'400': '400':
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
'401': '401':
...@@ -1748,15 +1748,15 @@ paths: ...@@ -1748,15 +1748,15 @@ paths:
properties: properties:
zoneStatusSubscription: zoneStatusSubscription:
$ref: '#/components/schemas/ZoneStatusSubscription' $ref: '#/components/schemas/ZoneStatusSubscription'
example: examples:
zoneStatusSubscription: - zoneStatusSubscription:
clientCorrelator: '0123' clientCorrelator: '0123'
callbackReference: callbackReference:
notifyURL: 'http://my.callback.com/location_notifications/some-id' notifyURL: 'http://my.callback.com/location_notifications/some-id'
zoneId: 'zone01' zoneId: 'zone01'
numberOfUsersZoneThreshold: 500 numberOfUsersZoneThreshold: 500
operationStatus: ['Serviceable'] operationStatus: ['Serviceable']
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123' resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123'
'400': '400':
$ref: '#/components/responses/400' $ref: '#/components/responses/400'
'401': '401':
...@@ -1859,13 +1859,13 @@ components: ...@@ -1859,13 +1859,13 @@ components:
application/problem+json: application/problem+json:
schema: schema:
$ref: '#/components/schemas/ProblemDetails' $ref: '#/components/schemas/ProblemDetails'
example: examples:
application/problem+json: - application/problem+json:
type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets' type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
title: Too many targets title: Too many targets
status: '422' status: '422'
detail: The target area for the request is considered too large detail: The target area for the request is considered too large
instance: /meAppClient.example.com/77777/msgs/abc instance: /meAppClient.example.com/77777/msgs/abc
429: 429:
description: 'Too Many Requests : used when a rate limiter has triggered.' description: 'Too Many Requests : used when a rate limiter has triggered.'
content: content:
......
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