Skip to content

docs: scope qos-profiles description beyond Quality-On-Demand - #19

Merged
benhepworth merged 1 commit into
camaraproject:mainfrom
hdamker:docs/scope-beyond-qod
Sep 18, 2026
Merged

benhepworth merged 1 commit into
camaraproject:mainfrom
hdamker:docs/scope-beyond-qod

Conversation

@hdamker

@hdamker hdamker commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

The qos-profiles API description states that QoS profiles are used "when used by the Quality-On-Demand APIs" and "in conjunction with other Quality-On-Demand APIs". Both understate the scope: qosProfile is also referenced by qos-booking, qos-booking-and-assignment, the Dedicated Networks APIs and network-slice-booking / network-slice-assignment.

Aligns the two sentences with this repository's own README, which already states "QoS profiles are used in conjunction with APIs in QualityOnDemand, QoSBooking, DedicatedNetworks, and NetworkSliceBooking".

Also drops from the second sentence the description of what a profile applies to, since it named application data flows between a client and an application server — accurate for quality-on-demand, but not for the Dedicated Networks or booking APIs, which apply a profile at device level. What a profile is applied to is now stated once, as being determined by the API that references it.

Which issue(s) this PR fixes:

None — small documentation correction.

Special notes for reviewers:

The QoSProfile_Mapping_Table.md link is left pointing at QualityOnDemand, where the file still is. Whether it should follow the API into this repository is a separate question.

Changelog input

 release-note
- Corrected the `qos-profiles` description, which scoped the API to Quality-On-Demand only.

Additional documentation

docs

@benhepworth benhepworth left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@benhepworth
benhepworth merged commit 7e7d711 into camaraproject:main Sep 18, 2026
2 checks passed
@hdamker
hdamker deleted the docs/scope-beyond-qod branch September 18, 2026 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants