Prepare r1.2

CHANGELOG.md

@@ -1,10 +1,98 @@
-# DeviceDataVolume Changelog
-
-> **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.**
+# Changelog DeviceDataVolume
 
 ## Table of Contents
-- **[r1.1](#r11)**
+- **[r1.2](#r12)**
+- [r1.1](#r11)
+
+**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.**
+
+The below sections record the changes for each API version in each release as follows:
+
+* for an alpha release, the delta with respect to the previous release
+* for the first release-candidate, all changes since the last public release
+* for subsequent release-candidate(s), only the delta to the previous release-candidate
+* for a public release, the consolidated changes since the previous public release
+
+# r1.2
+
+## Release Notes
+
+This release contains the definition and documentation of
+* device-data-volume v0.1.0-rc.1
+* device-data-volume-subscriptions v0.1.0-rc.1
+
+The API definition(s) are based on
+* Commonalities 0.6
+* Identity and Consent Management 0.4
+
+## device-data-volume v0.1.0-rc.1
+
+**device-data-volume v0.1.0-rc.1 is the first release-candidate of the DeviceDataVolume API v0.1.0**
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceDataVolume/blob/r1.2/code/API_definitions/device-data-volume.yaml)
+
+### Added
+* Basic test specifications for both Device Data Volume and its Subscription by @sachinvodafone in https://github.com/camaraproject/DeviceDataVolume/pull/13
+* Add response-component for `/check` - API incl. `thresholdExceeded` as property by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/33
+* Add gherkin-linting and update links in config by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/37 
+* Documented Error Responses info.description section by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/47
+
+### Changed
+* Reset version to wip following alpha release by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/17
+* Update error codes and format by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/19
+* Alignment with Commonalities 0.5 by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/28
+* Update test-scenarios for device-data-volume- and subscription - APIs by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/34
+* Mark `device` as optional by adding support for 3-legged token by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/35
+* Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/52
+* Update `x-correlator` pattern by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/49
+
+
+### Removed
+* Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/40
+
+## device-data-volume-subscriptions v0.1.0-rc.1
+
+**device-data-volume-subscriptions v0.1.0-rc.1 is the first release-candidate of the DeviceDataVolume-Subscriptions API v0.1.0**
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume-subscriptions.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceDataVolume/blob/r1.2/code/API_definitions/device-data-volume-subscriptions.yaml)
+
+### Added
+* Basic test specifications for both Device Data Volume and Its Subscription by @sachinvodafone in https://github.com/camaraproject/DeviceDataVolume/pull/13
+* Add gherkin-linting and update links in config by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/37
+* Documented Error Responses info.description section by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/47
+
+### Changed
+* Reset version to wip following alpha release by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/17
+* Update error codes and format by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/19
+* Alignment with Commonalities 0.5 by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/28
+* Update test-scenarios for device-data-volume- and subscription - APIs by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/34
+* Mark `device` as optional by adding support for 3-legged token by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/35
+* Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/52
+* Update the `sink` - pattern and set `id` in `SubscriptionAsync` to mandatory by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/61
+* [data-volume-subscriptions]: update `subscription-ends` to `subscription-ended` and add `subscription-started` and `subscription-updated` by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/56
+* Update `x-correlator` pattern by @maxl2287 in https://github.com/camaraproject/DeviceDataVolume/pull/49
+
+### Fixed
+* Add missing components and update Subscription types array items by @dfischer-tech in https://github.com/camaraproject/DeviceDataVolume/pull/24
+
+### Removed
+* Remove allof in sinkcredential by @ravindrapalaskar17 in https://github.com/camaraproject/DeviceDataVolume/pull/27
+* Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/40
+
+## New Contributors
+* @maxl2287 made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/19
+* @sachinvodafone made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/13
+* @dfischer-tech made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/24
+* @ravindrapalaskar17 made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/27
+* @hdamker-bot made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/45
+
+**Full Changelog**: https://github.com/camaraproject/DeviceDataVolume/compare/r1.1...r1.2
 
 # r1.1
 ## Release Notes
@@ -15,7 +103,7 @@ This pre-release contains the definition and documentation of:
 
 ## device-data-volume v0.1.0-alpha.1
 
-Version 0.1.0-alpha.1 is the first alpha release of device-data-volume
+**device-data-volume v0.1.0-alpha.1 is the first alpha-release of the API**
 
 - API definition **with inline documentation**:
   - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.1/code/API_definitions/device-data-volume.yaml&nocors)
