Repository navigation
docs: scope qos-profiles description beyond Quality-On-Demand - #19
Merged
Merged
Conversation
hdamker
requested review from
benhepworth,
eric-murray and
jlurien
as code owners
September 11, 2026 14:35
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
The
qos-profilesAPI 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:qosProfileis also referenced byqos-booking,qos-booking-and-assignment, the Dedicated Networks APIs andnetwork-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.mdlink 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
Additional documentation