Review the APIs which are targeting "stable" maturity in the Fall24 meta-release

[tanjadegroot]

Problem description
Review the stable APIs and their compliance to Commonalities, especially on topics beyond the basis checks, such as API abuse topic, common data types usage, or other.
Request following TSC meeting of 2024-08-01.

Expected action
Review the 5 APIs targeting stable public release. The APIs are here: see https://wiki.camaraproject.org/x/cgB0AQ (click twice on the targeted maturity column to sort the table with stable APIs at the top of the list).

• if you have a comment: create an issue in the Sub Project: "Commonalities review" and link it to the review issue in release management for that Sub Project repo
• if you have no comments: put a comment "Reviewed by Commonalities" in the review issue in release management for that Sub Project repo.

Additional actions:
Please complete the RM release PR review guidelines for items that are not listed there (see link below).
Also create a Commonalities issues if you see that additional linting rules can be created to automate the checks (e.g. a check that schemas are aligned with Commonalities common_data.md

Additional context
Current checks done by the RM team are described here: https://wiki.camaraproject.org/x/UwESAg

[hdamker]

• if you have no comments: put a comment "Reviewed by Commonalities" in the review issue in release management for that Sub Project repo.

The review issue for M3 (release candidates) are already closed, there will be new ones for the M4 release PRs. Therefore: please do your review based on the pre-releases and add your comments preliminary here (cf. [IdentityAndConsentManagement](camaraproject/IdentityAndConsentManagement#189 as example). We will pick the results in course of the reviews of M4 release PRs.

[PedroDiez]

Will be reviewing 3 APIs:

• SIM-SWAP
• OTP Validaton
• Location Verification

[PedroDiez]

Commonalities Review - Sim Swap - sim-swap v1.0.0

Ref: https://github.com/camaraproject/SimSwap/releases/tag/r1.1

• API definition files (YAML) review

• [OK] Actions taken
  Info object: remove contact and termsOfService - SIM-SWAP#143
  NOTES for public Release:

• Adapt servers object and version property for public release
• Consider 401 AUTHENTICATION_REQUIRED exception

• test file(s) availability

• [OK]
  https://github.com/camaraproject/SimSwap/tree/main/code/Test_definitions

• changelog updated

• [OK]. Consider the update actions for public release

• readme updated (enforce correct release number / API version naming)

• [OK]. Consider the update actions for public release

• API readiness checklist(s)

• [OK]

cc @fernandopradocabrillo, @bigludo7

[PedroDiez]

Commonalities Review - OTP Validation - one-time-password-sms v1.0.0

Ref: https://github.com/camaraproject/OTPValidation/releases/tag/r1.1

• API definition files (YAML) review

• [OK] NOTES for public Release:

• Adapt servers object and version property for public release
• Consider 401 AUTHENTICATION_REQUIRED exception

• test file(s) availability

• [OK] NOTES for public Release:
  Indication of version in test file "Title" Feature: CAMARA OTPvalidationAPI, v:wip

• changelog updated

• [OK]. Consider the update actions for public release

• readme updated (enforce correct release number / API version naming)

• [OK]. Consider the update actions for public release. NOTE in README.md only latest release should appear

• API readiness checklist(s)

• [NOK] Please for public release review format and also update checklist (some checks are required for public release) https://github.com/camaraproject/OTPValidation/blob/r1.1/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md

cc @fernandopradocabrillo @bigludo7

[PedroDiez]

Commonalities Review - Device Location - location-verification v1.0.0

Ref: https://github.com/camaraproject/DeviceLocation/releases/tag/r1.1

• API definition files (YAML) review

• [OK] NOTES for public Release:
• Adapt servers object and version property for public release

• test file(s) availability

• [OK]

• changelog updated

• [OK]. Consider the update actions for public release

• readme updated (enforce correct release number / API version naming)

• [OK]. Consider the update actions for public release

• API readiness checklist(s)

• [NOK] Please move for public release User stories to "documentation/API_documentation" folder and also update API readiness checkllist (Nr 6)

cc @jlurien, @bigludo7, @maxl2287

[rartych]

Commonalities Review - Number Verification - number_verification v1.0.0

camaraproject/NumberVerification#139

• API definition files (YAML) review

• [OK] In the path: section there is X-Correlator, the guideline was changed to use x-correlator (lower case) Public Release for Fall24 meta-release NumberVerification#139 (comment) - FIXED

• test file(s) availability

• [OK] resolved Test definitions - linting results NumberVerification#143

• changelog updated

• [OK] Should the X-Correlator correction be added?

• readme updated (enforce correct release number / API version naming)

• [OK]

• API readiness checklist(s)

[rartych]

Commonalities Review - Simple Edge Discovery - simple-edge-discovery v1.0.0

camaraproject/SimpleEdgeDiscovery#41

• API definition files (YAML) review

• [OK] - small edits completed

• test file(s) availability

• [OK] License text removed
  https://github.com/camaraproject/SimpleEdgeDiscovery/blob/93554d97fc83ac6f37438186c6b3496d413a01a4/code/Test_definitions/simple-edge-discovery.feature#L1-L20

• changelog updated

• readme updated (enforce correct release number / API version naming)

• API readiness checklist(s)

[rartych]

Commonalities Review - of test definitions
see:

• Add Gherkin Linting to Megalinter Workflow and Update Implementation #292

• OTP Validation:

  • Test definitions - linting results OTPValidation#82

• SimSwap

  • Test definitions - linting results  SimSwap#149

• Location Verification

  • Test definitions - linting results for location-verification DeviceLocation#253

• Number Verification

  • Test definitions - linting results NumberVerification#143

• Simple Edge Discovery

  • No linting issues

[jlurien]

Commonalities Review - Number Verification - number_verification v1.0.0

camaraproject/NumberVerification#139

• API definition files (YAML) review

• [OK] In the path: section there is X-Correlator, the guideline was changed to use x-correlator (lower case) Public Release for Fall24 meta-release NumberVerification#139 (comment)

@rartych could you please formally update the checklist above, as it seems that issue is resolved. Thanks

[rartych]

As the meta-release is published the issues can be closed