Merge pull request #201 from fernandopradocabrillo/prepare-r1.4

Prepare maintenance release r1.4

Author: fernandopradocabrillo

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Table of contents
 
+- **[r1.4](#r14)**
 - **[r1.3](#r13)**
 - **[r1.2](#r12)**
 - **[r1.1](#r11)**
@@ -15,6 +16,47 @@ The below sections record the changes for each API version in each release as fo
 * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
 * for a public API version, the consolidated changes since the release of the previous public API version
 
+# r1.4
+
+## Release Notes
+
+This release contains the definition and documentation of
+* sim-swap 1.0.0
+* sim-swap-subscriptions 0.1.2
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.0
+
+## sim-swap 1.0.0
+
+**sim-swap 1.0.0 is the public release for v1.0.0 of the Sim Swap API.**
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.4/code/API_definitions/sim-swap.yaml)
+
+**Main Changes**
+* SIM Swap API remains untouched in this release as only SIM Swap Subscriptions has been updated
+
+## Sim Swap Subscriptions v0.1.2
+
+**sim-swap-subscriptions 0.1.2 is the public release for v0.1.2 of the Sim Swap Subscriptions API.**
+
+- API definition **with inline documentation**:
+    - OpenAPI [YAML spec file](https://github.com/camaraproject/SimSwap/blob/r1.4/code/API_definitions/sim-swap-subscriptions.yaml)
+    - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap-subscriptions.yaml&nocors)
+    - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap-subscriptions.yaml)
+
+**Main Changes**
+* Include `HTTP error 403 INVALID_TOKEN_CONTEXT` in the subscription POST creation endpoint and also add the missing `SUBSCRIPTION_DELETED` terminationReason.
+
+### Added
+* Include 403 INVALID_TOKEN_CONTEXT and SUBSCRIPTION_DELETED terminationReason by @fernandopradocabrillo in https://github.com/camaraproject/SimSwap/pull/200
+
+**Full Changelog**: https://github.com/camaraproject/SimSwap/compare/r1.3...r1.4
+
 # r1.3
 
 ## Release Notes

README.md

@@ -8,31 +8,30 @@
 
 # SimSwap
 
-Repository to describe, develop, document and test the SimSwap API family
+Repository to describe, develop, document and test the SimSwap APIs
 
 ## Scope
 
 * Service APIs for “SimSwap” (see APIBacklog.md)  
-* It provides the customer with the ability to:  
+* It provides the API Consumer with the ability to:  
   * obtain information on any recent SIM pairing change related to the User’s mobile account.
 * Describe, develop, document and test the APIs (with 1-2 Telcos)  
 * Started: October 2022
-* Location: virtually  
 
 ## 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.3 features following APIs:
-  * version 1.0.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.3)
+* `NEW`: Release r1.4 features following APIs:
+  * version 1.0.0 of the **API sim-swap** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.4)
     * API definitions **with inline documentation**:
-      * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.3/code/API_definitions/sim-swap.yaml)
-      * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap.yaml&nocors) 
-      * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap.yaml)
-  * version 0.1.1 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.3)
+      * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.4/code/API_definitions/sim-swap.yaml)
+      * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap.yaml&nocors) 
+      * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap.yaml)
+  * version 0.1.2 of the **API sim-swap-subscriptions** - available [here](https://github.com/camaraproject/SimSwap/tree/r1.4)
      * API definitions **with inline documentation**:
-       * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.3/code/API_definitions/sim-swap-subscriptions.yaml)
-       * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap-subscriptions.yaml&nocors) 
-       * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.3/code/API_definitions/sim-swap-subscriptions.yaml)
+       * OpenAPI [YAML](https://github.com/camaraproject/SimSwap/blob/r1.4/code/API_definitions/sim-swap-subscriptions.yaml)
+       * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap-subscriptions.yaml&nocors) 
+       * [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r1.4/code/API_definitions/sim-swap-subscriptions.yaml)
 
  * The latest public release is available here: https://github.com/camaraproject/SimSwap/releases/latest
  * Other releases of this sub project are available in https://github.com/camaraproject/SimSwap/releases

code/API_definitions/sim-swap-subscriptions.yaml

@@ -62,14 +62,14 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.1.2
   x-camara-commonalities: 0.4.0
 
 externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/
 servers:
