r2.1

Release Notes

This release candidate contains the definition and documentation of

• device-data-volume-subscriptions 0.2.0-rc.1
• device-data-volume 0.2.0-rc.1

The API definition(s) are based on

• Commonalities r4.4 (0.9.0)
• Identity and Consent Management r4.2 (0.5.0)

device-data-volume-subscriptions 0.2.0-rc.1

device-data-volume-subscriptions 0.2.0-rc.1 is a release-candidate version of this API.

Changes documented below are compared to version 0.1.0.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Breaking changes

• Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in #81
  • Pagination for listing of subscriptions using GET /subscriptions is now supported
    • Addition of page and perPage query parameters to control pagination
    • Returned subscriptions are now embedded in the array subscriptions within the response JSON, with the page tracked within the pagination JSON
    • Addition of response headers X-Total-Count, X-Total-Pages and Link to facilitate page navigation
• [Changed, Breaking] Rename data allowance consumption events for clarity by @eric-murray in #106
  • Data allowance consumption events renamed for clarity:
    • org.camaraproject.device-data-volume-subscriptions.v0.data-50-percent-remaining: Event triggered when only 50% of the data plan is remaining
    • org.camaraproject.device-data-volume-subscriptions.v0.data-25-percent-remaining: Event triggered when only 25% of the data plan is remaining
    • org.camaraproject.device-data-volume-subscriptions.v0.data-10-percent-remaining: Event triggered when only 10% of the data plan is remaining
    • org.camaraproject.device-data-volume-subscriptions.v0.data-00-percent-remaining: Event triggered when the data plan is fully consumed

Added

• [Added] Add additional device data volume status subscription list scenarios and move to separate feature file by @eric-murray in #103

Changed

• Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in #81
• [Changed, Breaking] Rename data allowance consumption events for clarity by @eric-murray in #106
• [Changed] Refactor subscription schemas for Commonalities r4.4 and add initialEvent by @eric-murray in #113

Fixed

• [Fixed] Documentation fixes for Sync26 by @eric-murray in #104
• [Fix] Correct feature file name and event names / schemas within feature files by @eric-murray in #110
• [Fixed] Update subscriptionDetail reference in YAML file by @eric-murray in #114

Removed

• N/A

device-data-volume 0.2.0-rc.1

device-data-volume 0.2.0-rc.1 is a release-candidate version of this API.

Changes documented below are compared to version 0.1.0.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Breaking changes

• [Changed, Breaking] Refactor device-data-volume to return data volumes rather than categories, and use MB/GB instead of MiB/GiB by @eric-murray in #107
  • Refactor device-data-volume for simpler and more intuitive behaviour:
    • Use MB/GB instead of MiB/GiB for data allowances
    • Return remaining data allowance rather than data allowance category, allowing "Unlimited" as a response option
    • Rename properties for clarity:
      • Request property volumeToCheck becomes dataAllowanceThreshold
      • Response property dataVolumeCategory becomes remainingDataAllowance

Added

• [Added] Add lastStatusTime field to successful responses with examples by @eric-murray in #89
• [Added] Update happy path tests to include validation of lastStatusTime property by @eric-murray in #97

Changed

• Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in #81
• [Changed, Breaking] Refactor device-data-volume to return data volumes rather than categories, and use MB/GB instead of MiB/GiB by @eric-murray in #107

Fixed

• [Fixed] Documentation fixes for Sync26 by @eric-murray in #104

Removed

• N/A

Full Changelog: r1.3...r2.1

r1.3

Release Notes

This initial public release contains the definition and documentation of

• device-data-volume v0.1.0
• device-data-volume-subscriptions v0.1.0

The API definition(s) are based on

• Commonalities r3.3
• Identity and Consent Management r3.3

device-data-volume v0.1.0

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Basic test specifications for both Device Data Volume and its Subscription by @sachinvodafone in #13
• Add response-component for /check - API incl. thresholdExceeded as property by @maxl2287 in #33
• Add gherkin-linting and update links in config by @maxl2287 in #37
• Documented Error Responses info.description section by @maxl2287 in #47

Changed

• Migrate to centralized linting workflows by @hdamker-bot in #67
• Fix links to API description in API readiness checklists by @eric-murray in #65
• Reset version to wip following alpha release by @eric-murray in #17
• Update error codes and format by @maxl2287 in #19
• Alignment with Commonalities 0.5 by @maxl2287 in #28
• Update test-scenarios for device-data-volume- and subscription - APIs by @maxl2287 in #34
• Mark device as optional by adding support for 3-legged token by @maxl2287 in #35
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #52
• Update x-correlator pattern by @maxl2287 in #49

