Update info.description

[eric-murray]

Purpose:

• documentation

What this PR does / why we need it:

Updates info.description with:

• New Commonalities template for User identification
• Add section on multi-SIM scenario handling

Which issue(s) this PR fixes:

Fixes #None
But helps with #212 and #222

Special notes for reviewers:

Will need to revisit once multi-SIM scenario handling is standardised

Changelog input

 release-note
 - Update info.description section for user identification and multi-SIM scenario handling

Additional documentation

None

[bigludo7]

Look good for me. Indeed the multi-SIM could be updated later.

[eric-murray]

I updated all YAMLs with text on multi-SIM scenario handling, and also the "identifying the device from the token" text for the device roaming API.

I had a question on identifying the device for the subscription APIs. Currently device is a required parameter of the Subscription Request. So does this mean that subscriptions can only be created with a 2-legged token? Or should device actually be optional?

[eric-murray]

@camaraproject/device-status_maintainers
info.description now updated for all APIs, and ready for review

@bigludo7
My question in the comment above is still open. Is it correct that a device identifier is required to create a subscription? If so, what are the rules when a 3-legged token is used to create the subscription?

[bigludo7]

Hi @eric-murray

Is it correct that a device identifier is required to create a subscription?

At least yes for the subscriptions for device status or for geofencing.

If so, what are the rules when a 3-legged token is used to create the subscription?

We have specified in the design guideline that: "If 3-legged access token is used, the POST and GET responses must not provide any device identifier.". Which mean that, like for non subscription API, we did not accept an identifier in the subscription body when we find the identifier from the token.

in the event-subscription-template.yaml you find the 422 UNNECESSARY_IDENTIFIE error specified.

[eric-murray]

@bigludo7
But if an explicit device identifier is always required, does that not prevent a 3-legged token from being used to create a subscription (because that will trigger the 422 UNNECESSARY_IDENTIFIER error)?

In any case, I raised the issue explicitly in Issue #241. If it is correct that an explicit device identifier is always required, I'd like to understand the 3-legged token scenario for the documentation.

[akoshunyadi]

@bigludo7 @sachinvodafone Are you OK with this PR?

[bigludo7]

@bigludo7 @sachinvodafone Are you OK with this PR?

Hi @akoshunyadi - Yes - We can continue the discussion with @eric-murray in #241

[bigludo7]

LGTM