search

camaraproject / QualityOnDemand

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

Review Attribute Descriptions with References to External Specifc #286

Open gmuratk opened 6 months ago

gmuratk commented 6 months ago

Problem description

Some attributes have references to 3GPP Technical Specifications, which need checking for accuracy.
For example, targetMinUpstreamRate has the description as "For 5G networks 3GPP Guaranteed Bit Rate (GBR) refers to a dedicated, fixed data rate assigned to specific services, ensuring a minimum performance level. As per 3GPP TS 23.203..."
I believe the intent is to cover both 4G and 5G and that 23.203 is applicable to 3G/4G and 23.503 is applicable to 5G.

Expected action

I'd suggest first confirming there is benefit to API consumers for providing these references and if confirmed, then review the descriptions and update if necessary. Also, consider providing an earliest release support information. [SDO Reference issue in Commonalities] (https://github.com/camaraproject/Commonalities/issues/96)

Additional context

hdamker commented 6 months ago

Will go potentially into backlog.

hdamker commented 3 months ago

quality-on-demand.yaml has one reference behind "Network Access Identifier" [5]](#5) which isn't resolved. Given the fact that the NAI won't be used according to Commonalities v0.4.0 I proposed to delete this reference for v0.11.0.

hdamker commented 4 weeks ago

Do we have here open points, e.g. in qos-profiles (@RandyLevensalor)? Or can this issue get closed?

RandyLevensalor commented 4 weeks ago

Do we have here open points, e.g. in qos-profiles (@RandyLevensalor)? Or can this issue get closed?

I think that we're ok in qos-profiles. We have the reference in there with a similar note as the qod api.

https://github.com/camaraproject/QualityOnDemand/blob/8ab9c53d1a8231685beff3e41bd0cb67daa7bd8e/code/API_definitions/qos-profiles.yaml#L441C1-L443C1

We also have the note:

        NOTE2: for the Commonalities release v0.4, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines.
hdamker commented 4 weeks ago

Looking on the original issue description above and https://github.com/camaraproject/Commonalities/issues/96#issuecomment-2093268618 we need to review the references to "3GPP TS 23.203" (do we need to mention TS 23.503 as well?) and potentially "DOCSIS 3.1 - MAC and Upper Layer Protocols Interface Specification"