Removed

• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #40

device-data-volume-subscriptions v0.1.0

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Basic test specifications for both Device Data Volume and Its Subscription by @sachinvodafone in #13
• Add gherkin-linting and update links in config by @maxl2287 in #37
• Documented Error Responses info.description section by @maxl2287 in #47

Changed

• Migrate to centralized linting workflows by @hdamker-bot in #67
• Fix links to API description in API readiness checklists by @eric-murray in #65
• Reset version to wip following alpha release by @eric-murray in #17
• Update error codes and format by @maxl2287 in #19
• Alignment with Commonalities 0.5 by @maxl2287 in #28
• Update test-scenarios for device-data-volume- and subscription - APIs by @maxl2287 in #34
• Mark device as optional by adding support for 3-legged token by @maxl2287 in #35
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #52
• Update the sink - pattern and set id in SubscriptionAsync to mandatory by @maxl2287 in #61
• [data-volume-subscriptions]: update subscription-ends to subscription-ended and add subscription-started and subscription-updated by @maxl2287 in #56
• Update x-correlator pattern by @maxl2287 in #49

Fixed

• Add missing components and update Subscription types array items by @dfischer-tech in #24

Removed

• Remove allof in sinkcredential by @ravindrapalaskar17 in #27
• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #40

New Contributors

• @maxl2287 made their first contribution in #19
• @sachinvodafone made their first contribution in #13
• @dfischer-tech made their first contribution in #24
• @ravindrapalaskar17 made their first contribution in #27
• @hdamker-bot made their first contribution in #45

Full Changelog: https://github.com/camaraproject/DeviceDataVolume/commits/r1.3

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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Basic test specifications for both Device Data Volume and its Subscription by @sachinvodafone in #13
• Add response-component for /check - API incl. thresholdExceeded as property by @maxl2287 in #33
• Add gherkin-linting and update links in config by @maxl2287 in #37
• Documented Error Responses info.description section by @maxl2287 in #47

Changed

• Reset version to wip following alpha release by @eric-murray in #17
• Update error codes and format by @maxl2287 in #19
• Alignment with Commonalities 0.5 by @maxl2287 in #28
• Update test-scenarios for device-data-volume- and subscription - APIs by @maxl2287 in #34
• Mark device as optional by adding support for 3-legged token by @maxl2287 in #35
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #52
• Update x-correlator pattern by @maxl2287 in #49

Removed

• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Basic test specifications for both Device Data Volume and Its Subscription by @sachinvodafone in #13
• Add gherkin-linting and update links in config by @maxl2287 in #37
• Documented Error Responses info.description section by @maxl2287 in #47

Changed

• Reset version to wip following alpha release by @eric-murray in #17
• Update error codes and format by @maxl2287 in #19
• Alignment with Commonalities 0.5 by @maxl2287 in #28
• Update test-scenarios for device-data-volume- and subscription - APIs by @maxl2287 in #34
• Mark device as optional by adding support for 3-legged token by @maxl2287 in #35
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #52
• Update the sink - pattern and set id in SubscriptionAsync to mandatory by @maxl2287 in #61
• [data-volume-subscriptions]: update subscription-ends to subscription-ended and add subscription-started and subscription-updated by @maxl2287 in #56
• Update x-correlator pattern by @maxl2287 in #49

Fixed

• Add missing components and update Subscription types array items by @dfischer-tech in #24

Removed

• Remove allof in sinkcredential by @ravindrapalaskar17 in #27
• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #40

New Contributors

• @maxl2287 made their first contribution in #19
• @sachinvodafone made their first contribution in #13
• @dfischer-tech made their first contribution in #24
• @ravindrapalaskar17 made their first contribution in #27
• @hdamker-bot made their first contribution in #45

Full Changelog: r1.1...r1.2

r1.1

r1.1

Release Notes

This pre-release contains the definition and documentation of:

• device-data-volume v0.1.0-alpha.1
• device-data-volume-subscriptions v0.1.0-alpha.1

device-data-volume v0.1.0-alpha.1

Version 0.1.0-alpha.1 is the first alpha release of device-data-volume

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• First alpha version of device-data-volume.yaml provided by @VijayKesharwani

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

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• First version of device-data-volume-subscriptions.yaml provided by @VijayKesharwani

---

Full Changelog: https://github.com/camaraproject/DeviceDataVolume/commits/r1.1