diff --git a/LocationAPI.json b/LocationAPI.json index 02e9a5545ba437b1eb0542a7aa8b2027a030874d..bc89f628b2a96b731c8752d2ff8084508195fda3 100644 --- a/LocationAPI.json +++ b/LocationAPI.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "info": { "contact": { "url": "https://forge.etsi.org/rep/mec/gs013-location-api" @@ -372,29 +372,31 @@ "$ref": "#/components/schemas/NotificationSubscriptionList" } }, - "example": { - "notificationSubscriptionList": { - "circleNotificationSubscription": [ - { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "checkImmediate": true, - "enteringLeavingCriteria": "Entering", - "frequency": 10, - "latitude": -80.88, - "longitude": 41.277, - "radius": 500, - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" - } - ], - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle" + "examples": [ + { + "notificationSubscriptionList": { + "circleNotificationSubscription": [ + { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "checkImmediate": true, + "enteringLeavingCriteria": "Entering", + "frequency": 10, + "latitude": -80.88, + "longitude": 41.277, + "radius": 500, + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + } + ], + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle" + } } - } + ] } } } @@ -420,23 +422,25 @@ "$ref": "#/components/schemas/CircleNotificationSubscription" } }, - "example": { - "circleNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "checkImmediate": true, - "enteringLeavingCriteria": "Entering", - "frequency": 10, - "latitude": -80.88, - "longitude": 41.277, - "radius": 500, - "trackingAccuracy": 10 + "examples": [ + { + "circleNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "checkImmediate": true, + "enteringLeavingCriteria": "Entering", + "frequency": 10, + "latitude": -80.88, + "longitude": 41.277, + "radius": 500, + "trackingAccuracy": 10 + } } - } + ] } } } @@ -453,24 +457,26 @@ "$ref": "#/components/schemas/CircleNotificationSubscription" } }, - "example": { - "circleNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "checkImmediate": true, - "enteringLeavingCriteria": "Entering", - "frequency": 10, - "latitude": -80.88, - "longitude": 41.277, - "radius": 500, - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + "examples": [ + { + "circleNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "checkImmediate": true, + "enteringLeavingCriteria": "Entering", + "frequency": 10, + "latitude": -80.88, + "longitude": 41.277, + "radius": 500, + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + } } - } + ] } } } @@ -513,30 +519,32 @@ "$ref": "#/components/schemas/SubscriptionNotification" } }, - "example": { - "subscriptionNotification": { - "enteringLeavingCriteria": "Entering", - "isFinalNotification": "false,", - "link": { - "rel": "CircleNotificationSubscription", - "href": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/sub123" - }, - "terminalLocation": { - "address": "acr:10.0.0.1", - "currentLocation": { - "accuracy": 100, - "altitude": 1001, - "latitude": -80.86302, - "longitude": 41.277306, - "timestamp": { - "seconds": 1483231138, - "nanoSeconds\"": 0 - } + "examples": [ + { + "subscriptionNotification": { + "enteringLeavingCriteria": "Entering", + "isFinalNotification": "false,", + "link": { + "rel": "CircleNotificationSubscription", + "href": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/sub123" }, - "locationRetrievalStatus": "Retrieved" + "terminalLocation": { + "address": "acr:10.0.0.1", + "currentLocation": { + "accuracy": 100, + "altitude": 1001, + "latitude": -80.86302, + "longitude": 41.277306, + "timestamp": { + "seconds": 1483231138, + "nanoSeconds\"": 0 + } + }, + "locationRetrievalStatus": "Retrieved" + } } } - } + ] } } } @@ -581,24 +589,26 @@ "$ref": "#/components/schemas/CircleNotificationSubscription" } }, - "example": { - "circleNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "checkImmediate": true, - "enteringLeavingCriteria": "Entering", - "frequency": 10, - "latitude": -80.88, - "longitude": 41.277, - "radius": 500, - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + "examples": [ + { + "circleNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "checkImmediate": true, + "enteringLeavingCriteria": "Entering", + "frequency": 10, + "latitude": -80.88, + "longitude": 41.277, + "radius": 500, + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + } } - } + ] } } } @@ -643,24 +653,26 @@ "$ref": "#/components/schemas/CircleNotificationSubscription" } }, - "example": { - "circleNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "checkImmediate": true, - "enteringLeavingCriteria": "Entering", - "frequency": 10, - "latitude": -80.88, - "longitude": 41.277, - "radius": 500, - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + "examples": [ + { + "circleNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "checkImmediate": true, + "enteringLeavingCriteria": "Entering", + "frequency": 10, + "latitude": -80.88, + "longitude": 41.277, + "radius": 500, + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + } } - } + ] } } } @@ -682,24 +694,26 @@ "$ref": "#/components/schemas/CircleNotificationSubscription" } }, - "example": { - "circleNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "checkImmediate": true, - "enteringLeavingCriteria": "Entering", - "frequency": 10, - "latitude": -80.88, - "longitude": 41.277, - "radius": 500, - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + "examples": [ + { + "circleNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "checkImmediate": true, + "enteringLeavingCriteria": "Entering", + "frequency": 10, + "latitude": -80.88, + "longitude": 41.277, + "radius": 500, + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123" + } } - } + ] } } } @@ -786,31 +800,33 @@ "$ref": "#/components/schemas/NotificationSubscriptionList" } }, - "example": { - "notificationSubscriptionList": { - "distanceNotificationSubscription": [ - { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "monitoredAddress": [ - "acr:10.0.0.1", - "acr:10.0.0.2" - ], - "checkImmediate": true, - "criteria": "AllWithinDistance", - "distance": 100, - "frequency": 10, - "referenceAddress": "acr:10.0.0.3", - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/sub123" - } - ], - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance" + "examples": [ + { + "notificationSubscriptionList": { + "distanceNotificationSubscription": [ + { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "monitoredAddress": [ + "acr:10.0.0.1", + "acr:10.0.0.2" + ], + "checkImmediate": true, + "criteria": "AllWithinDistance", + "distance": 100, + "frequency": 10, + "referenceAddress": "acr:10.0.0.3", + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/sub123" + } + ], + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance" + } } - } + ] } } } @@ -836,25 +852,27 @@ "$ref": "#/components/schemas/DistanceNotificationSubscription" } }, - "example": { - "distanceNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "monitoredAddress": [ - "acr:10.0.0.1", - "acr:10.0.0.2" - ], - "checkImmediate": true, - "criteria": "AllWithinDistance", - "distance": 100, - "frequency": 10, - "referenceAddress": "acr:10.0.0.3", - "trackingAccuracy": 10 + "examples": [ + { + "distanceNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "monitoredAddress": [ + "acr:10.0.0.1", + "acr:10.0.0.2" + ], + "checkImmediate": true, + "criteria": "AllWithinDistance", + "distance": 100, + "frequency": 10, + "referenceAddress": "acr:10.0.0.3", + "trackingAccuracy": 10 + } } - } + ] } } } @@ -871,26 +889,28 @@ "$ref": "#/components/schemas/DistanceNotificationSubscription" } }, - "example": { - "distanceNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "monitoredAddress": [ - "acr:10.0.0.1", - "acr:10.0.0.2" - ], - "checkImmediate": true, - "criteria": "AllWithinDistance", - "distance": 100, - "frequency": 10, - "referenceAddress": "acr:10.0.0.3", - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + "examples": [ + { + "distanceNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "monitoredAddress": [ + "acr:10.0.0.1", + "acr:10.0.0.2" + ], + "checkImmediate": true, + "criteria": "AllWithinDistance", + "distance": 100, + "frequency": 10, + "referenceAddress": "acr:10.0.0.3", + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + } } - } + ] } } } @@ -933,46 +953,48 @@ "$ref": "#/components/schemas/SubscriptionNotification" } }, - "example": { - "subscriptionNotification": { - "distanceCriteria": "AllWithinDistance", - "isFinalNotification": "false,", - "link": { - "rel": "DistanceNotificationSubscription", - "href": "http://meAppServer.example.com/location/v2/subscriptions/distance/sub123" - }, - "terminalLocation": [ - { - "address": "acr:10.0.0.1", - "currentLocation": { - "accuracy": 100, - "altitude": 1001, - "latitude": -80.86302, - "longitude": 41.277306, - "timestamp": { - "seconds": 1483231138, - "nanoSeconds\"": 0 - } - }, - "locationRetrievalStatus": "Retrieved" + "examples": [ + { + "subscriptionNotification": { + "distanceCriteria": "AllWithinDistance", + "isFinalNotification": "false,", + "link": { + "rel": "DistanceNotificationSubscription", + "href": "http://meAppServer.example.com/location/v2/subscriptions/distance/sub123" }, - { - "address": "acr:10.0.0.2", - "currentLocation": { - "accuracy": 100, - "altitude": 1001, - "latitude": -80.86301, - "longitude": 41.277306, - "timestamp": { - "seconds": 1483231138, - "nanoSeconds\"": 0 - } + "terminalLocation": [ + { + "address": "acr:10.0.0.1", + "currentLocation": { + "accuracy": 100, + "altitude": 1001, + "latitude": -80.86302, + "longitude": 41.277306, + "timestamp": { + "seconds": 1483231138, + "nanoSeconds\"": 0 + } + }, + "locationRetrievalStatus": "Retrieved" }, - "locationRetrievalStatus": "Retrieved" - } - ] + { + "address": "acr:10.0.0.2", + "currentLocation": { + "accuracy": 100, + "altitude": 1001, + "latitude": -80.86301, + "longitude": 41.277306, + "timestamp": { + "seconds": 1483231138, + "nanoSeconds\"": 0 + } + }, + "locationRetrievalStatus": "Retrieved" + } + ] + } } - } + ] } } } @@ -1017,26 +1039,28 @@ "$ref": "#/components/schemas/DistanceNotificationSubscription" } }, - "example": { - "distanceNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "monitoredAddress": [ - "acr:10.0.0.1", - "acr:10.0.0.2" - ], - "checkImmediate": true, - "criteria": "AllWithinDistance", - "distance": 100, - "frequency": 10, - "referenceAddress": "acr:10.0.0.3", - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + "examples": [ + { + "distanceNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "monitoredAddress": [ + "acr:10.0.0.1", + "acr:10.0.0.2" + ], + "checkImmediate": true, + "criteria": "AllWithinDistance", + "distance": 100, + "frequency": 10, + "referenceAddress": "acr:10.0.0.3", + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + } } - } + ] } } } @@ -1081,26 +1105,28 @@ "$ref": "#/components/schemas/DistanceNotificationSubscription" } }, - "example": { - "distanceNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "monitoredAddress": [ - "acr:10.0.0.1", - "acr:10.0.0.2" - ], - "checkImmediate": true, - "criteria": "AllWithinDistance", - "distance": 100, - "frequency": 10, - "referenceAddress": "acr:10.0.0.3", - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + "examples": [ + { + "distanceNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "monitoredAddress": [ + "acr:10.0.0.1", + "acr:10.0.0.2" + ], + "checkImmediate": true, + "criteria": "AllWithinDistance", + "distance": 100, + "frequency": 10, + "referenceAddress": "acr:10.0.0.3", + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + } } - } + ] } } } @@ -1122,26 +1148,28 @@ "$ref": "#/components/schemas/DistanceNotificationSubscription" } }, - "example": { - "distanceNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "monitoredAddress": [ - "acr:10.0.0.1", - "acr:10.0.0.2" - ], - "checkImmediate": true, - "criteria": "AllWithinDistance", - "distance": 100, - "frequency": 10, - "referenceAddress": "acr:10.0.0.3", - "trackingAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + "examples": [ + { + "distanceNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "monitoredAddress": [ + "acr:10.0.0.1", + "acr:10.0.0.2" + ], + "checkImmediate": true, + "criteria": "AllWithinDistance", + "distance": 100, + "frequency": 10, + "referenceAddress": "acr:10.0.0.3", + "trackingAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123" + } } - } + ] } } } @@ -1228,24 +1256,26 @@ "$ref": "#/components/schemas/NotificationSubscriptionList" } }, - "example": { - "notificationSubscriptionList": { - "periodicNotificationSubscription": [ - { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "frequency": 10, - "requestedAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" - } - ], - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic" + "examples": [ + { + "notificationSubscriptionList": { + "periodicNotificationSubscription": [ + { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "frequency": 10, + "requestedAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + } + ], + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic" + } } - } + ] } } } @@ -1271,18 +1301,20 @@ "$ref": "#/components/schemas/PeriodicNotificationSubscription" } }, - "example": { - "periodicNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "frequency": 10, - "requestedAccuracy": 10 + "examples": [ + { + "periodicNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "frequency": 10, + "requestedAccuracy": 10 + } } - } + ] } } } @@ -1299,19 +1331,21 @@ "$ref": "#/components/schemas/PeriodicNotificationSubscription" } }, - "example": { - "periodicNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "frequency": 10, - "requestedAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + "examples": [ + { + "periodicNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "frequency": 10, + "requestedAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + } } - } + ] } } } @@ -1354,29 +1388,31 @@ "$ref": "#/components/schemas/SubscriptionNotification" } }, - "example": { - "subscriptionNotification": { - "isFinalNotification": "false,", - "link": { - "rel": "PeriodicNotificationSubscription", - "href": "http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123" - }, - "terminalLocation": { - "address": "acr:10.0.0.1", - "currentLocation": { - "accuracy": 100, - "altitude": 1001, - "latitude": -80.86302, - "longitude": 41.277306, - "timestamp": { - "seconds": 1483231138, - "nanoSeconds\"": 0 - } + "examples": [ + { + "subscriptionNotification": { + "isFinalNotification": "false,", + "link": { + "rel": "PeriodicNotificationSubscription", + "href": "http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123" }, - "locationRetrievalStatus": "Retrieved" + "terminalLocation": { + "address": "acr:10.0.0.1", + "currentLocation": { + "accuracy": 100, + "altitude": 1001, + "latitude": -80.86302, + "longitude": 41.277306, + "timestamp": { + "seconds": 1483231138, + "nanoSeconds\"": 0 + } + }, + "locationRetrievalStatus": "Retrieved" + } } } - } + ] } } } @@ -1421,19 +1457,21 @@ "$ref": "#/components/schemas/PeriodicNotificationSubscription" } }, - "example": { - "periodicNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "frequency": 10, - "requestedAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + "examples": [ + { + "periodicNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "frequency": 10, + "requestedAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + } } - } + ] } } } @@ -1478,19 +1516,21 @@ "$ref": "#/components/schemas/PeriodicNotificationSubscription" } }, - "example": { - "periodicNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "frequency": 10, - "requestedAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + "examples": [ + { + "periodicNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "frequency": 10, + "requestedAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + } } - } + ] } } } @@ -1512,19 +1552,21 @@ "$ref": "#/components/schemas/PeriodicNotificationSubscription" } }, - "example": { - "periodicNotificationSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "callbackData": "1234", - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:10.0.0.1", - "frequency": 10, - "requestedAccuracy": 10, - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + "examples": [ + { + "periodicNotificationSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "callbackData": "1234", + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:10.0.0.1", + "frequency": 10, + "requestedAccuracy": 10, + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123" + } } - } + ] } } } @@ -1611,35 +1653,37 @@ "$ref": "#/components/schemas/NotificationSubscriptionList" } }, - "example": { - "notificationSubscriptionList": { - "userTrackingSubscription": [ - { - "clientCorrelator": "0123", - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123", - "callbackReference": { - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "address": "acr:192.0.2.1", - "userEventCriteria": [ - "Transferring" - ] - }, - { - "clientCorrelator": "0124", - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124", - "callbackReference": { - "notifyURL": "http://clientApp.example.com/location_notifications/123456" + "examples": [ + { + "notificationSubscriptionList": { + "userTrackingSubscription": [ + { + "clientCorrelator": "0123", + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123", + "callbackReference": { + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:192.0.2.1", + "userEventCriteria": [ + "Transferring" + ] }, - "address": "acr:192.0.2.2", - "userEventCriteria": [ - "Transferring" - ] - } - ], - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking" + { + "clientCorrelator": "0124", + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124", + "callbackReference": { + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "address": "acr:192.0.2.2", + "userEventCriteria": [ + "Transferring" + ] + } + ], + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking" + } } - } + ] } } } @@ -1665,18 +1709,20 @@ "$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" - ] + "examples": [ + { + "userTrackingSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "notifyURL": "http://my.callback.com/location_notifications/some-id" + }, + "address": "acr:10.0.0.1", + "userEventCriteria": [ + "Transferring" + ] + } } - } + ] } } } @@ -1693,19 +1739,21 @@ "$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" + } } - } + ] } } } @@ -1748,24 +1796,26 @@ "$ref": "#/components/schemas/ZonalPresenceNotification" } }, - "example": { - "zonalPresenceNotification": { - "clientCorrelator": "0123", - "zoneId": "zone01", - "address": "acr:10.0.0.1", - "userEventType": "Transferring", - "currentAccessPointId": "ap2", - "previousAccessPointId": "ap1", - "timestamp": { - "seconds": 1483231138, - "nanoseconds": 0 - }, - "link": { - "rel": "UserTrackingSubscription", - "href": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123" + "examples": [ + { + "zonalPresenceNotification": { + "clientCorrelator": "0123", + "zoneId": "zone01", + "address": "acr:10.0.0.1", + "userEventType": "Transferring", + "currentAccessPointId": "ap2", + "previousAccessPointId": "ap1", + "timestamp": { + "seconds": 1483231138, + "nanoseconds": 0 + }, + "link": { + "rel": "UserTrackingSubscription", + "href": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123" + } } } - } + ] } } } @@ -1810,19 +1860,21 @@ "$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" + } } - } + ] } } } @@ -1867,19 +1919,21 @@ "$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" + } } - } + ] } } } @@ -1900,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" + } + } + ] } } } @@ -2000,35 +2056,37 @@ "$ref": "#/components/schemas/NotificationSubscriptionList" } }, - "example": { - "notificationSubscriptionList": { - "zonalTrafficSubscription": [ - { - "clientCorrelator": "0123", - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123", - "callbackReference": { - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "zoneId": "zone01", - "userEventCriteria": [ - "Transferring" - ] - }, - { - "clientCorrelator": "0124", - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124", - "callbackReference": { - "notifyURL": "http://clientApp.example.com/location_notifications/123456" + "examples": [ + { + "notificationSubscriptionList": { + "zonalTrafficSubscription": [ + { + "clientCorrelator": "0123", + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123", + "callbackReference": { + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "zoneId": "zone01", + "userEventCriteria": [ + "Transferring" + ] }, - "zoneId": "zone02", - "userEventCriteria": [ - "Transferring" - ] - } - ], - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic" + { + "clientCorrelator": "0124", + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124", + "callbackReference": { + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "zoneId": "zone02", + "userEventCriteria": [ + "Transferring" + ] + } + ], + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic" + } } - } + ] } } } @@ -2054,18 +2112,20 @@ "$ref": "#/components/schemas/ZonalTrafficSubscription" } }, - "example": { - "zonalTrafficSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "notifyURL": "http://my.callback.com/location_notifications/some-id" - }, - "zoneId": "zone01", - "userEventCriteria": [ - "Transferring" - ] + "examples": [ + { + "zonalTrafficSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "notifyURL": "http://my.callback.com/location_notifications/some-id" + }, + "zoneId": "zone01", + "userEventCriteria": [ + "Transferring" + ] + } } - } + ] } } } @@ -2082,19 +2142,21 @@ "$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" + } } - } + ] } } } @@ -2137,24 +2199,26 @@ "$ref": "#/components/schemas/ZonalPresenceNotification" } }, - "example": { - "zonalPresenceNotification": { - "clientCorrelator": "0123", - "zoneId": "zone01", - "address": "acr:10.0.0.1", - "userEventType": "Transferring", - "currentAccessPointId": "ap2", - "previousAccessPointId": "ap1", - "timestamp": { - "seconds": 1483231138, - "nanoseconds": 0 - }, - "link": { - "rel": "ZonalTrafficSubscription", - "href": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123" + "examples": [ + { + "zonalPresenceNotification": { + "clientCorrelator": "0123", + "zoneId": "zone01", + "address": "acr:10.0.0.1", + "userEventType": "Transferring", + "currentAccessPointId": "ap2", + "previousAccessPointId": "ap1", + "timestamp": { + "seconds": 1483231138, + "nanoseconds": 0 + }, + "link": { + "rel": "ZonalTrafficSubscription", + "href": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123" + } } } - } + ] } } } @@ -2199,19 +2263,21 @@ "$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" + } } - } + ] } } } @@ -2256,19 +2322,21 @@ "$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" + } } - } + ] } } } @@ -2289,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" + } + } + ] } } } @@ -2389,25 +2459,27 @@ "$ref": "#/components/schemas/NotificationSubscriptionList" } }, - "example": { - "notificationSubscriptionList": { - "zoneStatusSubscription": [ - { - "clientCorrelator": "0123", - "resourceURL": "http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123", - "callbackReference": { - "notifyURL": "http://clientApp.example.com/location_notifications/123456" - }, - "zoneId": "zone01", - "numberOfUsersZoneThreshold": 500, - "operationStatus": [ - "Serviceable" - ] - } - ], - "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus" + "examples": [ + { + "notificationSubscriptionList": { + "zoneStatusSubscription": [ + { + "clientCorrelator": "0123", + "resourceURL": "http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123", + "callbackReference": { + "notifyURL": "http://clientApp.example.com/location_notifications/123456" + }, + "zoneId": "zone01", + "numberOfUsersZoneThreshold": 500, + "operationStatus": [ + "Serviceable" + ] + } + ], + "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus" + } } - } + ] } } } @@ -2433,19 +2505,21 @@ "$ref": "#/components/schemas/ZoneStatusSubscription" } }, - "example": { - "zoneStatusSubscription": { - "clientCorrelator": "0123", - "callbackReference": { - "notifyURL": "http://my.callback.com/location_notifications/some-id" - }, - "zoneId": "zone01", - "numberOfUsersZoneThreshold": 500, - "operationStatus": [ - "Serviceable" - ] + "examples": [ + { + "zoneStatusSubscription": { + "clientCorrelator": "0123", + "callbackReference": { + "notifyURL": "http://my.callback.com/location_notifications/some-id" + }, + "zoneId": "zone01", + "numberOfUsersZoneThreshold": 500, + "operationStatus": [ + "Serviceable" + ] + } } - } + ] } } } @@ -2462,20 +2536,22 @@ "$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" + } } - } + ] } } } @@ -2518,24 +2594,26 @@ "$ref": "#/components/schemas/ZoneStatusNotification" } }, - "example": { - "zoneStatusNotification": { - "clientCorrelator": "0123", - "zoneId": "zone01", - "accessPointId": "poa1", - "operationStatus": "Serviceable", - "numberOfUsersInZone": "20", - "numberOfUsersInAP": "12", - "timestamp": { - "seconds": 1483231138, - "nanoseconds": 0 - }, - "link": { - "rel": "ZoneStatusSubscription", - "href": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123" + "examples": [ + { + "zoneStatusNotification": { + "clientCorrelator": "0123", + "zoneId": "zone01", + "accessPointId": "poa1", + "operationStatus": "Serviceable", + "numberOfUsersInZone": "20", + "numberOfUsersInAP": "12", + "timestamp": { + "seconds": 1483231138, + "nanoseconds": 0 + }, + "link": { + "rel": "ZoneStatusSubscription", + "href": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123" + } } } - } + ] } } } @@ -2580,20 +2658,22 @@ "$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" + } } - } + ] } } } @@ -2638,20 +2718,22 @@ "$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" + } } - } + ] } } } @@ -2672,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" + } + } + ] } } } @@ -2845,15 +2929,6 @@ "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" - } } } } diff --git a/LocationAPI.yaml b/LocationAPI.yaml index 280c8442cbf556a0c69f38b39fafe890bae3c54e..b8778be17a588a728a837f4cbe9acb9d718ac1a1 100644 --- a/LocationAPI.yaml +++ b/LocationAPI.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.1.0 info: contact: url: https://forge.etsi.org/rep/mec/gs013-location-api @@ -232,23 +232,23 @@ paths: properties: notificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - example: - notificationSubscriptionList: - circleNotificationSubscription: - - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - checkImmediate: true - enteringLeavingCriteria: 'Entering' - frequency: 10 - latitude: -80.88 - longitude: 41.277 - radius: 500 - trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle' + examples: + - notificationSubscriptionList: + circleNotificationSubscription: + - clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + checkImmediate: true + enteringLeavingCriteria: 'Entering' + frequency: 10 + latitude: -80.88 + longitude: 41.277 + radius: 500 + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle' post: tags: - 'location' @@ -265,32 +265,8 @@ paths: properties: circleNotificationSubscription: $ref: '#/components/schemas/CircleNotificationSubscription' - example: - circleNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - checkImmediate: true - enteringLeavingCriteria: 'Entering' - frequency: 10 - latitude: -80.88 - longitude: 41.277 - radius: 500 - trackingAccuracy: 10 - responses: - '201': - description: 'Successful subscription' - content: - application/json: - schema: - type: object - properties: - circleNotificationSubscription: - $ref: '#/components/schemas/CircleNotificationSubscription' - example: - circleNotificationSubscription: + examples: + - circleNotificationSubscription: clientCorrelator: '0123' callbackReference: callbackData: '1234' @@ -303,7 +279,31 @@ paths: longitude: 41.277 radius: 500 trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' + responses: + '201': + description: 'Successful subscription' + content: + application/json: + schema: + type: object + properties: + circleNotificationSubscription: + $ref: '#/components/schemas/CircleNotificationSubscription' + examples: + - circleNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + checkImmediate: true + enteringLeavingCriteria: 'Entering' + frequency: 10 + latitude: -80.88 + longitude: 41.277 + radius: 500 + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -333,24 +333,24 @@ paths: properties: subscriptionNotification: $ref: '#/components/schemas/SubscriptionNotification' - example: - subscriptionNotification: - enteringLeavingCriteria: 'Entering' - isFinalNotification: false, - link: - rel: CircleNotificationSubscription - href: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/sub123' - terminalLocation: - address: 'acr:10.0.0.1' - currentLocation: - accuracy: 100 - altitude: 1001.0 - latitude: -80.86302 - longitude: 41.277306 - timestamp: - seconds: 1483231138 - nanoSeconds": 0 - locationRetrievalStatus: 'Retrieved' + examples: + - subscriptionNotification: + enteringLeavingCriteria: 'Entering' + isFinalNotification: false, + link: + rel: CircleNotificationSubscription + href: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/sub123' + terminalLocation: + address: 'acr:10.0.0.1' + currentLocation: + accuracy: 100 + altitude: 1001.0 + latitude: -80.86302 + longitude: 41.277306 + timestamp: + seconds: 1483231138 + nanoSeconds": 0 + locationRetrievalStatus: 'Retrieved' responses: '204': $ref: '#/components/responses/204' @@ -376,21 +376,21 @@ paths: properties: circleNotificationSubscription: $ref: '#/components/schemas/CircleNotificationSubscription' - example: - circleNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - checkImmediate: true - enteringLeavingCriteria: 'Entering' - frequency: 10 - latitude: -80.88 - longitude: 41.277 - radius: 500 - trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' + examples: + - circleNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + checkImmediate: true + enteringLeavingCriteria: 'Entering' + frequency: 10 + latitude: -80.88 + longitude: 41.277 + radius: 500 + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -420,35 +420,8 @@ paths: properties: circleNotificationSubscription: $ref: '#/components/schemas/CircleNotificationSubscription' - example: - circleNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - checkImmediate: true - enteringLeavingCriteria: 'Entering' - frequency: 10 - latitude: -80.88 - longitude: 41.277 - radius: 500 - trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' - parameters: - - $ref: '#/components/parameters/Path.SubscrId' - responses: - '200': - description: 'Successful subscription to response to subscription notifications' - content: - application/json: - schema: - type: object - properties: - circleNotificationSubscription: - $ref: '#/components/schemas/CircleNotificationSubscription' - example: - circleNotificationSubscription: + examples: + - circleNotificationSubscription: clientCorrelator: '0123' callbackReference: callbackData: '1234' @@ -462,6 +435,33 @@ paths: radius: 500 trackingAccuracy: 10 resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' + parameters: + - $ref: '#/components/parameters/Path.SubscrId' + responses: + '200': + description: 'Successful subscription to response to subscription notifications' + content: + application/json: + schema: + type: object + properties: + circleNotificationSubscription: + $ref: '#/components/schemas/CircleNotificationSubscription' + examples: + - circleNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + checkImmediate: true + enteringLeavingCriteria: 'Entering' + frequency: 10 + latitude: -80.88 + longitude: 41.277 + radius: 500 + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -518,24 +518,24 @@ paths: properties: notificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - example: - notificationSubscriptionList: - distanceNotificationSubscription: - - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - checkImmediate: true - criteria: 'AllWithinDistance' - distance: 100 - frequency: 10 - referenceAddress: 'acr:10.0.0.3' - trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance' + examples: + - notificationSubscriptionList: + distanceNotificationSubscription: + - clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + monitoredAddress: + - 'acr:10.0.0.1' + - 'acr:10.0.0.2' + checkImmediate: true + criteria: 'AllWithinDistance' + distance: 100 + frequency: 10 + referenceAddress: 'acr:10.0.0.3' + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance' post: tags: - 'location' @@ -552,33 +552,8 @@ paths: properties: distanceNotificationSubscription: $ref: '#/components/schemas/DistanceNotificationSubscription' - example: - distanceNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - checkImmediate: true - criteria: 'AllWithinDistance' - distance: 100 - frequency: 10 - referenceAddress: 'acr:10.0.0.3' - trackingAccuracy: 10 - responses: - '201': - description: 'Successful subscription' - content: - application/json: - schema: - type: object - properties: - distanceNotificationSubscription: - $ref: '#/components/schemas/DistanceNotificationSubscription' - example: - distanceNotificationSubscription: + examples: + - distanceNotificationSubscription: clientCorrelator: '0123' callbackReference: callbackData: '1234' @@ -592,7 +567,32 @@ paths: frequency: 10 referenceAddress: 'acr:10.0.0.3' trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' + responses: + '201': + description: 'Successful subscription' + content: + application/json: + schema: + type: object + properties: + distanceNotificationSubscription: + $ref: '#/components/schemas/DistanceNotificationSubscription' + examples: + - distanceNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + monitoredAddress: + - 'acr:10.0.0.1' + - 'acr:10.0.0.2' + checkImmediate: true + criteria: 'AllWithinDistance' + distance: 100 + frequency: 10 + referenceAddress: 'acr:10.0.0.3' + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -622,34 +622,34 @@ paths: properties: subscriptionNotification: $ref: '#/components/schemas/SubscriptionNotification' - example: - subscriptionNotification: - distanceCriteria: 'AllWithinDistance' - isFinalNotification: false, - link: - rel: DistanceNotificationSubscription - href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123' - terminalLocation: - - address: 'acr:10.0.0.1' - currentLocation: - accuracy: 100 - altitude: 1001.0 - latitude: -80.86302 - longitude: 41.277306 - timestamp: - seconds: 1483231138 - nanoSeconds": 0 - locationRetrievalStatus: 'Retrieved' - - address: 'acr:10.0.0.2' - currentLocation: - accuracy: 100 - altitude: 1001.0 - latitude: -80.86301 - longitude: 41.277306 - timestamp: - seconds: 1483231138 - nanoSeconds": 0 - locationRetrievalStatus: 'Retrieved' + examples: + - subscriptionNotification: + distanceCriteria: 'AllWithinDistance' + isFinalNotification: false, + link: + rel: DistanceNotificationSubscription + href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123' + terminalLocation: + - address: 'acr:10.0.0.1' + currentLocation: + accuracy: 100 + altitude: 1001.0 + latitude: -80.86302 + longitude: 41.277306 + timestamp: + seconds: 1483231138 + nanoSeconds": 0 + locationRetrievalStatus: 'Retrieved' + - address: 'acr:10.0.0.2' + currentLocation: + accuracy: 100 + altitude: 1001.0 + latitude: -80.86301 + longitude: 41.277306 + timestamp: + seconds: 1483231138 + nanoSeconds": 0 + locationRetrievalStatus: 'Retrieved' responses: '204': $ref: '#/components/responses/204' @@ -675,22 +675,22 @@ paths: properties: distanceNotificationSubscription: $ref: '#/components/schemas/DistanceNotificationSubscription' - example: - distanceNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - checkImmediate: true - criteria: 'AllWithinDistance' - distance: 100 - frequency: 10 - referenceAddress: 'acr:10.0.0.3' - trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' + examples: + - distanceNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + monitoredAddress: + - 'acr:10.0.0.1' + - 'acr:10.0.0.2' + checkImmediate: true + criteria: 'AllWithinDistance' + distance: 100 + frequency: 10 + referenceAddress: 'acr:10.0.0.3' + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -720,36 +720,8 @@ paths: properties: distanceNotificationSubscription: $ref: '#/components/schemas/DistanceNotificationSubscription' - example: - distanceNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - checkImmediate: true - criteria: 'AllWithinDistance' - distance: 100 - frequency: 10 - referenceAddress: 'acr:10.0.0.3' - trackingAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' - parameters: - - $ref: '#/components/parameters/Path.SubscrId' - responses: - '200': - description: 'Successful subscription to response to subscription notifications' - content: - application/json: - schema: - type: object - properties: - distanceNotificationSubscription: - $ref: '#/components/schemas/DistanceNotificationSubscription' - example: - distanceNotificationSubscription: + examples: + - distanceNotificationSubscription: clientCorrelator: '0123' callbackReference: callbackData: '1234' @@ -764,6 +736,34 @@ paths: referenceAddress: 'acr:10.0.0.3' trackingAccuracy: 10 resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' + parameters: + - $ref: '#/components/parameters/Path.SubscrId' + responses: + '200': + description: 'Successful subscription to response to subscription notifications' + content: + application/json: + schema: + type: object + properties: + distanceNotificationSubscription: + $ref: '#/components/schemas/DistanceNotificationSubscription' + examples: + - distanceNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + monitoredAddress: + - 'acr:10.0.0.1' + - 'acr:10.0.0.2' + checkImmediate: true + criteria: 'AllWithinDistance' + distance: 100 + frequency: 10 + referenceAddress: 'acr:10.0.0.3' + trackingAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -820,18 +820,18 @@ paths: properties: notificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - example: - notificationSubscriptionList: - periodicNotificationSubscription: - - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - frequency: 10 - requestedAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic' + examples: + - notificationSubscriptionList: + periodicNotificationSubscription: + - clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + frequency: 10 + requestedAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic' post: tags: - 'location' @@ -848,15 +848,15 @@ paths: properties: periodicNotificationSubscription: $ref: '#/components/schemas/PeriodicNotificationSubscription' - example: - periodicNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - frequency: 10 - requestedAccuracy: 10 + examples: + - periodicNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + frequency: 10 + requestedAccuracy: 10 responses: '201': description: 'Successful subscription' @@ -867,16 +867,16 @@ paths: properties: periodicNotificationSubscription: $ref: '#/components/schemas/PeriodicNotificationSubscription' - example: - periodicNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - frequency: 10 - requestedAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' + examples: + - periodicNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + frequency: 10 + requestedAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -906,23 +906,23 @@ paths: properties: subscriptionNotification: $ref: '#/components/schemas/SubscriptionNotification' - example: - subscriptionNotification: - isFinalNotification: false, - link: - rel: PeriodicNotificationSubscription - href: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123' - terminalLocation: - address: 'acr:10.0.0.1' - currentLocation: - accuracy: 100 - altitude: 1001.0 - latitude: -80.86302 - longitude: 41.277306 - timestamp: - seconds: 1483231138 - nanoSeconds": 0 - locationRetrievalStatus: 'Retrieved' + examples: + - subscriptionNotification: + isFinalNotification: false, + link: + rel: PeriodicNotificationSubscription + href: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123' + terminalLocation: + address: 'acr:10.0.0.1' + currentLocation: + accuracy: 100 + altitude: 1001.0 + latitude: -80.86302 + longitude: 41.277306 + timestamp: + seconds: 1483231138 + nanoSeconds": 0 + locationRetrievalStatus: 'Retrieved' responses: '204': $ref: '#/components/responses/204' @@ -948,16 +948,16 @@ paths: properties: periodicNotificationSubscription: $ref: '#/components/schemas/PeriodicNotificationSubscription' - example: - periodicNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - frequency: 10 - requestedAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' + examples: + - periodicNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + frequency: 10 + requestedAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -987,16 +987,16 @@ paths: properties: periodicNotificationSubscription: $ref: '#/components/schemas/PeriodicNotificationSubscription' - example: - periodicNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - frequency: 10 - requestedAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' + examples: + - periodicNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + frequency: 10 + requestedAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' parameters: - $ref: '#/components/parameters/Path.SubscrId' responses: @@ -1009,16 +1009,16 @@ paths: properties: periodicNotificationSubscription: $ref: '#/components/schemas/PeriodicNotificationSubscription' - example: - periodicNotificationSubscription: - clientCorrelator: '0123' - callbackReference: - callbackData: '1234' - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:10.0.0.1' - frequency: 10 - requestedAccuracy: 10 - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' + examples: + - periodicNotificationSubscription: + clientCorrelator: '0123' + callbackReference: + callbackData: '1234' + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:10.0.0.1' + frequency: 10 + requestedAccuracy: 10 + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123' '400': $ref: '#/components/responses/400' '401': @@ -1075,22 +1075,22 @@ paths: properties: notificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - example: - notificationSubscriptionList: - userTrackingSubscription: - - clientCorrelator: '0123' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.1' - userEventCriteria: ["Transferring"] - - clientCorrelator: '0124' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - address: 'acr:192.0.2.2' - userEventCriteria: ["Transferring"] - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking' + examples: + - notificationSubscriptionList: + userTrackingSubscription: + - clientCorrelator: '0123' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.1' + userEventCriteria: ["Transferring"] + - clientCorrelator: '0124' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + address: 'acr:192.0.2.2' + userEventCriteria: ["Transferring"] + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking' post: tags: - 'location' @@ -1107,13 +1107,13 @@ 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"] + examples: + - userTrackingSubscription: + clientCorrelator: '0123' + callbackReference: + notifyURL: 'http://my.callback.com/location_notifications/some-id' + address: 'acr:10.0.0.1' + userEventCriteria: ["Transferring"] responses: '201': description: 'Successful subscription' @@ -1124,14 +1124,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': @@ -1161,20 +1161,20 @@ paths: properties: zonalPresenceNotification: $ref: '#/components/schemas/ZonalPresenceNotification' - example: - zonalPresenceNotification: - clientCorrelator: '0123' - zoneId: 'zone01' - address: 'acr:10.0.0.1' - userEventType: 'Transferring' - currentAccessPointId: 'ap2' - previousAccessPointId: 'ap1' - timestamp: - seconds: 1483231138 - nanoseconds: 0 - link: - rel: UserTrackingSubscription - href: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123' + examples: + - zonalPresenceNotification: + clientCorrelator: '0123' + zoneId: 'zone01' + address: 'acr:10.0.0.1' + userEventType: 'Transferring' + currentAccessPointId: 'ap2' + previousAccessPointId: 'ap1' + timestamp: + seconds: 1483231138 + nanoseconds: 0 + link: + rel: UserTrackingSubscription + href: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123' responses: '204': $ref: '#/components/responses/204' @@ -1200,14 +1200,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': @@ -1237,14 +1237,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' parameters: - $ref: '#/components/parameters/Path.SubscrId' responses: @@ -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': @@ -1321,22 +1321,22 @@ paths: properties: notificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - example: - notificationSubscriptionList: - zonalTrafficSubscription: - - clientCorrelator: '0123' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: 'zone01' - userEventCriteria: ["Transferring"] - - clientCorrelator: '0124' - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: 'zone02' - userEventCriteria: ["Transferring"] - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic' + examples: + - notificationSubscriptionList: + zonalTrafficSubscription: + - clientCorrelator: '0123' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: 'zone01' + userEventCriteria: ["Transferring"] + - clientCorrelator: '0124' + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: 'zone02' + userEventCriteria: ["Transferring"] + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic' post: tags: - 'location' @@ -1353,13 +1353,13 @@ 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"] + examples: + - zonalTrafficSubscription: + clientCorrelator: '0123' + callbackReference: + notifyURL: 'http://my.callback.com/location_notifications/some-id' + zoneId: 'zone01' + userEventCriteria: ["Transferring"] responses: '201': description: 'Successful subscription' @@ -1370,14 +1370,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': @@ -1407,20 +1407,20 @@ paths: properties: zonalPresenceNotification: $ref: '#/components/schemas/ZonalPresenceNotification' - example: - zonalPresenceNotification: - clientCorrelator: '0123' - zoneId: 'zone01' - address: 'acr:10.0.0.1' - userEventType: 'Transferring' - currentAccessPointId: 'ap2' - previousAccessPointId: 'ap1' - timestamp: - seconds: 1483231138 - nanoseconds: 0 - link: - rel: ZonalTrafficSubscription - href: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123' + examples: + - zonalPresenceNotification: + clientCorrelator: '0123' + zoneId: 'zone01' + address: 'acr:10.0.0.1' + userEventType: 'Transferring' + currentAccessPointId: 'ap2' + previousAccessPointId: 'ap1' + timestamp: + seconds: 1483231138 + nanoseconds: 0 + link: + rel: ZonalTrafficSubscription + href: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123' responses: '204': $ref: '#/components/responses/204' @@ -1446,14 +1446,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': @@ -1483,14 +1483,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' parameters: - $ref: '#/components/parameters/Path.SubscrId' responses: @@ -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': @@ -1567,17 +1567,17 @@ paths: properties: notificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - example: - notificationSubscriptionList: - zoneStatusSubscription: - - clientCorrelator: '0123' - resourceURL: 'http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123' - callbackReference: - notifyURL: 'http://clientApp.example.com/location_notifications/123456' - zoneId: 'zone01' - numberOfUsersZoneThreshold: 500 - operationStatus: ['Serviceable'] - resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus' + examples: + - notificationSubscriptionList: + zoneStatusSubscription: + - clientCorrelator: '0123' + resourceURL: 'http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123' + callbackReference: + notifyURL: 'http://clientApp.example.com/location_notifications/123456' + zoneId: 'zone01' + numberOfUsersZoneThreshold: 500 + operationStatus: ['Serviceable'] + resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus' post: tags: - 'location' @@ -1594,14 +1594,14 @@ 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'] + examples: + - zoneStatusSubscription: + clientCorrelator: '0123' + callbackReference: + notifyURL: 'http://my.callback.com/location_notifications/some-id' + zoneId: 'zone01' + numberOfUsersZoneThreshold: 500 + operationStatus: ['Serviceable'] responses: '201': description: 'Successful subscription' @@ -1612,15 +1612,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': @@ -1650,20 +1650,20 @@ paths: properties: zoneStatusNotification: $ref: '#/components/schemas/ZoneStatusNotification' - example: - zoneStatusNotification: - clientCorrelator: '0123' - zoneId: 'zone01' - accessPointId: 'poa1' - operationStatus: 'Serviceable' - numberOfUsersInZone: '20' - numberOfUsersInAP: '12' - timestamp: - seconds: 1483231138 - nanoseconds: 0 - link: - rel: ZoneStatusSubscription - href: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123' + examples: + - zoneStatusNotification: + clientCorrelator: '0123' + zoneId: 'zone01' + accessPointId: 'poa1' + operationStatus: 'Serviceable' + numberOfUsersInZone: '20' + numberOfUsersInAP: '12' + timestamp: + seconds: 1483231138 + nanoseconds: 0 + link: + rel: ZoneStatusSubscription + href: 'http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123' responses: '204': $ref: '#/components/responses/204' @@ -1689,15 +1689,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': @@ -1727,15 +1727,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' parameters: - $ref: '#/components/parameters/Path.SubscrId' responses: @@ -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': @@ -1796,61 +1796,61 @@ paths: x-swagger-router-controller: 'subscriptions' components: responses: - 200: + '200': description: 'OK' - 204: + '204': description: 'No Content' - 400: + '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 401: + '401': description: 'Unauthorized : used when the client did not submit credentials.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 403: + '403': description: 'Forbidden : operation is not allowed given the current status of the resource.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 404: + '404': description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 406: + '406': description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 412: + '412': description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 414: + '414': description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 415: + '415': description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - 422: + '422': description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This @@ -1859,14 +1859,7 @@ 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 - 429: + '429': description: 'Too Many Requests : used when a rate limiter has triggered.' content: application/problem+json: diff --git a/README.md b/README.md index 4997e91b7b74fb2aaa150ada9a609b856a67d510..dbd9d0602ce2e425e6622031c30a1b847dbd0c44 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/v2.1.1/LocationAPI.yaml). +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/stf606-final/LocationAPI.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/stf606-final/LocationAPI.yaml). ## License