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

Operation to get qos-profiles for a device MUST use a verb and needs a security object #345

Closed
hdamker opened this issue Aug 13, 2024 · 2 comments · Fixed by cablelabs/QualityOnDemand#7 or #348
Assignees
Labels
correction correction in documentation or alignment with commonalities Fall24 Relevant for maintenance of Fall24 release

Comments

@hdamker
Copy link
Collaborator

hdamker commented Aug 13, 2024

Problem description

The POST operation qosProfilesDevice in qos-profiles does not create a resource but retrieves an array of qosProfile.
According to https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#post-or-get-for-transferring-sensitive-or-complex-data the resource in the path MUST be a verb (e.g. retrieve-qos-profiles, see additional context).

Expected behavior

  1. Rename the resource within the path of qosProfilesDevice operation with a verb, proposal is retrieve-qos-profiles and adapt the operationId accordingly, e.g. retrieveQoSProfilesByDevice
  2. Add an appropriate security requirements object, with the scope name according to https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#1161-scope-naming
      security:
        - openId:
            - qos-profiles:<verb>

Alternative solution

Additional context

Compare with comments #325 (comment)
We have retrieve-sessions and retrieve-device-qos, so retrieve-qos-profiles makes most sense.

@hdamker hdamker added the correction correction in documentation or alignment with commonalities label Aug 13, 2024
@hdamker
Copy link
Collaborator Author

hdamker commented Aug 13, 2024

@RandyLevensalor

@hdamker hdamker changed the title Operation to get sos-profiles for a device MUST use a verb and needs a security object Operation to get qos-profiles for a device MUST use a verb and needs a security object Aug 13, 2024
@RandyLevensalor
Copy link
Collaborator

I can create a PR to address this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation or alignment with commonalities Fall24 Relevant for maintenance of Fall24 release
Projects
None yet
2 participants