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

[Device-Roaming-Subscription]: The example for a sub - initialEvent and error is wrong #209

Closed
dfischer-tech opened this issue Sep 22, 2024 · 0 comments · Fixed by #210
Closed

Comments

@dfischer-tech
Copy link
Contributor

dfischer-tech commented Sep 22, 2024

Problem description
The example for a sub - initialEvent is wrong - it shows a reachability example

initialEvent:
  type: boolean
  description: |
     Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request.
     Example: Consumer subscribes to reachability SMS. If consumer sets initialEvent to true and device is already reachable by SMS, an event is triggered.

Expected behavior
Corrected version

initialEvent:
  type: boolean
  description: |
     Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request.
     Example: Consumer subscribes to roaming-on. If consumer sets initialEvent to true and the device is already roaming-on, an event is triggered.

and...
The example for CreateSubscriptionUnprocessableEntity422 - MultieventSubscriptionNotSupported instead of PermissionDenied.

MultieventSubscriptionNotSupported:
  value:
    status: 422
      code: MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED
      message: Multi event types subscription not managed

BTW: same 2nd issue in [Device Reachability Status Subscriptions]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant