r4.1

Release Notes

This release candidate contains the definition and documentation of

• connectivity-insights-subscriptions 0.7.0-rc.1
• connectivity-insights 0.7.0-rc.1

The API definition(s) are based on

• Commonalities r4.3 (0.8.0)
• Identity and Consent Management r4.2 (0.5.0)

connectivity-insights-subscriptions 0.7.0-rc.1

connectivity-insights-subscriptions 0.7.0-rc.1 is a release-candidate version of this API.

Changes documented below are compared to version 0.6.0.

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

Breaking changes

• Aligned the API with CAMARA Commonalities r4.3 (0.8.0) by @maheshc01 in #198
  • Pagination for listing of subscriptions using GET /subscriptions is now supported — also listed under Changed
    • Addition of page and perPage query parameters to control pagination
    • Returned subscriptions are now embedded in the subscriptions array within the response JSON, with page metadata in the pagination object
    • Addition of response headers X-Total-Count, X-Total-Pages, and Link to facilitate page navigation

Added

• N/A

Changed

• Aligned the API with CAMARA Commonalities r4.3 (0.8.0) by @maheshc01 in #198
  • Pagination for listing of subscriptions using GET /subscriptions is now supported — also listed under Breaking changes
    • Addition of page and perPage query parameters to control pagination
    • Returned subscriptions are now embedded in the subscriptions array within the response JSON, with page metadata in the pagination object
    • Addition of response headers X-Total-Count, X-Total-Pages, and Link to facilitate page navigation
  • CloudEvent subscription replaced with allOf ref to CAMARA_event_common.CloudEvent
  • Added mandatory info.description sections (authorization and authentication, additional error responses, request body strictness)
  • Added maxLength, format, and pattern constraints to string fields

Fixed

• Fixed maxLength, pattern for ApplicationServerIpv4Address and ApplicationServerIpv6Address schemas, and fixed required properties in CreateSubscriptionDetail by @Kevsy in #209
• Fixed externalDocs.url trailing slash and externalDocs.description trailing period by @Kevsy in #214

Removed

• N/A

connectivity-insights 0.7.0-rc.1

connectivity-insights 0.7.0-rc.1 is a release-candidate version of this API.

Changes documented below are compared to version 0.6.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

• Aligned the API with CAMARA Commonalities r4.3 (0.8.0) by @maheshc01 in #198
  • Common definitions reused via $ref into CAMARA_common.yaml (Device, DeviceResponse, Port, XCorrelator, error responses)
  • Added mandatory info.description sections (authorization and authentication, additional error responses, request body strictness)
  • Added maxLength, format, minimum, and maximum constraints throughout

Fixed

• Fixed missing type: object declarations in schema definitions by @hdamker in #193
• Fixed maxLength and added pattern for ApplicationServerIpv4Address and ApplicationServerIpv6Address schemas by @Kevsy in #214
• Fixed externalDocs.description trailing period by @Kevsy in #214

Removed

• N/A

Full Changelog: r3.2...r4.1