-  - url: '{apiRoot}/sim-swap-subscriptions/vwip'
+  - url: '{apiRoot}/sim-swap-subscriptions/v0.1'
 
     variables:
       apiRoot:
@@ -958,11 +958,17 @@ components:
           schema:
             $ref: "#/components/schemas/ErrorInfo"
           examples:
-            PermissionDenied:
+            GENERIC_403_PERMISSION_DENIED:
               value:
                 status: 403
                 code: "PERMISSION_DENIED"
                 message: "Client does not have sufficient permissions to perform this action"
+            GENERIC_403_INVALID_TOKEN_CONTEXT:
+              description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
+              value:
+                status: 403
+                code: INVALID_TOKEN_CONTEXT
+                message: "config.subscriptionDetail.phoneNumber is not consistent with access token."
             TokenMismatch:
               value:
                 status: 403
@@ -984,12 +990,6 @@ components:
                 status: 403
                 code: PERMISSION_DENIED
                 message: Client does not have sufficient permissions to perform this action.
-            GENERIC_403_INVALID_TOKEN_CONTEXT:
-              description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
-              value:
-                status: 403
-                code: INVALID_TOKEN_CONTEXT
-                message: "config.subscriptionDetail.phoneNumber is not consistent with access token."
     Generic404:
       description: Resource Not Found
       headers:

code/Test_definitions/sim-swap-subscriptions.feature

@@ -1,12 +1,12 @@
-Feature: CAMARA sim swap subscriptions  API, v0.1.1
+Feature: CAMARA sim swap subscriptions  API, v0.1.2
   # Input to be provided by the implementation to the tester
   #
   # Testing assets:
   # * A mobile line identified by its phone number "phoneNumber" associated with a sim card 1
   # * Be able to perform a sim swap for this mobile line shifting from sim card 1 to sim card 2
   # * a callback url identified as "callbackUrl" allows to receive notification
   #
-  # References to OAS spec schemas refer to schemas specifies in sim-swap-subscriptions.yaml, version v0.1.1
+  # References to OAS spec schemas refer to schemas specifies in sim-swap-subscriptions.yaml, version v0.1.2
 
   Background: Common subscriptions setup
     Given the resource "/sim-swap-subscriptions/v0.1/subscriptions" as BaseURL                                                            |
@@ -317,30 +317,6 @@ Feature: CAMARA sim swap subscriptions  API, v0.1.1
     And the response property "$.code" is "INVALID_TOKEN_CONTEXT"
     And the response property "$.message" contains a user friendly text
 
-
-  @sim_swap_subscription_retrieve_61_phone_number_token_mismatch
-  Scenario: Inconsistent access token context for the phone number
-    # To test this, a token have to be obtained for a different phone number
-    Given an existing subscription for a phone number
-    And the header "Authorization" is set to a valid access token emitted for a different phone number
-    And use BaseUrL
-    When the HTTP "GET" request is sent
-    Then the response property "$.status" is 403
-    And the response property "$.code" is "INVALID_TOKEN_CONTEXT"
-    And the response property "$.message" contains a user friendly text
-
-
-  @sim_swap_subscription_delete_62_device_token_mismatch
-  Scenario: Inconsistent access token context for the device
-    # To test this, a token have to be obtained for a different device
-    Given an existing subscription for a phone number
-    And the header "Authorization" is set to a valid access token emitted for a different phone number
-    And use BaseUrL
-    When the HTTP "DELETE" request is sent
-    Then the response property "$.status" is 403
-    And the response property "$.code" is "INVALID_TOKEN_CONTEXT"
-    And the response property "$.message" contains a user friendly text
-
 ##################
 # Error Code 404
 ##################

documentation/API_documentation/sim-swap-subscriptions-API-Readiness-Checklist.md

@@ -1,14 +1,14 @@
 # API Readiness Checklist
 
-Checklist for sim-swap-subscriptions 0.1.1 in r1.3
+Checklist for sim-swap-subscriptions 0.1.2 in r1.4
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|------|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   |  [link](code/API_definitions/sim-swap-subscriptions.yaml) |
 |  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   |       |
 |  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   | Embedded documentation into API spec - [link](/code/API_definitions/sim-swap.yaml) |
+|  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | Embedded documentation into API spec - [link](/code/API_definitions/sim-swap-subscriptions.yaml) |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |  N   |    |
 |  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [link](/code/Test_definitions/sim-swap-subscriptions.feature) |
 |  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   |      |