diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md new file mode 100644 index 0000000..5f7ebf7 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r2.md @@ -0,0 +1,103 @@ +# Changelog DeviceRoamingStatus + + +## Table of Contents +- [r2.1](#r21) + + +**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 + +# 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](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceRoamingStatus/blob/r2.1/code/API_definitions/device-roaming-status-subscriptions.yaml) + +### Breaking changes + +* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceRoamingStatus/pull/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 https://github.com/camaraproject/DeviceRoamingStatus/pull/53 + +### Changed + +* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceRoamingStatus/pull/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 https://github.com/camaraproject/DeviceRoamingStatus/pull/77 +* Fix example for Network Access Identifier by @bigludo7 in https://github.com/camaraproject/DeviceRoamingStatus/pull/58 + +### Removed + +* Delete redundant API Readiness Checklists by @eric-murray in https://github.com/camaraproject/DeviceRoamingStatus/pull/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](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceRoamingStatus/blob/r2.1/code/API_definitions/device-roaming-status.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* Clarify LastStatusTime schema description in YAML by @eric-murray in https://github.com/camaraproject/DeviceRoamingStatus/pull/56 +* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceRoamingStatus/pull/78 + +### Fixed + +* Fix example label: Multiple Country Codes → Multiple Country Names by @sachinvodafone in https://github.com/camaraproject/DeviceRoamingStatus/pull/54 +* Fix example for Network Access Identifier by @bigludo7 in https://github.com/camaraproject/DeviceRoamingStatus/pull/58 + +### Removed + +* Delete redundant API Readiness Checklists by @eric-murray in https://github.com/camaraproject/DeviceRoamingStatus/pull/82 + +**Full Changelog**: https://github.com/camaraproject/DeviceRoamingStatus/compare/r1.2...r2.1 + diff --git a/README.md b/README.md index edbaef5..556dfc3 100644 --- a/README.md +++ b/README.md @@ -31,18 +31,24 @@ Incubating API Repository to evolve and maintain the definitions and documentati > [!NOTE] > 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/DeviceRoamingStatus/releases/tag/r1.2) (Fall25), with the following API versions: - * **device-roaming-status-subscriptions v0.8.0** - [[YAML]](https://github.com/camaraproject/DeviceRoamingStatus/blob/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml) - * **device-roaming-status v1.1.0** - [[YAML]](https://github.com/camaraproject/DeviceRoamingStatus/blob/r1.2/code/API_definitions/device-roaming-status.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status.yaml) +* The latest public release is [r1.2](https://github.com/camaraproject/DeviceRoamingStatus/releases/tag/r1.2), with the following API versions: + * **device-roaming-status-subscriptions 0.8.0** + [[YAML]](https://github.com/camaraproject/DeviceRoamingStatus/blob/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml) + * **device-roaming-status 1.1.0** + [[YAML]](https://github.com/camaraproject/DeviceRoamingStatus/blob/r1.2/code/API_definitions/device-roaming-status.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r1.2/code/API_definitions/device-roaming-status.yaml) + * The latest public release is always available here: https://github.com/camaraproject/DeviceRoamingStatus/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/DeviceRoamingStatus/releases -* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceRoamingStatus/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG](https://github.com/camaraproject/DeviceRoamingStatus/tree/main/CHANGELOG) + +### Upcoming Release Preview + +* Pre-release: [r2.1](https://github.com/camaraproject/DeviceRoamingStatus/releases/tag/r2.1) (release candidate) + * **device-roaming-status-subscriptions 0.9.0-rc.1** + [[YAML]](https://github.com/camaraproject/DeviceRoamingStatus/blob/r2.1/code/API_definitions/device-roaming-status-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status-subscriptions.yaml) + * **device-roaming-status 1.2.0-rc.3** + [[YAML]](https://github.com/camaraproject/DeviceRoamingStatus/blob/r2.1/code/API_definitions/device-roaming-status.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceRoamingStatus/r2.1/code/API_definitions/device-roaming-status.yaml) + _The above section is automatically synchronized by CAMARA project-administration._ @@ -51,9 +57,9 @@ _The above section is automatically synchronized by CAMARA project-administratio * Meetings are held virtually - * Schedule: Bi-weekly on Wednesday, 09:00 UTC + * Schedule: Bi-weekly on Friday, 14:00 UTC * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/93413850406?password=3aeb0f1b-d9f9-42c5-91d8-3d2b20421ef1) - * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fzLe) + * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14555224/Minutes+-+Device+Status) * Mailing List