Skip to content

docs: consolidate CQM API introduction structure#11

Open
albertoramosmonagas wants to merge 7 commits into
mainfrom
edits-260624
Open

docs: consolidate CQM API introduction structure#11
albertoramosmonagas wants to merge 7 commits into
mainfrom
edits-260624

Conversation

@albertoramosmonagas

Copy link
Copy Markdown
Contributor

What type of PR is this?

Add one of the following kinds:

  • cleanup
  • documentation

What this PR does / why we need it:

Clean up the CQM API introduction document to make it more suitable for an external API consumer audience.

Key changes:

  • remove duplicated sections, tables and legacy draft content;
  • resolve and remove remaining Editor's Notes from the document body;
  • consolidate the core CQM concepts into a single plain-language section;
  • clarify the terminology around connectivity quality, connectivity performance characteristics and service-availability outcomes;
  • separate scope and portfolio grouping from the API deep dives;
  • reorder the API deep dives so discovery/support APIs are introduced first;
  • simplify the live-event journey and avoid turning it into a prescriptive API selection guide;
  • move GSMA use-case references to an appendix and replace the API applicability matrix with explanatory use-case references;
  • clarify that dedicated-network-areas is treated as a preview service-area discovery capability;
  • consolidate the comparative matrix, key takeaways, guardrails and source notes.

The resulting document keeps the focus on portfolio explanation rather than internal WG alignment, YAML details or CSP implementation guidance.

Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
albertoramosmonagas and others added 3 commits June 22, 2026 16:11
Commit changes from wording from @tlohmar

Co-authored-by: tlohmar <Thorsten.Lohmar@ericsson.com>
Addition to clarify the meaning of Reservation APIs

Co-authored-by: tlohmar <Thorsten.Lohmar@ericsson.com>

A detailed mapping between GSMA use cases and potentially applicable CQM APIs may be maintained separately as internal analysis. It is intentionally not included in this external-facing document.

### Appendix B — Related CAMARA Communication Quality APIs outside this document’s scope

@albertoramosmonagas albertoramosmonagas Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Adding this appendix to address the TSC feedback asking for at least some context on related CAMARA APIs outside the main Connectivity Quality Management scope.

The intent is not to expand the scope of this whitepaper or turn it into a full Communication Quality API comparison. The main body of the document remains focused on the CQM portfolio: qos-profiles, quality-on-demand, qos-provisioning, qos-booking, qos-booking-and-assignment, and the Dedicated Networks API family.

However, the CAMARA API overview also lists other APIs under the broader Communication Quality area, such as Application Profiles, Connectivity Insights, Predictive Connectivity Data, Session Insights, and Network Slice APIs. Since some readers may see those APIs next to the CQM APIs in CAMARA public material, it is useful to briefly clarify how they relate and why they are not covered in depth here.

This appendix should therefore be read as a scope-boundary clarification, not as a normative API selection guide or as an attempt to compare all Communication Quality APIs.

See this commit change to only see 26c7d3d the related changes

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.

Yes, the request make sense.

However, we have not worked with the other APIs and may not reflect their intentions correctly. Maybe better to just list / link these APIs.
Do we know, whether there are more Connectivity Quality APIs coming with the Sync26 Meta Release?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't have a strong opinion on this. All I did was feed the AI ​​with the marketing descriptions that the groups had previously uploaded. So, if the source is truly good, I assume this is too? But I'm open to all kinds of suggestions and opinions at this point.

Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Comment thread documentation/SupportingDocuments/CQM API Introduction.md Outdated
Co-authored-by: Alberto Ramos Monagas <alberto.ramosmonagas@telefonica.com>
Co-authored-by: tlohmar <Thorsten.Lohmar@ericsson.com>
Co-authored-by: tlohmar <Thorsten.Lohmar@ericsson.com>
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