Skip to content

CHANGELOG.md

Latest commit

 

History

History
247 lines (172 loc) · 13.6 KB

CHANGELOG.md

File metadata and controls

247 lines (172 loc) · 13.6 KB

Starting with release automation, new release changelogs are maintained in the CHANGELOG/ directory with per-cycle files.

Changelog Simple Edge Discovery

NOTE:

Table of contents

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

NOTE: SimpleEdgeDiscovery is part of the EdgeCloud API Sub Project, and was previously developed within the EdgeCloud repository. Two releases were made within EdgeCloud, v0.81 and r0.9.3-rc. These releases also include the other EdgeCloud APIs and materials, so the changelog below highlights only the changes related to SimpleEdgeDiscovery. Further information and links to the releases in EdgeCloud can be found below.

r2.2 - Fall25 public release

This public release contains the definition and documentation of

  • simple-edge-discovery v2.0.0

The API definition(s) are based on

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

It contains the following breaking changes compared to the last public release r1.3:

  • The API's single operation has been refactored from GET to POST
  • The operation resource URI has changed from /edge-cloud-zones?filter=closest to /retrieve-closest-edge-cloud-zone
  • One or more device identifiers must be passed either via a 3-legged access token or in the request body.

Added

  • fix: added DeviceResponse object by @Kevsy in #102
  • fix: added section on non-documented errors by @Kevsy in #92

Changed

  • refactor!: changed discovery operation method from GET to POST by @Kevsy in #78
  • docs: updated examples and usage description following refactoring to POST by @Kevsy in #81
  • refactor!: feature file updated to reflect change from GET to POST by @Kevsy in #118
  • fix: updated 200 OK Response to a schema object by @Kevsy in #117
  • fix: changed XCorrelator to an object and added resulting $refs by @Kevsy in #116
  • fix: updated x-correlator pattern by @Kevsy in #93
  • fix: updated x-camara-commonalities to 0.6 by @Kevsy in #101
  • test: updated x-correlator in .feature to assert compliance with common schema by @Kevsy in #114
  • docs: updated ref to Commonalities version in Device object description

Removed

  • fix: removed 401 AUTHENTICATION_REQUIRED by @Kevsy in #90
  • fix: removed 422 IDENTIFIER MISMATCH by @Kevsy in #89

r2.1 - rc

This release candidate contains the definition and documentation of

  • simple-edge-discovery v2.0.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)

It contains the following breaking changes compared to the last public release r1.3:

  • The API's single operation has been refactored from GET to POST
  • The operation resource URI has changed from /edge-cloud-zones?filter=closest to /retrieve-closest-edge-cloud-zone
  • One or more device identifiers must be passed either via a 3-legged access token or in the request body.

Added

  • fix: added DeviceResponse object by @Kevsy in #102
  • fix: added section on non-documented errors by @Kevsy in #92

Changed

  • refactor!: changed discovery operation method from GET to POST by @Kevsy in #78
  • docs: updated examples and usage description following refactoring to POST by @Kevsy in #81
  • refactor!: feature file updated to reflect change from GET to POST by @Kevsy in #118
  • fix: updated 200 OK Response to a schema object by @Kevsy in #117
  • fix: changed XCorrelator to an object and added resulting $refs by @Kevsy in #116
  • fix: updated x-correlator pattern by @Kevsy in #93
  • fix: updated x-camara-commonalities to 0.6 by @Kevsy in #101
  • test: updated x-correlator in .feature to assert compliance with common schema by @Kevsy in #114

Removed

  • fix: removed 401 AUTHENTICATION_REQUIRED by @Kevsy in #90
  • fix: removed 422 IDENTIFIER MISMATCH by @Kevsy in #89

r1.3

This release contains the definition and documentation of

  • simple-edge-discovery v1.0.0, a stable public release.

The API definition(s) are based on

  • Commonalities v0.4.0
  • Identity and Consent Management v0.2.0

It contains the following changes compared to last public release r0.9.3 - rc:

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

  • info.version to 1.0.0
  • version in servers.url to v1
  • Changed mecplatforms to EdgeCloudZones in alignment with EdgeCloud API family
  • Compliance with DeviceIdentifier schema
  • The device identifier may now be available from a 3-legged access token
  • Change of X-Correlator to x-correlator
  • Operation tag now follows agreed syntax
  • Error model alignment, including device identifier-related errors
  • Documentation: updated the API Readiness Checklist
  • Documentation: clarified distinction between device/server usage of the SimpleEdgeDiscovery API
  • Documentation: replaced term 'MNO' with 'network operator'
  • Documentation: updated section on authentication and authorisation

Removed

  • UUID format constraint from x-correlator
  • 405 Method Not Allowed error response
  • Removed example for networkAccessIdentifier

Fixed

  • Trailiing whitespace issues in YAML

Changelog from r1.3 to r1.2 only: https://github.com/camaraproject/SimpleEdgeDiscovery/compare/r1.2...r1.3

r1.2 - rc

This release contains the definition and documentation of

  • simple-edge-discovery v0.11.0-rc.2, a release-candidate pre-release.

The API definition(s) are based on

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

It contains the following corrections compared to r1.1 - rc.

Removed

  • UUID format constraint from x-correlator
  • 405 Method Not Allowed error response

Changed

  • documentation: replaced term 'MNO' with 'network operator'
  • documentation: updated section on authentication and authorisation

Full Changelog: https://github.com/camaraproject/SimpleEdgeDiscovery/compare/r1.1...r1.2

r1.1 - rc

Release Notes

This release contains the definition and documentation of

  • simple-edge-discovery v0.11.0-rc.1, a release-candidate pre-release

The API definition(s) are based on

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

simple-edge-discovery v0.11.0-rc.1

simple-edge-discovery v0.11.0-rc.1 is a new release candidate version with significant changes compared to the previous version v0.9.3-rc and is not backward compatible.

Main changes

  • This version is primarily to align with the changes to Commonalities 0.4-rc.1 and Identity and Consent Management v0.2.0-rc.1, and also includes changes to resource names agreed across the EdgeCloud API family. The scope of release (issues closed) is available in #3.

  • API definition with inline documentation:

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

  • Changed mecplatforms to EdgeCloudZones in alignment with EdgeCloud API family
  • Compliance with DeviceIdentifier schema
  • The device identifier may now be available from a 3-legged access token
  • Change of X-Correlator to x-correlator
  • Operation tag now follows agreed syntax
  • Error model alignment, including device identifier-related errors
  • Updated the API Readiness Checklist to the new format
  • Documentation: clarified distinction between device/server usage of the SimpleEdgeDiscovery API

Fixed

  • Trailiing whitespace issues in YAML

Removed

  • Removed example for networkAccessIdentifier

Full Changelog:

please note it is not possible to automatically compare across the EdgeCloud and SimpleEdgeDiscovery repositories, so this link compares the initial code commit to SimpleEdgeDiscovery with the commit for r1.1

r0.9.3 - rc

NOTE: this release candidate was made to allow a baseline implementation for MWC 2024, and was released in the EdgeCloud repository. Hence it includes the other EdgeCloud APIs/materials. The release note is available here, including Known Issues. There were no significant changes to SimpleEdgeDiscovery YAML in this release.

Full Changelog: https://github.com/camaraproject/EdgeCloud/compare/v0.8.1...v0.9.3-rc

r0.8.1

Note: ths was released in the EdgeCloud repository, hence it includes the other EdgeCloud APIs/materials. The changes related to SimpleEdgeDiscovery are listed below. The release note is available here.

Fixed

Full Changelog: https://github.com/camaraproject/EdgeCloud/commits/v0.8.1