Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add handling when the requested geofence area cannot be covered #224

10 changes: 6 additions & 4 deletions code/API_definitions/geofencing-subscriptions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ paths:
$ref: "#/components/examples/CIRCLE_AREA_LEFT"
SUBSCRIPTION_ENDS:
$ref: "#/components/examples/SUBSCRIPTION_ENDS"
SUBSCRIPTION_UNPROCESSABLE:
$ref: "#/components/examples/SUBSCRIPTION_UNPROCESSABLE"
responses:
"204":
description: Successful notification
Expand Down Expand Up @@ -923,15 +925,15 @@ components:
type: string
description: |
- NETWORK_TERMINATED - API server stopped sending notification
- SUBSCRIPTION_CREATION_ABORTED - Subscription cannot be created because the specified area cannot be managed (for asynchronous subscription creation)
- SUBSCRIPTION_UNPROCESSABLE - Subscription cannot be processed because the specified area cannot be managed (for asynchronous subscription creation)
maxl2287 marked this conversation as resolved.
Show resolved Hide resolved
- SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached
- SUBSCRIPTION_DELETED - Subscription was deleted by the requester
- MAX_EVENTS_REACHED - Maximum number of events (optionally set by the requester) has been reached
- ACCESS_TOKEN_EXPIRED - Access Token sinkCredential (optionally set by the requester) expiration time has been reached
enum:
- MAX_EVENTS_REACHED
- NETWORK_TERMINATED
- SUBSCRIPTION_CREATION_ABORTED
- SUBSCRIPTION_UNPROCESSABLE
- SUBSCRIPTION_EXPIRED
- SUBSCRIPTION_DELETED
- ACCESS_TOKEN_EXPIRED
Expand Down Expand Up @@ -1380,7 +1382,7 @@ components:
radius: 2000
terminationReason: SUBSCRIPTION_EXPIRED

SUBSCRIPTION_CREATION_ABORTED:
SUBSCRIPTION_UNPROCESSABLE:
description: The cloud event when the subscription process was aborted.
value:
id: "123655"
Expand All @@ -1398,5 +1400,5 @@ components:
latitude: 50.735851
longitude: 7.10066
radius: 2000
terminationReason: SUBSCRIPTION_CREATION_ABORTED
terminationReason: SUBSCRIPTION_UNPROCESSABLE
terminationDescription: The requested area cannot be covered by the network.