docs: improve info.description clarity in session-insights.yaml#80
Open
mohdfarhanakram wants to merge 1 commit intocamaraproject:mainfrom
Open
docs: improve info.description clarity in session-insights.yaml#80mohdfarhanakram wants to merge 1 commit intocamaraproject:mainfrom
mohdfarhanakram wants to merge 1 commit intocamaraproject:mainfrom
Conversation
Kevsy
reviewed
Mar 23, 2026
| - Create a monitoring session using an existing Application Profile. | ||
| - Send application-level KPIs (e.g., latency, jitter, throughput, loss) to the network operator. | ||
| - Receive a Session Insights Score reflecting network-evaluated session quality. | ||
| - Create a monitoring session using a selected Application Profile (obtained via GET application-profiles). |
Contributor
There was a problem hiding this comment.
Suggested change
| - Create a monitoring session using a selected Application Profile (obtained via GET application-profiles). | |
| - Create a monitoring session using a selected Application Profile identifier (obtained via GET application-profiles). |
Contributor
|
Thanks @mohdfarhanakram , that's a really useful PR! One tiny suggestion made above, otherwise LGTM |
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?
correction
What this PR does / why we need it:
Improves the
info.descriptionand inline descriptions insession-insights.yamlto help API consumers understand the API correctly:sessionId,id, andapplicationSessionIdWhich issue(s) this PR fixes:
Fixes #68
Special notes for reviewers:
Documentation and description changes only — no structural or functional changes to the API. All updates follow the changes listed in the issue.
Changelog input
Additional documentation
N/A