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

Review Attribute Descriptions with References to External Specifc #286

Open
gmuratk opened this issue Apr 26, 2024 · 5 comments
Open

Review Attribute Descriptions with References to External Specifc #286

gmuratk opened this issue Apr 26, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation QoD-backlog

Comments

@gmuratk
Copy link

gmuratk commented Apr 26, 2024

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] (camaraproject/Commonalities#96)

Additional context

@gmuratk gmuratk added the documentation Improvements or additions to documentation label Apr 26, 2024
@hdamker hdamker added the Fall24 Relevant for maintenance of Fall24 release label May 3, 2024
@hdamker
Copy link
Collaborator

hdamker commented May 3, 2024

Will go potentially into backlog.

@hdamker
Copy link
Collaborator

hdamker commented Jul 12, 2024

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 hdamker added QoD-backlog and removed Fall24 Relevant for maintenance of Fall24 release labels Jul 12, 2024
@hdamker
Copy link
Collaborator

hdamker commented Oct 8, 2024

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

@RandyLevensalor
Copy link
Collaborator

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
Copy link
Collaborator

hdamker commented Oct 8, 2024

Looking on the original issue description above and camaraproject/Commonalities#96 (comment) 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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation QoD-backlog
Projects
None yet
Development

No branches or pull requests

3 participants