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