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

Make device attribute optional for explicit subscription requests #300

Open
shilpa-padgaonkar opened this issue Sep 11, 2024 · 3 comments
Open
Assignees
Labels
correction correction in documentation Spring25 subscriptions

Comments

@shilpa-padgaonkar
Copy link
Collaborator

Problem description
Most Camara APIs follow the guideline added in the design doc to make device object optional and identify the device using the access token when possible. This should also be extended for explicit subscription APIs.

Expected behavior
Make device object optional in subscriptionDetail.

Alternative solution

Additional context
Also will be relevant for #295

@shilpa-padgaonkar shilpa-padgaonkar added the correction correction in documentation label Sep 11, 2024
@jlurien
Copy link
Contributor

jlurien commented Sep 16, 2024

An enhancement to the guidelines should consider as well that if device is returned as part of the response, it should not reveal information not included in the response. Specifically, if device is not included in the request it must not be revealed in the response. This may be considered a separate issue, but this lack of clarification was the reason to keep device as required for the moment in some APIs (e.g. geofencing-subscriptions).

In QoD there is already a mention to this, which could be taken as example:

https://github.com/camaraproject/QualityOnDemand/blob/r1.2/code/API_definitions/quality-on-demand.yaml#L521

Note that the device object is defined as optional and will only to be returned if provided in createSession. If more than one type of device identifier was provided, only one identifier will be returned (at implementation choice and with the original value provided in createSession).

@patrice-conil
Copy link
Collaborator

Totally agree with @jlurien.

@jlurien
Copy link
Contributor

jlurien commented Sep 16, 2024

I see that there was already an issue opened for this last part: #295

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation Spring25 subscriptions
Projects
None yet
Development

No branches or pull requests

5 participants