diff --git a/README.md b/README.md index 9a11b0b..0393e5d 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,29 @@ Sandbox API Repository to describe, develop, document, and test the DeviceDataVo * Describe, develop, document, and test the service APIs * Started: August 2024 + + + ## Release Information -* **The new public release is [r1.3](https://github.com/camaraproject/DeviceDataVolume/tree/r1.3) with the following API definitions:** +> [!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**. - * **device-data-volume v0.1.0** - [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml) - * **device-data-volume-subscriptions v0.1.0** +* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/DeviceDataVolume/releases/tag/r1.3) (Fall25), with the following API versions: + * **device-data-volume-subscriptions v0.1.0** [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml) - -- Current work-in-progress version is available within the [main branch](https://github.com/camaraproject/DeviceDataVolume) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml) + * **device-data-volume v0.1.0** + [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume.yaml) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml) +* The latest public release is always available here: https://github.com/camaraproject/DeviceDataVolume/releases/latest +* Other releases of this repository are available in https://github.com/camaraproject/DeviceDataVolume/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceDataVolume/blob/main/CHANGELOG.md) + +_The above section is automatically synchronized by CAMARA project-administration._ + ## Contributing * Meetings for the DeviceStatus Sub Project are held virtually