Prepare r3.1 #206
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,7 +27,13 @@ Incubating API Repository to evolve and maintain the definitions and documentati | |
|
|
||
| * 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**: The pre-release r3.1 with version 2.1.0-rc.1 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r3.1) | ||
| - 2.1.0-rc.1 Number Verification definition **with inline documentation**: | ||
| - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r3.1/code/API_definitions/number-verification.yaml) | ||
| - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.1/code/API_definitions/number-verification.yaml&nocors) | ||
| - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.1/code/API_definitions/number-verification.yaml) | ||
|
|
||
| * The latest public release r2.4 with version 2.0.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r2.4) | ||
| - 2.0.0 Number Verification definition **with inline documentation**: | ||
| - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r2.4/code/API_definitions/number-verification.yaml) | ||
| - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r2.4/code/API_definitions/number-verification.yaml&nocors) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -72,16 +72,16 @@ info: | |
|
|
||
| In the case of the Number Verification API scenario and according to the API definition, 3-legged access tokens must be used by API clients to invoke this API with dedicated scope. The API client must authenticate on behalf of a specific user to use this service. This must be done via mobile network authentication. | ||
|
|
||
| version: 2.1.0-rc.1 | ||
| x-camara-commonalities: 0.6 | ||
| license: | ||
| name: Apache 2.0 | ||
| url: https://www.apache.org/licenses/LICENSE-2.0.html | ||
| externalDocs: | ||
| description: Project documentation at CAMARA | ||
| url: https://github.com/camaraproject/NumberVerification | ||
| servers: | ||
| - url: '{apiRoot}/number-verification/v2rc1' | ||
| variables: | ||
| apiRoot: | ||
| default: http://localhost:9091 | ||
|
|
@@ -279,20 +279,13 @@ components: | |
| code: | ||
| enum: | ||
| - UNAUTHENTICATED | ||
| examples: | ||
| GENERIC_401_UNAUTHENTICATED: | ||
| description: Request cannot be authenticated and a new authentication is required | ||
| value: | ||
| status: 401 | ||
| code: UNAUTHENTICATED | ||
| message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required. | ||
| PhoneNumberVerificationPermissionDenied403: | ||
| description: | | ||
| Client does not have sufficient permission. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,22 @@ | ||
| # API Readiness Checklist | ||
|
|
||
| Checklist for number-verification v2.1.0 in release r3.1 | ||
fernandopradocabrillo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | 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/number-verification.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 | | | ||
| | 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/number-verification.yaml) | | ||
| | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | | ||
| | 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](code/Test_Definitions/number-verification-phoneNumberShare.feature) [verify](/code/Test_Definitions/number-verification-phoneNumberVerify.feature) | | ||
| | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](code/Test_Definitions/number-verification-phoneNumberShare.feature) [verify](code/Test_Definitions/number-verification-phoneNumberVerify.feature) | | ||
| | 9 | Test result statement | O | O | O | M | N | see [issue #166](https://github.com/camaraproject/NumberVerification/issues/166) | | ||
fernandopradocabrillo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | 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) | | ||
| | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81134263/NumberVerification+API+description) | | ||
|
|
||
|
|
||
| To fill the checklist: | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.