Release r3.2 (Fall25 M4)

CHANGELOG.md

@@ -3,6 +3,7 @@
 
 ## Table of contents
 
+- **[r3.2](#r32)**
 - **[r3.1](#r31)**
 - **[r2.3](#r23)**
 - **[r2.2](#r22)**
@@ -13,6 +14,47 @@
 
 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
 
+# r3.2
+
+## Release Notes
+
+This release contains the definition and documentation of
+
+* one-time-password-sms 1.1.1
+
+
+The API definition(s) are based on
+* Commonalities v0.6.0 (r3.3)
+* Identity and Consent Management v0.4.0 (r3.3)
+
+## one-time-password-sms 1.1.1
+
+This is the **release** of the one-time-password-sms API version 1.1.1. 
+
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r3.2/code/API_definitions/one-time-password-sms.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r3.2/code/API_definitions/one-time-password-sms.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/OTPValidation/blob/r3.2/code/API_definitions/one-time-password-sms.yaml)
+
+In the following there is the list of the modifications with respect to the previous release r2.3.
+
+### Added
+N/A
+
+### Changed
+- Align x-correlator definition with Commonalities 0.6.0, changed pattern and example (no change for the consumer): https://github.com/camaraproject/OTPValidation/pull/111
+- Align attribute description for code and description in the ErrorInfo schema (no change for the consumer): https://github.com/camaraproject/OTPValidation/pull/115
+- Cosmetic change for the feature files (no change for the consumer): https://github.com/camaraproject/OTPValidation/pull/116
+
+### Fixed
+N/A
+
+
+### Removed
+N/A
+
+**Full Changelog**: https://github.com/camaraproject/OTPValidation/compare/r2.3...r3.1
 
 # r3.1
 
@@ -323,3 +365,6 @@ This version contains significant changes compared to v0.5.0, and it is not back
 ### Removed
 
 * n/a
+
+
+

README.md

@@ -33,12 +33,12 @@ This process ensures secure, real-time validation of user possession of the spec
 ## Release information
 
 * Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
-* `NEW`: Pre-release r3.1 with version 1.1.1-rc.3 of the API one-time-password-sms is available [here](https://github.com/camaraproject/OTPvalidation/tree/r3.1)
+* `NEW`: Release r3.2 with version 1.1.1 of the API one-time-password-sms is available [here](https://github.com/camaraproject/OTPvalidation/tree/r3.2)
 
-  - API one-time-password-sms 1.1.1-rc.3 definition **with inline documentation**:
-    - OpenAPI [YAML spec file](https://github.com/camaraproject/OTPvalidation/blob/r3.1/code/API_definitions/one-time-password-sms.yaml)
-    - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r3.1/code/API_definitions/one-time-password-sms.yaml&nocors)
-    - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r3.1/code/API_definitions/one-time-password-sms.yaml)
+  - API one-time-password-sms 1.1.1 definition **with inline documentation**:
+    - OpenAPI [YAML spec file](https://github.com/camaraproject/OTPvalidation/blob/r3.2/code/API_definitions/one-time-password-sms.yaml)
+    - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r3.2/code/API_definitions/one-time-password-sms.yaml&nocors)
+    - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r3.2/code/API_definitions/one-time-password-sms.yaml)
 * Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/OTPvalidation/releases 
 * For changes see [CHANGELOG.md](https://github.com/camaraproject/OTPvalidation/blob/main/CHANGELOG.md)
 
@@ -52,3 +52,4 @@ This process ensures secure, real-time validation of user possession of the spec
   * Subscribe / Unsubscribe to the mailing list <https://lists.camaraproject.org/g/sp-number-insights>.
   * A message to the community of this Sub Project can be sent using <[email protected]>.
 
+

code/API_definitions/one-time-password-sms.yaml

@@ -28,7 +28,7 @@ info:
 
     As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
 
-  version: 1.1.1-rc.3
+  version: 1.1.1
   x-camara-commonalities: 0.6
   license:
     name: Apache 2.0
@@ -37,7 +37,7 @@ externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/OTPValidation
 servers:
-  - url: "{apiRoot}/one-time-password-sms/v1rc3"
+  - url: "{apiRoot}/one-time-password-sms/v1"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -202,10 +202,10 @@ components:
           description: HTTP response status code
         code:
           type: string
-          description: Code given to this error
+          description: A human-readable code to describe the error
         message:
           type: string
-          description: Detailed error description
+          description: A human-readable description of what the event represents
   securitySchemes:
     openId:
       type: openIdConnect

code/Test_definitions/one-time-password-sms-sendCode.feature

@@ -1,4 +1,4 @@
-Feature: one-time-password-sms, v1.1.1-rc.3 - Operation sendCode
+Feature: one-time-password-sms, v1.1.1 - Operation sendCode
 
 # Environment variables:
 # * api_root: API root of the server URL
@@ -9,7 +9,7 @@ Feature: one-time-password-sms, v1.1.1-rc.3 - Operation sendCode
 
   Background: Common OTPvalidation sendCode setup
     Given an environment at "apiRoot"
-    And the resource "/one-time-password-sms/v1rc3/send-code"                                                            |
+    And the resource "/one-time-password-sms/v1/send-code"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

code/Test_definitions/one-time-password-sms-validateCode.feature

@@ -1,4 +1,4 @@
-Feature: one-time-password-sms, v1.1.1-rc.3 - operation validateCode
+Feature: one-time-password-sms, v1.1.1 - operation validateCode
 
 # Environment variables:
 # * api_root: API root of the server URL
@@ -11,7 +11,7 @@ Feature: one-time-password-sms, v1.1.1-rc.3 - operation validateCode
 
   Background: Common OTPvalidation validateCode setup
     Given an environment at "apiRoot"
-    And the resource "/one-time-password-sms/v1rc3/validate-code"                                                      |
+    And the resource "/one-time-password-sms/v1/validate-code"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md

@@ -1,19 +1,19 @@
 # API Readiness Checklist
 
-Checklist for one-time-password-sms v1.1.1-rc.3 in r3.1
+Checklist for one-time-password-sms v1.1.1 in r3.2
 
 
 | Nr | API release assets  | alpha | release-candidate |  public-release<br>initial | public-release<br> stable | Status | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |   Y   | [link](/code/API_definitions/one-time-password-sms.yaml) |
-|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y    |  [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2)    |
-|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y   |  [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2)    |
-|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y   |  v1.1.1-rc.3    |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y    |  [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)    |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y   |  [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)    |
+|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y   |  v1.1.1    |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y   | Embed documentation into API spec - [link](/code/API_definitions/one-time-password-sms.yaml)  |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |   Y   | [link](/documentation/API_documentation/OTPValidationAPI_User_Story.md) |
 |  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |   Y   | [send code](/code/Test_definitions/one-time-password-sms-sendCode.feature) / [validate code](/code/Test_definitions/one-time-password-sms-validateCode.feature)|
 |  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |   Y   |  [send code](/code/Test_definitions/one-time-password-sms-sendCode.feature) / [validate code](/code/Test_definitions/one-time-password-sms-validateCode.feature) |
-|  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N   | na for rc version |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N   | Not Available |
 | 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y   |    |
 | 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y   | [link](/CHANGELOG.md) |
 | 12 | Previous public-release was certified        |   O   |         O         |    O    |    M   |   Y   | see (1)    |
@@ -29,3 +29,5 @@ The documentation for the content of the checklist is here: see API Readiness Ch
 
 
 
+
+