Skip to content

docs: improve info.description clarity in session-insights.yaml#80

Merged
benhepworth merged 6 commits intocamaraproject:mainfrom
mohdfarhanakram:fix/improve-description-clarity
Apr 8, 2026
Merged

docs: improve info.description clarity in session-insights.yaml#80
benhepworth merged 6 commits intocamaraproject:mainfrom
mohdfarhanakram:fix/improve-description-clarity

Conversation

@mohdfarhanakram
Copy link
Copy Markdown
Contributor

What type of PR is this?

correction

What this PR does / why we need it:

Improves the info.description and inline descriptions in session-insights.yaml to help API consumers understand the API correctly:

  • Changed "network operator" to "API provider" throughout (aligns with CAMARA terminology)
  • Changed "existing Application Profile" to "selected Application Profile" (obtained via GET application-profiles)
  • Removed unexpanded abbreviations: expanded RCA to "root cause analysis", WMM to "Wi-Fi Multimedia (WMM)"
  • Standardized "KPI metrics" to "KPIs" for consistency
  • Added "Session Identifiers" section clarifying the relationship between sessionId, id, and applicationSessionId
  • Added "Object Relationships" section describing cardinality (device → sessions, application → profiles)
  • Expanded the Authorization and Authentication section to explain how the device is linked to the API call via access token type
  • Expanded the error code section with common CAMARA error patterns and clearer guidance
  • Fixed leftover "QoS session" references to "Session Insights session" in RetrieveSessionsInput/Output

Which 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

Improved API descriptions for clarity: standardized terminology, expanded abbreviations, documented session identifiers and object relationships, and expanded authorization and error sections.

Additional documentation

N/A

Comment thread code/API_definitions/session-insights.yaml Outdated
@Kevsy
Copy link
Copy Markdown
Contributor

Kevsy commented Mar 23, 2026

Thanks @mohdfarhanakram , that's a really useful PR! One tiny suggestion made above, otherwise LGTM

Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Kevsy
Kevsy previously approved these changes Apr 1, 2026
Copy link
Copy Markdown
Contributor

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM

Copy link
Copy Markdown
Contributor

@benhepworth benhepworth left a comment

Choose a reason for hiding this comment

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

thanks for the PR! Looks great - just a few very minor suggestions.

Comment thread code/API_definitions/session-insights.yaml Outdated
Comment thread code/API_definitions/session-insights.yaml Outdated
Comment thread code/API_definitions/session-insights.yaml Outdated
Comment thread code/API_definitions/session-insights.yaml Outdated
Co-authored-by: Ben Hepworth <125334035+benhepworth@users.noreply.github.com>
mohdfarhanakram and others added 3 commits April 8, 2026 11:48
Co-authored-by: Ben Hepworth <125334035+benhepworth@users.noreply.github.com>
Co-authored-by: Ben Hepworth <125334035+benhepworth@users.noreply.github.com>
Co-authored-by: Ben Hepworth <125334035+benhepworth@users.noreply.github.com>
@mohdfarhanakram
Copy link
Copy Markdown
Contributor Author

Thanks @benhepworth and @Kevsy for the review and suggestions — applied them all.

@benhepworth benhepworth self-requested a review April 8, 2026 21:34
Copy link
Copy Markdown
Contributor

@benhepworth benhepworth left a comment

Choose a reason for hiding this comment

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

looks good now - thanks!

@benhepworth benhepworth merged commit fddfea1 into camaraproject:main Apr 8, 2026
2 checks passed
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.

Improve API YAML info.description documentation clarity

3 participants