camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
41 stars 59 forks source link

Extend the query capabilities for Qos Profiles #147

Open RandyLevensalor opened 1 year ago

RandyLevensalor commented 1 year ago

Problem description The initial implementation of the Get /qos-profiles: endpoint is fairly simple. Developers will want a richer solution to find the appropriate profile.

Possible evolution There are several methods to achieve this. One or more can be implemented.

  1. Extend the current query parameters to allow for comparison operators =,<,>,>=, or <= that would follow the commonalities guidelines. For instance .gt= would return all profiles where attribute is larger than the given value.
  2. Serialize complex types, such as Rate to be a comma delimited string. For example "10,Mbps" could be used to signify a rate of 10Mbps. For Duration 10,ms would denote 10 milliseconds.
  3. Not all profiles will be available for a given device or user. For instance users may not be entitled to the servers based on their current plan or the access network is not capable of providing certain levels of service. For this we can add device and flow identifiers to the query. These would follow the same format used to identify devices in theCreateSession: schema.

Alternative solution A json string could be passed instead of a comma delimited complex query parameter.

Additional context This functionality was remove from the 0.9.0 release in order to provide additional time to discuss and design this endpoint.

hdamker commented 1 year ago

Moved to backlog, as it won't be part of v0.9.0

chrishowell commented 1 year ago

Are we going to standardise the list of QoS profiles across CSPs? It's going to be an absolute nightmare for ASPs if not.