From ca7c40c588d1e6676b2dec7baa285ec41db9b9c7 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 10:34:44 +0200
Subject: [PATCH 01/23] Update one-time-password-sms.yaml
Change version to v1
---
code/API_definitions/one-time-password-sms.yaml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/code/API_definitions/one-time-password-sms.yaml b/code/API_definitions/one-time-password-sms.yaml
index fec221e..9e27671 100644
--- a/code/API_definitions/one-time-password-sms.yaml
+++ b/code/API_definitions/one-time-password-sms.yaml
@@ -21,13 +21,13 @@ info:
It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
- version: wip
+ version: 1.0.0
x-camara-commonalities: 0.4.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- - url: "{apiRoot}/one-time-password-sms/v1rc1"
+ - url: "{apiRoot}/one-time-password-sms/v1"
variables:
apiRoot:
default: http://localhost:9091
From eebce169a05e91a09327b55fc3833cfce70048b8 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 10:43:41 +0200
Subject: [PATCH 02/23] Update one-time-password-sms-API-Readiness-Checklist.md
Update checklist to r1.2
---
.../one-time-password-sms-API-Readiness-Checklist.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index dc81cf5..904bc1f 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -1,6 +1,6 @@
# API Readiness Checklist
-Checklist for one-time-password-sms v1.0.0-rc.1 in r1.1
+Checklist for one-time-password-sms v1.0.0 in r1.2
| Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments |
@@ -15,7 +15,7 @@ Checklist for one-time-password-sms v1.0.0-rc.1 in r1.1
| 8 | Enhanced API test cases & documentation | O | O | O | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-| 9 | Test result statement | O | O | O | M | N | link |
+| 9 | Test result statement | O | O | O | M | N | [link](https://www.open-gateway.com/operators-map) |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) |
| 12 | Previous public-release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) |
From d447072d8363ce5a4a9207b8297cfb05aac39965 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 10:44:05 +0200
Subject: [PATCH 03/23] Update one-time-password-sms-API-Readiness-Checklist.md
fix table
---
.../one-time-password-sms-API-Readiness-Checklist.md | 2 --
1 file changed, 2 deletions(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index 904bc1f..44e47d6 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -12,9 +12,7 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 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 | N | [link](/documentation/API_documentation/OTPValidationAPI_User_Story.md) |
| 7 | Basic API test cases & documentation | O | M | M | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-
| 8 | Enhanced API test cases & documentation | O | O | O | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-
| 9 | Test result statement | O | O | O | M | N | [link](https://www.open-gateway.com/operators-map) |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) |
From 2eb52970f30497698e824f11155267a2e9cd28b1 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 10:47:46 +0200
Subject: [PATCH 04/23] Update one-time-password-sms-API-Readiness-Checklist.md
---
.../one-time-password-sms-API-Readiness-Checklist.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index 44e47d6..230dca6 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -13,7 +13,7 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 6 | User stories | O | O | O | M | N | [link](/documentation/API_documentation/OTPValidationAPI_User_Story.md) |
| 7 | Basic API test cases & documentation | O | M | M | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-| 9 | Test result statement | O | O | O | M | N | [link](https://www.open-gateway.com/operators-map) |
+| 9 | Test result statement | O | O | O | M | N | link |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) |
| 12 | Previous public-release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) |
From b870bce140a3c7f96ff628c3ad0becf0c78a481a Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 11:02:43 +0200
Subject: [PATCH 05/23] Update README.md
update readme for r1.2
---
README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 5434c66..9fdfaff 100644
--- a/README.md
+++ b/README.md
@@ -27,13 +27,13 @@ Current schedule, registration, & meeting links are available on the confluence
## Status and released versions
* 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**.
-* **The latest pre-release of OTPValidation is r1.1. The pre-release contains the release candidate of the first stable version of the one-time-password-sms API**. The pre-release is suitable for implementors.
-* The Release Tag is [r1.1](https://github.com/camaraproject/OTPvalidation/releases/tag/r1.1).
+* `NEW`: Release r1.2 of API version `1.0.0` is available [here](https://github.com/camaraproject/OTPvalidation/tree/r1.2)
- API definition **with inline documentation**:
- - OpenAPI [YAML spec file](https://github.com/camaraproject/OTPvalidation/blob/r1.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/r1.1/code/API_definitions/one-time-password-sms.yaml&nocors)
- - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r1.1/code/API_definitions/one-time-password-sms.yaml)
-* The previous version 0.5.0 is available on [release-0.5.0](https://github.com/camaraproject/OTPvalidation/tree/release-0.5.0) branch.
+ - OpenAPI [YAML spec file](https://github.com/camaraproject/OTPvalidation/blob/r1.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/r1.2/code/API_definitions/one-time-password-sms.yaml&nocors)
+ - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r1.2/code/API_definitions/one-time-password-sms.yaml)
+* Other releases of this sub project are available in https://github.com/camaraproject/OTPvalidation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/OTPvalidation/blob/main/CHANGELOG.md)
## Contributorship and mailing list
From 0d06be793dff88e8c451afcc18ff64d44ae69797 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 11:13:09 +0200
Subject: [PATCH 06/23] Update CHANGELOG.md
Updated for r1.2
---
CHANGELOG.md | 43 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index fa6f20a..e5b6dfa 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,49 @@
**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.**
+# r1.2
+
+## Release Notes
+
+This release contains the definition and documentation of
+* one-time-password-sms 1.0.0
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.0
+
+## one-time-password-sms 1.0.0
+
+**one-time-password-sms 1.0.0 is the public release for v1.0.0 of the OTPValidation API.**
+
+- API definition **with inline documentation**:
+ - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r1.2/code/API_definitions/one-time-password-sms.yaml&nocors)
+ - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r1.2/code/API_definitions/one-time-password-sms.yaml)
+ - OpenAPI [YAML spec file](https://github.com/camaraproject/OTPValidation/blob/r1.2/code/API_definitions/one-time-password-sms.yaml)
+
+**Main Changes**
+
+* Error code 405 has been removed to the yaml accordingly to Commonalities rule.
+
+### Added
+
+* N/A
+
+### Changed
+
+* N/A
+
+### Fixed
+
+* N/A
+
+### Removed
+
+* Remove 405 error code in the yaml & test definition by @bigludo7 [PR80](https://github.com/camaraproject/OTPValidationAPI/pull/80)
+
+## New Contributors
+* N/A
+
# r1.1 - rc
From 3f2e50e22797c6f424ddb1073e9bfc6d6dd4f811 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 11:26:35 +0200
Subject: [PATCH 07/23] Update README.md
Align sentences with template
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 9fdfaff..d252ec3 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Current schedule, registration, & meeting links are available on the confluence
- OpenAPI [YAML spec file](https://github.com/camaraproject/OTPvalidation/blob/r1.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/r1.2/code/API_definitions/one-time-password-sms.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/OTPvalidation/r1.2/code/API_definitions/one-time-password-sms.yaml)
-* Other releases of this sub project are available in https://github.com/camaraproject/OTPvalidation/releases
+* 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)
## Contributorship and mailing list
From 0159d68ca5a247fb3fdde23f1b9e8c54a08a2e36 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 11:28:57 +0200
Subject: [PATCH 08/23] Update CHANGELOG.md
update changelog for completion
---
CHANGELOG.md | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e5b6dfa..92d6f67 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -34,11 +34,16 @@ The API definition(s) are based on
### Added
-* N/A
+* User Story in documentation/API_documentation directory by @bigludo7 [PR71](https://github.com/camaraproject/OTPValidationAPI/pull/71)
+* Test Definition in Test_Definitions directory by @bigludo7 [PR61](https://github.com/camaraproject/OTPValidationAPI/pull/61)
### Changed
-* N/A
+* Aligned with CAMARA design guidelines & Identity Consent management
+* Make the '+' mandatory for the phone number by @bigludo7 [PR50](https://github.com/camaraproject/OTPValidationAPI/pull/50)
+* Cosmetic change following megalinter integration by @bigludo7 [PR53](https://github.com/camaraproject/OTPValidationAPI/pull/53)
+* Update Authorization and authentication part accordingly to ICM by @bigludo7 [PR65](https://github.com/camaraproject/OTPValidationAPI/pull/65)
+* Align securitySchemes with ICM by @fernandopradocabrillo [PR68](https://github.com/camaraproject/OTPValidationAPI/pull/68)
### Fixed
From e9165636607a1c6e933cb0a50e943d35d3295ee8 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 11:32:30 +0200
Subject: [PATCH 09/23] Update CHANGELOG.md
---
CHANGELOG.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 92d6f67..f72992c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -30,7 +30,9 @@ The API definition(s) are based on
**Main Changes**
-* Error code 405 has been removed to the yaml accordingly to Commonalities rule.
+* API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release
+* Additional documentation & test cases added.
+
### Added
From f181d4cde87f7b4829f384750521ee662ebeb625 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 11:34:43 +0200
Subject: [PATCH 10/23] Update CHANGELOG.md
---
CHANGELOG.md | 31 ++++++++++++++++++++++++++++++-
1 file changed, 30 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f72992c..a1e22f8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,8 +3,9 @@
## Table of contents
+- **[r1.2](#r12)**
- **[r1.1](#r11)**
-
+- **[v0.5.0](#v050)**
**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.**
@@ -110,4 +111,32 @@ This version contains significant changes compared to v0.5.0, and it is not back
- @fernandopradocabrillo made their first contribution in Fernando replaces Mona as maintainer [#37](https://github.com/camaraproject/OTPvalidationAPI/pull/37)
- @rartych made their first contribution in GitHub workflows [#60](https://github.com/camaraproject/OTPvalidationAPI/pull/60)
+# v0.5.0
+
+**This is the first alpha release of the OTPValidation API**
+
+- API definition **with inline documentation**
+
+## Please note:
+
+- This is an alpha version, it should be considered as a draft
+- There are bug fixes to be expected and incompatible changes in upcoming versions
+- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments
+- Version numbers before v0.5.0 were used during the development of this version but not released
+-
+### Added
+
+* CHANGELOG.md
+* API definition ready for a release
+
+### Changed
+* Aligned with CAMARA design guidelines
+
+### Fixed
+
+* n/a
+
+### Removed
+
+* n/a
From a241cafc4be95cff903bdbf7808c49c1f1178a42 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 12:02:10 +0200
Subject: [PATCH 11/23] Update README.md
Co-authored-by: Herbert Damker
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index d252ec3..5ca06fb 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ Current schedule, registration, & meeting links are available on the confluence
## Status and released versions
* 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`: Release r1.2 of API version `1.0.0` is available [here](https://github.com/camaraproject/OTPvalidation/tree/r1.2)
+* `NEW`: Release r1.2 with version 1.0.0 of the API one-time-password-sms is available [here](https://github.com/camaraproject/OTPvalidation/tree/r1.2)
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/OTPvalidation/blob/r1.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/r1.2/code/API_definitions/one-time-password-sms.yaml&nocors)
From aaa393e3f502e13e37f6afbf9cdb355086bd3d4e Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 12:07:28 +0200
Subject: [PATCH 12/23] Update OTPvalidationAPI.feature
Update version to v1.0.0 in line 1
---
code/Test_Definitions/OTPvalidationAPI.feature | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/code/Test_Definitions/OTPvalidationAPI.feature b/code/Test_Definitions/OTPvalidationAPI.feature
index fc00c51..a2a7880 100644
--- a/code/Test_Definitions/OTPvalidationAPI.feature
+++ b/code/Test_Definitions/OTPvalidationAPI.feature
@@ -1,4 +1,4 @@
-Feature: CAMARA OTPvalidationAPI, v:wip
+Feature: CAMARA OTPvalidationAPI, v:1.0.0
# Environment variables:
# * api_root: API root of the server URL
From c1b9f5e481031623290aa284808984f14ceaafbf Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 12:09:13 +0200
Subject: [PATCH 13/23] Update
documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
Co-authored-by: Herbert Damker
---
.../one-time-password-sms-API-Readiness-Checklist.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index 230dca6..ec51be5 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -12,7 +12,8 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 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 | N | [link](/documentation/API_documentation/OTPValidationAPI_User_Story.md) |
| 7 | Basic API test cases & documentation | O | M | M | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-| 8 | Enhanced API test cases & documentation | O | O | O | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
+
| 9 | Test result statement | O | O | O | M | N | link |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) |
From a19d1cd23f734f726efe62e5bb52c30198e52b73 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 12:09:44 +0200
Subject: [PATCH 14/23] Update
documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
Co-authored-by: Herbert Damker
---
.../one-time-password-sms-API-Readiness-Checklist.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index ec51be5..37b6546 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -11,7 +11,8 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 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 | N | [link](/documentation/API_documentation/OTPValidationAPI_User_Story.md) |
-| 7 | Basic API test cases & documentation | O | M | M | M | N | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
+
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
| 9 | Test result statement | O | O | O | M | N | link |
From 8c16657f6cdf427d87fef3ad5ac6ec25a25ee84d Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Fri, 23 Aug 2024 12:14:42 +0200
Subject: [PATCH 15/23] Update one-time-password-sms-API-Readiness-Checklist.md
---
...e-time-password-sms-API-Readiness-Checklist.md | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index 37b6546..462830c 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -10,19 +10,22 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 3 | Guidelines from ICM applied | O | M | M | M | Y | |
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 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 | N | [link](/documentation/API_documentation/OTPValidationAPI_User_Story.md) |
+| 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 | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-
| 9 | Test result statement | O | O | O | M | N | link |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
-| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) |
+| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) |
| 12 | Previous public-release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) |
-Note: It is normal that the checklists of the (final) release-candidate and its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release.
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Comments column, provide the link to the asset once available, and any other relevant comments.
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
-The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist)
+The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist).
From 5eed2d9a100c2465941c55c11278e4253313aa3c Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Thu, 29 Aug 2024 12:34:00 +0200
Subject: [PATCH 16/23] Update OTPvalidationAPI.feature
Male linting happy
---
.../Test_Definitions/OTPvalidationAPI.feature | 120 ++++++++----------
1 file changed, 55 insertions(+), 65 deletions(-)
diff --git a/code/Test_Definitions/OTPvalidationAPI.feature b/code/Test_Definitions/OTPvalidationAPI.feature
index a2a7880..ea32685 100644
--- a/code/Test_Definitions/OTPvalidationAPI.feature
+++ b/code/Test_Definitions/OTPvalidationAPI.feature
@@ -1,4 +1,4 @@
-Feature: CAMARA OTPvalidationAPI, v:1.0.0
+Feature: CAMARA OTPvalidationAPI, v:1.0.0
# Environment variables:
# * api_root: API root of the server URL
@@ -29,7 +29,7 @@ Background: Common OTPvalidationAPI setup
When the HTTP "POST" request is sent
Then the response property "$.status" is 200
And the response header "Content-Type" is "application/json"
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body complies with the OAS schema at "/components/schemas/SendCodeResponse"
@OTPvalidationAPI_02_send_code_success_scenario_without_x-correlator
@@ -43,7 +43,6 @@ Background: Common OTPvalidationAPI setup
And the response header "Content-Type" is "application/json"
And the response body complies with the OAS schema at "/components/schemas/SendCodeResponse"
-
########################################
# Happy path scenarios for validate-code
########################################
@@ -55,7 +54,7 @@ Scenario: Validation for sucess validate-code scenario
And the resource "/one-time-password-sms/v0/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 204
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_02_validate_code_sucess_scenario_without_x-correlator
Scenario: Validation for sucess validate-code scenario without x-correlator
@@ -66,7 +65,6 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
When the HTTP "POST" request is sent
Then the response property "$.status" is 204
-
########################################
# Rainy path scenarios for sent_code
########################################
@@ -81,7 +79,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.MAX_OTP_CODES_EXCEEDED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_04_send_code_phone_number_not_allowed
Scenario: Validation for failed scenario for a phone number that cannot receive SMS
@@ -92,7 +90,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.PHONE_NUMBER_NOT_ALLOWED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_05_send_code_phone_number_not_allowed_3
Scenario: Validation for failed scenario for a phone number that target a landline
@@ -104,7 +102,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.PHONE_NUMBER_NOT_ALLOWED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_06_send_code_phone_number_blocked
Scenario: Validation for failed scenario for a phone number that block SMS reception
@@ -115,7 +113,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.PHONE_NUMBER_BLOCKED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
# Following part describe scenario to test error code defined in the yaml
# These scenarios cover following http status: 400, 401, 404, 406, 415
@@ -124,28 +122,28 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
# -429 as it could not be easily tested
###########################
-# 400 errors for send_code
+# 400 errors for send-code
###########################
@OTPvalidationAPI_400.1_send_code_no_request_body
- Scenario: Missing request body
+ Scenario: Missing request body for send_code
Given the request body is not included
And the resource "/one-time-password-sms/v0/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.2_send_code_empty_request_body
- Scenario: Empty object as request body
+ Scenario: Empty object as request body for send_code
Given the request body is set to "{}"
And the resource "/one-time-password-sms/v0/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.3_missing_phone_number_in_request_body
Scenario: Missing phone number in the request
@@ -156,7 +154,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.4_send_code_incorrect_phone_number_request_body
Scenario: Incorrect phone number in the request
@@ -167,7 +165,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.5_send_code_missing_message
Scenario: Missing message request attribute
@@ -178,7 +176,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.6_send_code_missing_code_request_body
Scenario: Missing {{code}} in message request attribute
@@ -189,7 +187,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.7_send_code_message_too_long
Scenario: message attribute exceed maximum lenght authorized
@@ -200,45 +198,44 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
###########################
-# 401 errors for send_code
+# 401 errors for send-code
###########################
@OTPvalidationAPI_401.1_send_code_no_authorization_header
- Scenario: No Authorization header
+ Scenario: No Authorization header for send-code
Given the header "Authorization" is removed
And the resource "/one-time-password-sms/v0/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_401.2_send_code_expired_access_token
- Scenario: Expired access token
+ Scenario: Expired access token for send-code
Given the header "Authorization" is set to an expired access token
And the resource "/one-time-password-sms/v0/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_401.3_send_code_invalid_access_token
- Scenario: Invalid access token
+ Scenario: Invalid access token for send-code
Given the header "Authorization" is set to an invalid access token
And the resource "/one-time-password-sms/v0/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
-
+ And the response header "x-correlator" has same value as the request header "x-correlator"
###########################
-# 404 errors for send_code
+# 404 errors for send-code
###########################
@OTPvalidationAPI_404.1_send_code_phone_number_not_belong_to_operator
@@ -250,15 +247,14 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Then the response property "$.status" is 404
And the response property "$.code" is "NOT_FOUND"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
-
+ And the response header "x-correlator" has same value as the request header "x-correlator"
###########################
# 406 errors for send_code
###########################
@OTPvalidationAPI_406_send_code_not_acceptable_scenario
-Scenario: Not acceptable accept
+Scenario: Not acceptable accept for send-code
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
And the resource "/one-time-password-sms/v0/send-code"
@@ -267,14 +263,14 @@ Scenario: Not acceptable accept
Then the response property "$.status" is 406
And the response property "$.code" is "NOT_ACCEPTABLE"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
###########################
-# 415 errors for send_code
+# 415 errors for send-code
###########################
@OTPvalidationAPI_415_send_code_unsupported_media_type_scenario
-Scenario: Not acceptable accept
+Scenario: unsupported media type for send-code
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
And the resource "/one-time-password-sms/v0/send-code"
@@ -285,9 +281,8 @@ Scenario: Not acceptable accept
And the response property "$.message" contains a user friendly text
And the response header "x-correlator" has same value as the request header "x-correlator"
-
########################################
-# Rainy path scenarios for validate_code
+# Rainy path scenarios for validate-code
########################################
@OTPvalidationAPI_08_validate_code_invalid_otp_scenario
@@ -299,7 +294,7 @@ Scenario: Validations for invalid otp validate-code scenario
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.INVALID_OTP"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_09_validate_code_verification_expired_scenario_1
Scenario: Validations for verification expired validate-code scenario
@@ -311,7 +306,7 @@ Scenario: Validations for verification expired validate-code scenario
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_EXPIRED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_10_validate_code_verification_expired_scenario_2
Scenario: Validations for verification expired because a new one has been requested for the same phone number
@@ -323,7 +318,7 @@ Scenario: Validations for verification expired because a new one has been reque
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_EXPIRED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_11_validate_code_verification_expired_scenario_3
Scenario: Validations for verification expired because authenticationId is no longer valid because it has already been used
@@ -335,7 +330,7 @@ Scenario: Validations for verification expired because authenticationId is no l
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_EXPIRED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_12_validate_code_verification_failed_scenario
Scenario: Validations for verification failed validate-code scenario whe maximum number of attempts for this authenticationId was exceeded without providing a valid OTP
@@ -346,7 +341,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_FAILED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
# Following part describe scenario to test error code defined in the yaml
# These scenarios cover following http status: 400, 401, 404, 406, 415
@@ -356,7 +351,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
# -403 as there is no valid scenario
###############################
-# 400 errors for validate_code
+# 400 errors for validate-code
###############################
@OTPvalidationAPI_400.1_validate_code_no_request_body
@@ -371,7 +366,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.2_validate_code_empty_request_body
- Scenario: Empty object as request body
+ Scenario: Empty object as request body for validate-code
Given the request body is set to "{}"
And the resource "/one-time-password-sms/v0/validate-code"
When the HTTP "POST" request is sent
@@ -379,7 +374,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_400.3_validate_code_missing_authenticationId
Scenario: missing authenticationId as request parameter
@@ -418,64 +413,59 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
And the response header "x-correlator" has same value as the request header "x-correlator"
###############################
-# 401 errors for validate_code
+# 401 errors for validate-code
###############################
@OTPvalidationAPI_401.1_validate_code_no_authorization_header
- Scenario: No Authorization header
+ Scenario: No Authorization header for calidate-code
Given the header "Authorization" is removed
And the resource "/one-time-password-sms/v0/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
-
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_401.2_validate_code_expired_access_token
- Scenario: Expired access token
+ Scenario: Expired access token for validate-code
Given the header "Authorization" is set to an expired access token
And the resource "/one-time-password-sms/v0/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
-
+ And the response header "x-correlator" has same value as the request header "x-correlator"
@OTPvalidationAPI_401.3_validate_code_invalid_access_token
- Scenario: Invalid access token
+ Scenario: Invalid access token for validate-code
Given the header "Authorization" is set to an invalid access token
And the resource "/one-time-password-sms/v0/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
-
+ And the response header "x-correlator" has same value as the request header "x-correlator"
###############################
-# 404 errors for validate_code
+# 404 errors for validate-code
###############################
@OTPvalidationAPI_404_validate_code_resource_not_found
- Scenario: resource not found
+ Scenario: resource not found
Given the request body property "$.authenticationId" is set to an unknown value
And the resource "/one-time-password-sms/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 404
And the response property "$.code" is "NOT_FOUND"
-
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
And the response property "$.message" contains a user friendly text
-
###############################
-# 406 errors for validate_code
+# 406 errors for validate-code
###############################
@OTPvalidationAPI_406_validate_code_not_acceptable_scenario
-Scenario: Not acceptable accept
+Scenario: Not acceptable accept for validate-code
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is set to the value received in the SMS
And the resource "/one-time-password-sms/v0/validate-code"
@@ -484,14 +474,14 @@ Scenario: Not acceptable accept
Then the response property "$.status" is 406
And the response property "$.code" is "NOT_ACCEPTABLE"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
###########################
-# 415 errors for send_code
+# 415 errors for send-code
###########################
@OTPvalidationAPI_415_validate_code_unsupported_media_type_scenario
-Scenario: Not acceptable accept
+Scenario: unsupported media type fail scenario
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is set to the value received in the SMS
And the resource "/one-time-password-sms/v0/validate-code"
@@ -500,4 +490,4 @@ Scenario: Not acceptable accept
Then the response property "$.status" is 415
And the response property "$.code" is "UNSUPPORTED_MEDIA_TYPE"
And the response property "$.message" contains a user friendly text
- And the response header "x-correlator" has same value as the request header "x-correlator"
+ And the response header "x-correlator" has same value as the request header "x-correlator"
From 83262dfa056840ec933b9a2be5cc2ae04c0b3653 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Thu, 29 Aug 2024 12:39:11 +0200
Subject: [PATCH 17/23] Update and rename OTPvalidationAPI.feature to
otp-validation-api.feature
---
.../{OTPvalidationAPI.feature => otp-validation-api.feature} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename code/Test_Definitions/{OTPvalidationAPI.feature => otp-validation-api.feature} (100%)
diff --git a/code/Test_Definitions/OTPvalidationAPI.feature b/code/Test_Definitions/otp-validation-api.feature
similarity index 100%
rename from code/Test_Definitions/OTPvalidationAPI.feature
rename to code/Test_Definitions/otp-validation-api.feature
From 6104b959b9f05dfdd4a39a165024b9cbfabf877c Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Thu, 29 Aug 2024 12:39:57 +0200
Subject: [PATCH 18/23] Update and rename otp-validation-api.feature to
one-time-password-sms.feature
---
.../{otp-validation-api.feature => one-time-password-sms.feature} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename code/Test_Definitions/{otp-validation-api.feature => one-time-password-sms.feature} (100%)
diff --git a/code/Test_Definitions/otp-validation-api.feature b/code/Test_Definitions/one-time-password-sms.feature
similarity index 100%
rename from code/Test_Definitions/otp-validation-api.feature
rename to code/Test_Definitions/one-time-password-sms.feature
From a78f9b3ef90b0741e36d19220df4249f997ec542 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Wed, 4 Sep 2024 09:47:04 +0200
Subject: [PATCH 19/23] Update one-time-password-sms.feature
Change all path from /v0/ to /v1/
---
.../one-time-password-sms.feature | 72 +++++++++----------
1 file changed, 36 insertions(+), 36 deletions(-)
diff --git a/code/Test_Definitions/one-time-password-sms.feature b/code/Test_Definitions/one-time-password-sms.feature
index ea32685..2ef8f5c 100644
--- a/code/Test_Definitions/one-time-password-sms.feature
+++ b/code/Test_Definitions/one-time-password-sms.feature
@@ -25,7 +25,7 @@ Background: Common OTPvalidationAPI setup
Scenario: Validation for sucess send-code scenario
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 200
And the response header "Content-Type" is "application/json"
@@ -36,7 +36,7 @@ Background: Common OTPvalidationAPI setup
Scenario: Validation for sucess send-code scenario without x-correlator
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
And the header "Authorization" is not set
When the HTTP "POST" request is sent
Then the response property "$.status" is 200
@@ -51,7 +51,7 @@ Background: Common OTPvalidationAPI setup
Scenario: Validation for sucess validate-code scenario
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is set to the value received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 204
And the response header "x-correlator" has same value as the request header "x-correlator"
@@ -60,7 +60,7 @@ Scenario: Validation for sucess validate-code scenario
Scenario: Validation for sucess validate-code scenario without x-correlator
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is set to the value received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
And the header "Authorization" is not set
When the HTTP "POST" request is sent
Then the response property "$.status" is 204
@@ -73,7 +73,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Validation for failed scenario too many codes have been requested
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
And (config_var:"max_send"-1) of send-code requests for this phone number has been submitted
When the HTTP "POST" request is sent
Then the response property "$.status" is 403
@@ -85,7 +85,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Validation for failed scenario for a phone number that cannot receive SMS
Given the request body property "$.phoneNumber" is set to a phone number that cannot receive SMS
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.PHONE_NUMBER_NOT_ALLOWED"
@@ -97,7 +97,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Given the request body property "$.phoneNumber" is set to a phone number that target a landline
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.PHONE_NUMBER_NOT_ALLOWED"
@@ -108,7 +108,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Validation for failed scenario for a phone number that block SMS reception
Given the request body property "$.phoneNumber" is set to a phone number that that has an active SMS barring
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 403
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.PHONE_NUMBER_BLOCKED"
@@ -128,7 +128,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
@OTPvalidationAPI_400.1_send_code_no_request_body
Scenario: Missing request body for send_code
Given the request body is not included
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -138,7 +138,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
@OTPvalidationAPI_400.2_send_code_empty_request_body
Scenario: Empty object as request body for send_code
Given the request body is set to "{}"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -149,7 +149,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Missing phone number in the request
Given the request body property "$.phoneNumber" is not set
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -160,7 +160,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Incorrect phone number in the request
Given the request body property "$.phoneNumber" is set to "3301"
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -171,7 +171,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Missing message request attribute
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is not valued
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -182,7 +182,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Missing {{code}} in message request attribute
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to "message without code"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -193,7 +193,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: message attribute exceed maximum lenght authorized
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is longer than config_var:"max_lenght"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
@@ -207,7 +207,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
@OTPvalidationAPI_401.1_send_code_no_authorization_header
Scenario: No Authorization header for send-code
Given the header "Authorization" is removed
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
@@ -217,7 +217,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
@OTPvalidationAPI_401.2_send_code_expired_access_token
Scenario: Expired access token for send-code
Given the header "Authorization" is set to an expired access token
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
@@ -227,7 +227,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
@OTPvalidationAPI_401.3_send_code_invalid_access_token
Scenario: Invalid access token for send-code
Given the header "Authorization" is set to an invalid access token
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
@@ -242,7 +242,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Validation for failed scenario for a phone number that did not belong to the operator
Given the request body property "$.phoneNumber" is set to a phone number that did not belong to the operator
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 404
And the response property "$.code" is "NOT_FOUND"
@@ -257,7 +257,7 @@ Scenario: Validation for sucess validate-code scenario without x-correlator
Scenario: Not acceptable accept for send-code
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
And the header "Accept" is set to "application/xml"
When the HTTP "POST" request is sent
Then the response property "$.status" is 406
@@ -273,7 +273,7 @@ Scenario: Not acceptable accept for send-code
Scenario: unsupported media type for send-code
Given the request body property "$.phoneNumber" is set to config_var: "phone_number"
And the request body property "$.message" is set to config_var: "message"
- And the resource "/one-time-password-sms/v0/send-code"
+ And the resource "/one-time-password-sms/v1/send-code"
And the header "Content-Type" is set to "application/xml"
When the HTTP "POST" request is sent
Then the response property "$.status" is 415
@@ -289,7 +289,7 @@ Scenario: unsupported media type for send-code
Scenario: Validations for invalid otp validate-code scenario
Given request body property "$.authenticationId" is set to the value from send-code request
And the request body property "$.code" is set to a value distinct from the value received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.INVALID_OTP"
@@ -300,7 +300,7 @@ Scenario: Validations for invalid otp validate-code scenario
Scenario: Validations for verification expired validate-code scenario
Given request body property "$.authenticationId" is set to the value from send-code request
And the request body property "$.code" is set to the received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
And the time elapsed since the send-code exceed the allowed time
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
@@ -313,7 +313,7 @@ Scenario: Validations for verification expired because a new one has been reque
Given Two send-code request has been sequentially triggered for the same phoneNumber
And request body property "$.authenticationId" is set to the value got for the first send-code request
And the request body property "$.code" is set to the received in the SMS for this first request
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_EXPIRED"
@@ -325,7 +325,7 @@ Scenario: Validations for verification expired because authenticationId is no l
Given a validate-code has been succesfully performed for a authenticationId
And request body property "$.authenticationId" is valued again with this authenticationId
And the request body property "$.code" is set to the code received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_EXPIRED"
@@ -336,7 +336,7 @@ Scenario: Validations for verification expired because authenticationId is no l
Scenario: Validations for verification failed validate-code scenario whe maximum number of attempts for this authenticationId was exceeded without providing a valid OTP
Given an authenticationId has been retrieved from a send-code request
And (config_var:"max_try"-1) calls with the request body property "$.code" set to a value distinct from the value received in the SMS were performed
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 400
And the response property "$.code" is "ONE_TIME_PASSWORD_SMS.VERIFICATION_FAILED"
@@ -357,7 +357,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
@OTPvalidationAPI_400.1_validate_code_no_request_body
Scenario: Missing request body
Given the request body is not included
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
@@ -368,7 +368,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
@OTPvalidationAPI_400.2_validate_code_empty_request_body
Scenario: Empty object as request body for validate-code
Given the request body is set to "{}"
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
@@ -380,7 +380,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
Scenario: missing authenticationId as request parameter
Given the request body property "$.authenticationId" is not valued
And the request body property "$.code" is set to a format valid value
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
@@ -392,7 +392,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
Scenario: missing code as request parameter
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is not valued
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
@@ -404,7 +404,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
Scenario: exceed the maxLength for code
Given request body property "$.authenticationId" is set to the value from send-code request
And the request body property "$.code" is set to "thisCodeExceedsTenCharacters"
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
@@ -419,7 +419,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
@OTPvalidationAPI_401.1_validate_code_no_authorization_header
Scenario: No Authorization header for calidate-code
Given the header "Authorization" is removed
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
@@ -429,7 +429,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
@OTPvalidationAPI_401.2_validate_code_expired_access_token
Scenario: Expired access token for validate-code
Given the header "Authorization" is set to an expired access token
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
@@ -439,7 +439,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
@OTPvalidationAPI_401.3_validate_code_invalid_access_token
Scenario: Invalid access token for validate-code
Given the header "Authorization" is set to an invalid access token
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
When the HTTP "POST" request is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
@@ -468,7 +468,7 @@ Scenario: Validations for verification failed validate-code scenario whe maximu
Scenario: Not acceptable accept for validate-code
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is set to the value received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
And the header "Accept" is set to "application/xml"
When the HTTP "POST" request is sent
Then the response property "$.status" is 406
@@ -484,7 +484,7 @@ Scenario: Not acceptable accept for validate-code
Scenario: unsupported media type fail scenario
Given an authenticationId has been retrieved from a send-code request
And the request body property "$.code" is set to the value received in the SMS
- And the resource "/one-time-password-sms/v0/validate-code"
+ And the resource "/one-time-password-sms/v1/validate-code"
And the header "Content-Type" is set to "application/xml"
When the HTTP "POST" request is sent
Then the response property "$.status" is 415
From a97d9e4dfff729873ce8a85bc86727bd4a50a10c Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Wed, 4 Sep 2024 09:52:59 +0200
Subject: [PATCH 20/23] Update
documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
Co-authored-by: Herbert Damker
---
.../one-time-password-sms-API-Readiness-Checklist.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index 462830c..e7b1779 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -13,7 +13,8 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 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 | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-| 9 | Test result statement | O | O | O | M | N | link |
+| 9 | Test result statement | O | O | O | M | N | |
+
| 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 | [link](https://www.open-gateway.com/operators-map) |
From b2c101fe102e7b4631ea0fdb85f31316ce9190a5 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Wed, 4 Sep 2024 09:53:51 +0200
Subject: [PATCH 21/23] Update
documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
Co-authored-by: Herbert Damker
---
.../one-time-password-sms-API-Readiness-Checklist.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index e7b1779..8798ffe 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -11,8 +11,9 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 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 | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
-| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/OTPvalidationAPI.feature) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_Definitions/one-time-password-sms.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/one-time-password-sms.feature) |
+
| 9 | Test result statement | O | O | O | M | N | |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
From f5304453e6d80d2b50b3887d4b0da48f800cae12 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Wed, 4 Sep 2024 09:56:42 +0200
Subject: [PATCH 22/23] Update one-time-password-sms-API-Readiness-Checklist.md
Remove empty lines
---
.../one-time-password-sms-API-Readiness-Checklist.md | 2 --
1 file changed, 2 deletions(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index 8798ffe..ea2ae44 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -13,9 +13,7 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 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 | [link](/code/Test_Definitions/one-time-password-sms.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/one-time-password-sms.feature) |
-
| 9 | Test result statement | O | O | O | M | N | |
-
| 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 | [link](https://www.open-gateway.com/operators-map) |
From d0def180eb1a2d310b7cec32bfe979309bf6c4e7 Mon Sep 17 00:00:00 2001
From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com>
Date: Thu, 5 Sep 2024 18:37:43 +0200
Subject: [PATCH 23/23] Update one-time-password-sms-API-Readiness-Checklist.md
Taking care of the Test result statement accordingly to https://github.com/camaraproject/ReleaseManagement/issues/89
---
.../one-time-password-sms-API-Readiness-Checklist.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
index ea2ae44..b99ecfd 100644
--- a/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
+++ b/documentation/API_documentation/one-time-password-sms-API-Readiness-Checklist.md
@@ -13,12 +13,12 @@ Checklist for one-time-password-sms v1.0.0 in r1.2
| 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 | [link](/code/Test_Definitions/one-time-password-sms.feature) |
| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_Definitions/one-time-password-sms.feature) |
-| 9 | Test result statement | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | Fall24 EXCEPTION: Test results 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 | [link](https://www.open-gateway.com/operators-map) |
-
+(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release.
To fill the checklist: