Operation to get qos-profiles for a device MUST use a verb and needs a security object #345
Labels
correction
correction in documentation or alignment with commonalities
Fall24
Relevant for maintenance of Fall24 release
Problem description
The POST operation
qosProfilesDevice
in qos-profiles does not create a resource but retrieves an array ofqosProfile
.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
qosProfilesDevice
operation with a verb, proposal isretrieve-qos-profiles
and adapt the operationId accordingly, e.g.retrieveQoSProfilesByDevice
Alternative solution
Additional context
Compare with comments #325 (comment)
We have
retrieve-sessions
andretrieve-device-qos
, soretrieve-qos-profiles
makes most sense.The text was updated successfully, but these errors were encountered: