DeviceDataVolume r1.2 (Fall25 M3, new API) release review #240
Description
Release PR to review
Related release tracker pages in wiki
- https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/48857206/device-data-volume+0.1.0
- https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/116719682/device-data-volume-subscriptions+0.1.0
Review actions
Assign this issue to yourself and follow the below list.
For any review action, review the file(s) in the issue/PR listed above.
Put comments in the above issue or PR if they concern non-changed files/text.
Put a short summary of the main review result as a comment here into the review issue.
- API definition files updated (YAML) (version in info & servers objects, check for links into main or older releases)
- test definition file(s) (availability, version infos and resource URLs)
- changelog updated (structure in line with template, for public release all changes since last public release must be listed, Commonalities & ICM release candidates referred)
- readme updated (correct naming "pre-release" and release number, API versions naming, alignment with template)
- API readiness checklist(s) (check link to Commonalities and ICM r3.2)
- API description (ensure that the API readiness checklists have been updated with the additional line for the API Description and contains the link to the current API descriptions)
Specific checks for alignment with Commonalities r3.2:
See Analysis here: https://lf-camaraproject.atlassian.net/wiki/x/AYDhBw
- Remove the 401 AUTHENTICATION_REQUIRED code - also in notification APIs and test files
- Mandatory text on non-documented error responses
- remove IDENTIFIER_MISMATCH error and add DeviceResponse object (when Device object is used in the request) - also in notification APIs and test files```
- Mandatory text proposed when duration string format is used
- x-correlator (header & parameter) referencing XCorrelator schema with updated string pattern (^[a-zA-Z0-9-_:;./<>{}]{0,256}$). Also check this update in subscription APIs and in Test files
- check in test files that the Background section line on x-correlator is updated to refer to the XCorrelator schema
For Subscription APIs:
- Update example section of Generic401 definition as per lines 245-250 in notification-as-cloud-event.yaml (add in 245; "and a new authentication is required" and in 250: "250: "A new authentication is required."
- Update types property of SubscriptionRequest to allow more than one event type per subscription (optional)
- Update types property of SubscriptionRequest to use SubscriptionEventType schema (enum of defined types)
- 3.2 subscription-started event (optional event)
- 3.3 subscription-updated event (optional event)
- 3.4 subscription-ends --> subscription-ended (event name change)
- Add sink pattern and specific 400 - INVALID_SINK error
Release actions
Assign this issue to yourself or another RM team member and follow the below list.
When done, tick the box in this issue (requires write access, leave a comment otherwise).
- Short link to release review issue added to release trackers ("M3 #nnn")
- Review comments provided (on behalf of Release Management)
- Review comments addressed (by release PR editor)
- Release PR approved (on behalf of Release Management)
- PR merged (by API repository codeowner)
- Release created within GitHub (by API repository codeowner)
- Release Tracker updated (with creation date of the release and the release tag link)
(Note: for pre-releases there is no update needed of website and other places. For public releases within Fall25 M4 the updates of GitHub README, CAMARA website and within API Backlog list will be done in batch as part of M5 milestone.)
Additional comments