r2.1

Release Notes

This release candidate contains the definition and documentation of

• device-roaming-status-subscriptions 0.9.0-rc.1
• device-roaming-status 1.2.0-rc.3

The API definition(s) are based on

• Commonalities 0.8.0
• Identity and Consent Management 0.5.0

device-roaming-status-subscriptions 0.9.0-rc.1

device-roaming-status-subscriptions 0.9.0-rc.1 is a release-candidate version of this API.

Changes documented below are compared to version 0.8.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 #78
  • 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

Added

• Add examples for roaming status retrieval by @bigludo7 in #53

Changed

• Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in #78
  • 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

Fixed

• fix: declare CloudEvent schema type by @hdamker in #77
• Fix example for Network Access Identifier by @bigludo7 in #58

Removed

• Delete redundant API Readiness Checklists by @eric-murray in #82

device-roaming-status 1.2.0-rc.3

device-roaming-status 1.2.0-rc.3 is a release-candidate version of this API.

Changes documented below are compared to version 1.1.0.

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

Breaking changes

• N/A

Added

• N/A

Changed

• Clarify LastStatusTime schema description in YAML by @eric-murray in #56
• Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in #78

Fixed

• Fix example label: Multiple Country Codes → Multiple Country Names by @sachinvodafone in #54
• Fix example for Network Access Identifier by @bigludo7 in #58

Removed

• Delete redundant API Readiness Checklists by @eric-murray in #82

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

r1.2

This public release contains the definition and documentation of

• device-roaming-status v1.1.0
• device-roaming-status-subscriptions v0.8.0

The API definition(s) are based on

• Commonalities v0.6.0 (r3.3)
• Identity and Consent Management v0.4.0 (r3.3)

device-roaming-status v1.1.0

device-roaming-status v1.1.0 is a minor update of the API, and is backward compatible with v1.0.0.

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

Added

Changed

• Make lastStatusTime mandatory in 200 responses of the API by @eric-murray in #19
• Update error response documentation in OAS definitions by @eric-murray in #30
• Update x-correlator schema by @eric-murray in #29
• Commonalities alignement for device roaming status by @bigludo7 in #37
• Update error schema for compliance with Commonalities r3.3 by @eric-murray in #45
• admin: migrate to centralized linting workflows by @hdamker-bot in #41

Fixed

• Fix feature files for compliance with centralised linting rules by @eric-murray in #42

Removed

• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #14
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #22

device-roaming-status-subscriptions v0.8.0

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

Added

• Add subscription started & updated event by @bigludo7 in #35

Changed

• change sink format to format: uri by @maxl2287 in #18
• Rename subscription-ends event to subscription-ended by @eric-murray in #31
• Update error response documentation in OAS definitions by @eric-murray in #30
• Update x-correlator schema by @eric-murray in #29
• Commonalities alignement for device roaming subscription by @bigludo7 in #37
• Update error schema for compliance with Commonalities r3.3 by @eric-murray in #45
• admin: migrate to centralized linting workflows by @hdamker-bot in #41

Fixed

• remove "Generic High Entropy Secret" by @maxl2287 in #17
• Fix feature files for compliance with centralised linting rules by @eric-murray in #42

Removed

• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #14
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #22

r1.1

This pre-release contains the definition and documentation of

• device-roaming-status v1.1.0-rc.2
• device-roaming-status-subscriptions v0.8.0-rc.1

The API definition(s) are based on

• Commonalities v0.6.0-rc.1 (r3.2)
• Identity and Consent Management v0.4.0-rc.1 (r3.2)

device-roaming-status v1.1.0-rc.2

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

Added

device-roaming-status v1.1.0-rc.2 is the first release candidate of the version 1.1.0

device-roaming-status v1.1.0 will be a minor update of the API, and is backward compatible with v1.0.0.

Changed

• Make lastStatusTime mandatory in 200 responses of the API by @eric-murray in #19
• Update error response documentation in OAS definitions by @eric-murray in #30
• Update x-correlator schema by @eric-murray in #29
• Commonalities alignement for device roaming status by @bigludo7 in #37

Fixed

Removed

• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #14
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #22

device-roaming-status-subscriptions v0.8.0-rc.1

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

Added

• Add subscription started & updated event by @bigludo7 in #35

Changed

• change sink format to format: uri by @maxl2287 in #18
• Rename subscription-ends event to subscription-ended by @eric-murray in #31
• Update error response documentation in OAS definitions by @eric-murray in #30
• Update x-correlator schema by @eric-murray in #29
• Commonalities alignement for device roaming subscription by @bigludo7 in #37

Fixed

• remove "Generic High Entropy Secret" by @maxl2287 in #17

Removed

• Remove AUTHENTICATION_REQUIRED error code by @eric-murray in #14
• Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in #22

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