Create connected-network-type-subscriptions.yaml #171
Conversation
Review comments added
…network-type-subscriptions.yaml correcting the file name and making it plural
…ription Merging after approval
VijayKesharwani
requested review from
eric-murray,
bigludo7,
sachinvodafone and
akoshunyadi
as code owners
|
@camaraproject/device-status_codeowners I guess this can be moved together with #158 to the newly created https://github.com/camaraproject/DeviceQualityIndicator, do you agree? |
I think the quality indicator is something different. It will need different inputs, e.g. the network type, to provide a network quality indication. |
|
It is mentioned under quality indicator "Get insights about the network status of a defined mobile device." so I am not sure if it will have some other inputs other than mobile device. |
|
@VijayKesharwani Let's keep this subscription API in sync with the non-subscription one in #158. There there was a change in the enums. As soon as we have an approval there this PR should be updated. Thanks. |
There was a problem hiding this comment.
Thanks !
In order to mix ourselves could you add in the yaml the commonalities reference.
In this case add a line btw 61 & 62 to add
x-camara-commonalities: 0.4.0
cc: @akoshunyadi
| description: | | ||
| network-type-changed - Event triggered when the connected network type of the device changes. | ||
| enum: | ||
| - org.camaraproject.connected-network-type-subscriptions.v0.network-type-changed |
There was a problem hiding this comment.
We need the subscription-ends event here and the corresponding description in info.description
Added subscription-ends event
| Following event ``type`` are managed for this API: | ||
| - ``org.camaraproject.connected-network-type-subscriptions.v0.network-type-changed``: This event is triggered when the connected network type of the device changes. | ||
|
|
||
| Note: Additionally, the event `org.camaraproject.connected-network-type-subscriptions.v0.subscription-ends` is sent when the subscription ends. This notification does not require a dedicated subscription. |
There was a problem hiding this comment.
A detailed description of the cases when this subscription-ends event if fired is missing:
It is used in following cases:
- the subscription expire time (optionally set by the requester) has been reached
- the maximum number of subscription events (optionally set by the requester) has been reached
- the subscription was deleted by the requester
- the Access Token sinkCredential (optionally set by the requester) expiration time has been reached
- the API server has to stop sending notification prematurely
| schema: | ||
| $ref: "#/components/schemas/ErrorInfo" | ||
| examples: | ||
| Generic400: |
There was a problem hiding this comment.
That looks strange: the specific type SubscriptionIdRequired has an example Generic400
Maybe we could have 2x 400 error types: CreateSubsciptionBadRequest400 and Generic400 for all other cases like e.g. in roaming status subscription
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
(#143)
Which issue(s) this PR fixes:
(#143)
Fixes #
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.