Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Test Definition and patch release r1.3 #148

Merged
merged 14 commits into from
Oct 1, 2024
Merged
45 changes: 45 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,58 @@

## Table of contents

- **[r1.3](#r13)**
- **[r1.2](#r12)**
- **[r1.1](#r11)**
- **[v0.3.1](#v031)**


**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.3

## Release Notes

This patch release contains the definition and documentation of
* number-verification 1.0.0

The API definition(s) are based on
* Commonalities v0.4.0
* Identity and Consent Management v0.2.0

**Note:
The API definition is unchanged compared to [r1.2](#r12). The patch release r1.3 fixes only 4 test definition scenarios as listed below.**

## number-verification 1.0.0

**number-verification 1.0.0 is the release of the first stable version of the NumberVerification API.**

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.3/code/API_definitions/number-verification.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.3/code/API_definitions/number-verification.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.3/code/API_definitions/number-verification.yaml)

### Added


### Changed


### Fixed

* @NumberVerification_phone_number_share201_missing_scope: Changed code to PERMISSION_DENIED (previous was UNAUTHENTICATED) [PR148](https://github.com/camaraproject/NumberVerification/pull/148)
* @NumberVerification_phone_number_share202_expired_access_token: Changed code to UNAUTHENTICATED (previous was AUTHENTICATION_REQUIRED) [PR148](https://github.com/camaraproject/NumberVerification/pull/148)
* @NumberVerification_verify201_missing_scope: Changed code to PERMISSION_DENIED (previous was UNAUTHENTICATED) [PR148](https://github.com/camaraproject/NumberVerification/pull/148)
* @NumberVerification_verify202_expired_access_token: Changed code to UNAUTHENTICATED (previous was AUTHENTICATION_REQUIRED) [PR148](https://github.com/camaraproject/NumberVerification/pull/148)

### Removed


## New Contributors
* N/A



# r1.2

## Release Notes
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ Repository to describe, develop, document and test the NumberVerification API fa

## Meetings

* Current schedule, registration, & meeting links are available on the confluence page: [Meetings information](https://wiki.camaraproject.org/display/CAM/NumberVerification)
* Current schedule, registration, & meeting links are available on the confluence page: [Meetings information](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14562399/NumberVerification)



## 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 with version 1.0.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r1.2)
* `NEW`: Release r1.3 with version 1.0.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r1.3)
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number-verification.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number-verification.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number-verification.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.3/code/API_definitions/number-verification.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.3/code/API_definitions/number-verification.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.3/code/API_definitions/number-verification.yaml)

* Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/NumberVerification/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Feature: Camara Number Verification API device phone number share
And the response body complies with the OAS schema at "/components/schemas/ErrorInfo"
Then the response status code is 403
And the response property "$.status" is 403
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" is "Request not authenticated due to missing, invalid, or expired credentials."
And the response property "$.code" is "PERMISSION_DENIED"
And the response property "$.message" is "Client does not have sufficient permissions to perform this action."

@NumberVerification_phone_number_share202_expired_access_token
Scenario: share phone number with expired access token
Expand All @@ -66,8 +66,8 @@ Feature: Camara Number Verification API device phone number share
And the response body complies with the OAS schema at "/components/schemas/ErrorInfo"
Then the response status code is 401
And the response property "$.status" is 401
And the response property "$.code" is "AUTHENTICATION_REQUIRED"
And the response property "$.message" is "New authentication is required."
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" is "Request not authenticated due to missing, invalid, or expired credentials."

@NumberVerification_phone_number_share203_no_phonenumber_associated_with_access_token
Scenario: share phone number with valid access token that is not associated with a phone number
Expand Down
8 changes: 4 additions & 4 deletions code/Test_Definitions/number-verification-verify.feature
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,8 @@ Feature: Camara Number Verification API verify
And the response body complies with the OAS schema at "/components/schemas/ErrorInfo"
Then the response status code is 403
And the response property "$.status" is 403
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" is "Request not authenticated due to missing, invalid, or expired credentials."
And the response property "$.code" is "PERMISSION_DENIED"
And the response property "$.message" is "Client does not have sufficient permissions to perform this action."

@NumberVerification_verify202_expired_access_token
Scenario: verify phone number with expired access token
Expand All @@ -147,8 +147,8 @@ Feature: Camara Number Verification API verify
And the response body complies with the OAS schema at "/components/schemas/ErrorInfo"
Then the response status code is 401
And the response property "$.status" is 401
And the response property "$.code" is "AUTHENTICATION_REQUIRED"
And the response property "$.message" is "New authentication is required."
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" is "Request not authenticated due to missing, invalid, or expired credentials."

@NumberVerification_verify203_both_phone_number_and_hashed_in_request
Scenario: verify phone number but providing both plain and hashed phone number in the body
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Readiness Checklist

Checklist for number-verification 1.0.0 in release r1.2
Checklist for number-verification 1.0.0 in release r1.3

| Nr | API release assets | alpha | release-candidate | public-release<br>initial | public-release<br> stable | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
Expand Down