@@ -27,7 +115,7 @@ Version 0.1.0-alpha.1 is the first alpha release of device-data-volume
 
 ## device-data-volume-subscriptions v0.1.0-alpha.1
 
-Version 0.1.0-alpha.1 is the first alpha release of device-data-volume-subscriptions
+**device-data-volume-subscriptions v0.1.0-alpha.1 is the first alpha-release of the API**
 
 - API definition **with inline documentation**:
   - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.1/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
@@ -37,5 +125,4 @@ Version 0.1.0-alpha.1 is the first alpha release of device-data-volume-subscript
 ### Added
 * First version of device-data-volume-subscriptions.yaml provided by @VijayKesharwani
 
----
 **Full Changelog**: https://github.com/camaraproject/DeviceDataVolume/commits/r1.1

README.md

@@ -24,16 +24,16 @@ Sandbox API Repository to describe, develop, document, and test the DeviceDataVo
 
 ## Release Information
 
-* **The latest public pre-release is [r1.1](https://github.com/camaraproject/DeviceDataVolume/tree/r1.1) with the following API definitions:**
-
-  * **device-data-volume v0.1.0-alpha.1**  
-  [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.1/code/API_definitions/device-data-volume.yaml)
-  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.1/code/API_definitions/device-data-volume.yaml&nocors)
-  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.1/code/API_definitions/device-data-volume.yaml)
-  * **device-data-volume-subscriptions v0.1.0-alpha.1**  
-  [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.1/code/API_definitions/device-data-volume-subscriptions.yaml)
-  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.1/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
-  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.1/code/API_definitions/device-data-volume-subscriptions.yaml)
+* **The latest pre-release is [r1.2](https://github.com/camaraproject/DeviceDataVolume/tree/r1.2) with the following API definitions:**
+
+  * **device-data-volume v0.1.0-rc.1**  
+  [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.2/code/API_definitions/device-data-volume.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume.yaml&nocors)
+  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume.yaml)
+  * **device-data-volume-subscriptions v0.1.0-rc.1**  
+  [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.2/code/API_definitions/device-data-volume-subscriptions.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
+  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.2/code/API_definitions/device-data-volume-subscriptions.yaml)
 
 - Current work-in-progress version is available within the [main branch](https://github.com/camaraproject/DeviceDataVolume)
 

code/API_definitions/device-data-volume-subscriptions.yaml

@@ -88,15 +88,15 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
-  x-camara-commonalities: 0.5
+  version: 0.1.0-rc.1
+  x-camara-commonalities: 0.6
 
 externalDocs:
   description: Project documentation at CAMARA
   url: https://github.com/camaraproject/DeviceDataVolume
 
 servers:
-  - url: "{apiRoot}/device-data-volume-subscriptions/vwip"
+  - url: "{apiRoot}/device-data-volume-subscriptions/v0.1rc1"
     variables:
       apiRoot:
         default: http://localhost:9091

code/API_definitions/device-data-volume.yaml

@@ -4,7 +4,7 @@ info:
   description: |
     This API offers detailed insights into the customer's data usage status, including available data volume and their current position within the volume allocation.
 
-    #  Introduction
+    # Introduction
 
     API consumers are able to retrieve data usage information for a dedicated SIM card, offering estimated remaining data volume categories like <200MiB, <1GiB, <5GiB, and >=5GiB. It also allows subscription to changes in data volume status.
 
@@ -61,15 +61,15 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
-  x-camara-commonalities: 0.5
+  version: 0.1.0-rc.1
+  x-camara-commonalities: 0.6
 
 externalDocs:
   description: Project documentation at CAMARA
   url: https://github.com/camaraproject/DeviceDataVolume
 
 servers:
-  - url: "{apiRoot}/device-data-volume/vwip"
+  - url: "{apiRoot}/device-data-volume/v0.1rc1"
     variables:
       apiRoot:
         default: http://localhost:9091

code/Test_definitions/device-data-volume-checkDataVolume.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Device Data Volume API, vwip - Operation checkDataVolume
+Feature: CAMARA Device Data Volume API, v0.1.0-rc.1 - Operation checkDataVolume
 
   # Input to be provided by the implementation to the tester
   #
@@ -9,14 +9,12 @@ Feature: CAMARA Device Data Volume API, vwip - Operation checkDataVolume
   # * A device object which device data volume is known by the network when connected.
   # * The known device data volume status of the testing device
   #
-  # References to OAS spec schemas refer to schemas specifies in device-data-volume.yaml
+  # References to OAS spec schemas refer to schemas specified in device-data-volume.yaml
 
   Background: Common checkDataVolume setup
-    Given an environment at "apiRoot"
-    And the resource "/device-data-volume/vwip/check" set as base-url
-    And the header "Content-Type" is set to "application/json"
+    Given the resource "/device-data-volume/v0.1rc1/check"
     And the header "Authorization" is set to a valid access token
-    And the header "x-correlator" is set to a UUID value
+    And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
     And the request body is set by default to a request body compliant with the schema "#/components/schemas/CheckDataVolumeRequest"
 
 ##########################

code/Test_definitions/device-data-volume-retrieveDataVolume.feature

@@ -1,22 +1,21 @@
-Feature: CAMARA Device Data Volume API, vwip - Operation retrieveDataVolume
+Feature: CAMARA Device Data Volume API, v0.1.0-rc.1 - Operation retrieveDataVolume
 
   # Input to be provided by the implementation to the tester
-  #
-  # Implementation indications:
-  # * List of device identifier types which are not supported, among: phoneNumber, networkAccessIdentifier, ipv4Address, ipv6Address
-  #
+
+  # If the subscription leverages the 'device' object the following indication must be present:
+  #    Implementation indications:
+  #      * List of device identifier types which are not supported, such as: phoneNumber, networkAccessIdentifier, ipv4Address, ipv6Address
+
   # Testing assets:
-  # * A device object which device data volume is known by the network when connected.
-  # * The known device data volume status of the testing device
+  #       A device object which device data volume is known by the network when connected.
+  #       The known device data volume status of the testing device
   #
-  # References to OAS spec schemas refer to schemas specifies in device-data-volume.yaml
+  # References to OAS spec schemas refer to schemas specified in device-data-volume.yaml
 
   Background: Common retrieveDataVolume setup
-    Given an environment at "apiRoot"
-    And the resource "/device-data-volume/vwip/retrieve" set as base-url
-    And the header "Content-Type" is set to "application/json"
+    Given the resource "/device-data-volume/v0.1rc.1/retrieve"
     And the header "Authorization" is set to a valid access token
-    And the header "x-correlator" is set to a UUID value
+    And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
     And the request body is set by default to a request body compliant with the schema "#/components/schemas/RetrieveDataVolumeRequest"
 
 ##########################

code/Test_definitions/device-data-volume-subscriptions.feature

@@ -1,18 +1,20 @@
-Feature: Device Data Volume Subscriptions API, vwip - Operation createDeviceDataVolumeSubscription
+Feature: Device Data Volume Subscriptions API, v0.1.0-rc.1 - Operation on subscriptions
 
   # Input to be provided by the implementation to the tester
   #
-  # Implementation indications:
-  # * List of device identifier types which are not supported, among: phoneNumber, networkAccessIdentifier, ipv4Address, ipv6Address
+  # If the subscription leverages the 'device' object the following indication must be present:
+  #    Implementation indications:
+  #      * List of device identifier types which are not supported, such as: phoneNumber, networkAccessIdentifier, ipv4Address, ipv6Address
   #
   # Testing assets:
-  # * A device object which device data volume is known by the network when connected.
-  # * The known device data volume status of the testing device
+  #       A sink-url identified as "callbackUrl", which receives notifications
+  #       A device object which device data volume is known by the network when connected.
+  #       The known device data volume status of the testing device
   #
-  # References to OAS spec schemas refer to schemas specifies in device-data-volume-subscriptions.yaml
+  # References to OAS spec schemas refer to schemas specified in device-data-volume-subscriptions.yaml
 
   Background: Common Device Data Volume setup
-    Given the resource "{apiroot}/device-data-volume-subscriptions/vwip/subscriptions" as base-url
+    Given the resource "/device-data-volume-subscriptions/v0.1rc1/subscriptions"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"