This public release contains the definition and documentation of

• connectivity-insights v0.6.0
• connectivity-insights-subscriptions v0.6.0

The API definition(s) are based on

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

connectivity-insights v0.6.0

connectivity-insights v0.6.0 is the public release of the version 0.6.0

• API definition with inline documentation:
  • [View it on ReDoc]
  • [View it on Swagger Editor]
  • [OpenAPI]

Added

• Added error response documentation in info.description

Changed

• Adjusted x-correlator pattern as defined in CAMARA Commonalities
• Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one
• Align with latest Commonalities in #166

Removed

• Removed AUTHENTICATION_REQUIRED error
• Removed the IDENTIFIER_MISMATCH error code option from 422 responses

connectivity-insights-subscriptions v0.6.0

connectivity-insights-subscriptions v0.6.0 is the public release of the version 0.6.0

• API definition with inline documentation:
  • [View it on ReDoc]
  • [View it on Swagger Editor]
  • [OpenAPI]

Added

• Added error response documentation in info.description

Changed

• Adjusted x-correlator pattern as defined in CAMARA Commonalities
• Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one
• Subscription event type subscription-ends renamed to subscription-ended
• Align with latest Commonalities in #166

Removed

• Removed AUTHENTICATION_REQUIRED error
• Removed the IDENTIFIER_MISMATCH error code option from 422 responses

Full Changelog: r2.2...r3.2

This pre-release contains the definition and documentation of

• connectivity-insights v0.6.0-rc.1
• connectivity-insights-subscriptions v0.6.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)

connectivity-insights v0.6.0-rc.1

connectivity-insights v0.6.0-rc.1 is the first release candidate of the version 0.6.0

• API definition with inline documentation:
  • [View it on ReDoc]
  • [View it on Swagger Editor]
  • [OpenAPI]

Added

• Added error response documentation in info.description

Changed

• Adjusted x-correlator pattern as defined in CAMARA Commonalities
• Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one

Removed

• Removed AUTHENTICATION_REQUIRED error
• Removed the IDENTIFIER_MISMATCH error code option from 422 responses

connectivity-insights-subscriptions v0.6.0-rc.1

connectivity-insights-subscriptions v0.6.0-rc.1 is the first release candidate of the version 0.6.0

• API definition with inline documentation:
  • [View it on ReDoc]
  • [View it on Swagger Editor]
  • [OpenAPI]

Added

• Added error response documentation in info.description

Changed

• Adjusted x-correlator pattern as defined in CAMARA Commonalities
• Updated documentation regarding device identifiers in responses and added DeviceResponse object to limit device identifiers in responses to exactly one
• Subscription event type subscription-ends renamed to subscription-ended

Removed

• Removed AUTHENTICATION_REQUIRED error
• Removed the IDENTIFIER_MISMATCH error code option from 422 responses

Full Changelog: r2.2...r3.1

Release Notes

This public release contains the definition and documentation of

• connectivity-insights v0.5.0
• connectivity-insights-subscriptions v0.5.0
• application-profiles v0.4.0

The API definition(s) are based on

• Commonalities 0.5.0

• Identity and Consent Management v0.3.0

• r2.2 release of ConnectivityInsights has the following API definitions:

  • connectivity-insights v0.5.0
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

  • connectivity-insights-subscriptions v0.5.0
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

  • application-profiles v0.4.0
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

Changed

• Changes requested by Release Management for M4
• Error names and structures updated
• removed 406 and 5xx errors
• security component updated
• x-camara-commonalities version updated
• Device identifier updates
• Template text for identifying devices updated
• Test guidelines updated to incorporate changed errrors.
• New API Readiness checklist used and updated

Fixed

N/A

Removed

N/A

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

Release Notes

This release contains the definition and documentation of

• connectivity-insights v0.5.0-rc.1
• connectivity-insights-subscriptions v0.5.0-rc.1
• application-profiles v0.4.0-rc.1

The API definition(s) are based on

• Commonalities 0.5.0-rc.1 (r2.2)

• Identity and Consent Management v0.3.0-rc.1 (r2.2)

• r2.1 release of ConnectivityInsights has the following API definitions:

  • connectivity-insights v0.5.0-rc.1
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

  • connectivity-insights-subscriptions v0.5.0-rc.1
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

  • application-profiles v0.4.0-rc.1
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

Changed

All changes are to align with Commonalities 0.5.0-rc.1 and Identity and Consent management 0.3.0-rc.1, as captured in PR #116

• Error names and structures updated
• removed 406 and 5xx errors
• security component updated
• x-camara-commonalities version updated
• Device identifier updates
• Template text for identifying devices updated
• Test guidelines updated to incorporate changed errrors.
• New API Readiness checklist used and updated
• For more details see Scope for Spring 25 CAMARA meta release

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

• r1.2 is the first public release of connectivity insights with the following API definitions:

  • Connectivity Insights API v0.4.0
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

  • Connectivity Insights Subscriptions API v0.4.0
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

  • Application Profiles API v0.3.0
    [View it on ReDoc]
    [View it on Swagger Editor]
    [OpenAPI]

• Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases

• Note: This being the first public release of the API, list of changes as compared to previous public release is not applicable and hence not provided.

This release contains the definition and documentation of

• Connectivity Insights API v0.4.0-rc.1
• Connectivity Insights Subscriptions API v0.4.0-rc.1
• Application Profiles API v0.3.0-rc.1

The API definition(s) are based on

• Commonalities v0.4.0-rc.2
• Identity and Consent Management v0.2.0-rc.2

Connectivity Insights API v0.4.0-rc.1

0.4.0-rc.1 is the first release of the API. The version is aligned with
Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.

• API definition with inline documentation:

  • View it on ReDoc:

    • connectivity-insights.yaml

  • View it on Swagger Editor

    • connectivity-insights.yaml

  • OpenAPI

    • connectivity-insights.yaml

Added

• Gherkin .feature file in Test_definitions
• Implementation of ICM consent guidelines
• Addition of x-camara-commonalities object to YAML
• Documentation: added warning about use of networkAccessIdentifier, added User Story

Changed

• Compliance with DeviceIdentifier schema
• Error model alignment, including device identifier-related errors
• Updated the API Readiness Checklist to the new format

Connectivity Insights Subscriptions API v0.4.0-rc.1

0.4.0-rc.1 is the first release of the API. The version is aligned with
Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.

• API definition with inline documentation:

  • View it on ReDoc:

    • connectivity-insights-subscriptions.yaml

  • View it on Swagger Editor

    • connectivity-insights-subscriptions.yaml

  • OpenAPI

    • connectivity-insights-subscriptions.yaml

Added

• Gherkin .feature file in Test_definitions
• Implementation of ICM consent guidelines
• Addition of x-camara-commonalities object to YAML
• Documentation: added warning about use of networkAccessIdentifier, added User Story

Changed

• Compliance with DeviceIdentifier schema
• Error model alignment, including device identifier-related errors
• Updated the API Readiness Checklist to the new format

Application Profiles API 0.3.0-rc.1

0.3.0-rc.1 is the first release of the API. The version is aligned with
Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.

• API definition with inline documentation:

  • View it on ReDoc:

    • application-profiles.yaml

  • View it on Swagger Editor

    • application-profiles.yaml

  • OpenAPI

    • application-profiles.yaml

Added

• Gherkin
  .feature file in Test_definitions

Changed

• Aligned the network monitoring KPIs to match with Quality on Demand CAMARA API.
• update the end points to make it more developer friendly based on the discussion in the API working group.
• Updated the API Readiness Checklist to the new format