Skip to content

fix: add missing security schemes to session-insights API#82

Merged
benhepworth merged 2 commits intocamaraproject:mainfrom
mohdfarhanakram:fix/add-security-schemes
Apr 8, 2026
Merged

fix: add missing security schemes to session-insights API#82
benhepworth merged 2 commits intocamaraproject:mainfrom
mohdfarhanakram:fix/add-security-schemes

Conversation

@mohdfarhanakram
Copy link
Copy Markdown
Contributor

What type of PR is this?

correction

What this PR does / why we need it:

Adds the missing OpenID Connect security schemes and per-operation scopes to session-insights.yaml as required by CAMARA Commonalities r3.2. This was flagged as a blocker for the Fall25 release.

  • Added securitySchemes (openId / openIdConnect) under components
  • Added security field with scoped permissions to all 5 operations:
    • POST /sessionssession-insights:sessions:create
    • GET /sessions/{sessionId}session-insights:sessions:read
    • DELETE /sessions/{sessionId}session-insights:sessions:delete
    • POST /retrieve-sessionssession-insights:sessions:retrieve-by-device
    • POST /sessions/{sessionId}/metricssession-insights:sessions:send-metrics
  • Replaced custom auth text with the mandatory ICM authorization template in info.description
  • Fixed placeholder [ device | phone number ](*) to device

Which issue(s) this PR fixes:

Fixes #69

Special notes for reviewers:

The notificationsBearerAuth scheme for sink/notification security is not included in this PR — the current YAML does not define a notification callback path, so adding it may be out of scope for this issue. Happy to add it if reviewers think it should be included here.

Changelog input

Added OpenID Connect security schemes and per-operation scopes. Included mandatory ICM authorization template in API description.

Additional documentation

N/A

Add OpenID Connect security schemes and per-operation scopes as
required by CAMARA Commonalities r3.2. Include the mandatory ICM
authorization template in info.description.

Resolves camaraproject#69
benhepworth
benhepworth previously approved these changes Apr 7, 2026
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 to me

@benhepworth benhepworth merged commit b1a9d43 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.

Add missing security schemes to API YAML

2 participants