Conversation
|
@bigludo7 changed |
tanjadegroot
left a comment
There was a problem hiding this comment.
There are 3 minor correction, with those implemented this API is OK for release
/LGTM from Release Management
documentation/API_documentation/device-swap-API-Readiness-Checklist.md
Outdated
Show resolved
Hide resolved
documentation/API_documentation/device-swap-API-Readiness-Checklist.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>
…klist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>
…klist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
|
Hello @jgarciahospital & @tanjadegroot - May I ask final review & approval then I will merge this one. |
tanjadegroot
left a comment
There was a problem hiding this comment.
The automated review found a few thing to tweek.
- please add the missing externalDocs and summary items.
- for the test filename changes I leave it to you
with that you have /LGTM from Release Management
There was a problem hiding this comment.
I run the automated check and it found the following points:
CAMARA API Review Report
Generated: 2025-07-16 00:07:01
Commonalities Version: 0.6
Repository: DeviceSwap
Issue or PR Number: 0
Executive Summary
- APIs Reviewed: 1
- Critical Issues: 1
- Medium Issues: 6
- Low Issues: 2
- Multi-file Consistency: ⏭️ Skipped (single file)
- Test Alignment: ✅ Checked
API Types Detected
- Regular API: 1
Individual API Analysis
device-swap v1.0.0-rc.1
File: device-swap.yaml
Type: Regular API
Issues Found
🔴 Critical: ExternalDocs
- Description: Missing externalDocs object
- Location:
externalDocs - Fix: Add externalDocs with description and url
🟡 Medium: Operation
- Description: Missing summary
- Location:
POST /retrieve-date
🟡 Medium: Operation
- Description: Missing summary
- Location:
POST /check
these should be easy to fix before merging
There was a problem hiding this comment.
Missing alignment to recommended Commonalities guidelines for feature filenames to use operationId name ( in this case) was flagged by the automated review: could be fixed later but if you change the file names, don't forget to update the links in the API readiness checklist - items 7 and 8 and to update the CHANGELOG as well
Test Alignment Analysis
Tests for device-swap
Test Files Found:
device-swap-retrieve-date.featuredevice-swap-check.feature
Test Issues
🔵 Low: Test File Naming
- Description: Test file suggests operation
retrieve-datebut it doesn't exist in API - Location:
/home/runner/work/ReleaseManagement/ReleaseManagement/target-repo/code/Test_definitions/device-swap-retrieve-date.feature - Fix: Check if test file naming is as intended, consider to use valid operation from:
retrieveDeviceSwapDate, checkDeviceSwap
🔵 Low: Test File Naming
- Description: Test file suggests operation
checkbut it doesn't exist in API - Location:
/home/runner/work/ReleaseManagement/ReleaseManagement/target-repo/code/Test_definitions/device-swap-check.feature - Fix: Check if test file naming is as intended, consider to use valid operation from:
retrieveDeviceSwapDate, checkDeviceSwap
51c2f8a
|
Thanks @tanjadegroot for the review- I ve added the externalDoc, added summary & changed the feature files. |
tanjadegroot
left a comment
There was a problem hiding this comment.
\LGTM from Release Management
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #42
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.