diff --git a/README.md b/README.md index 87af02e..d27c016 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,26 @@ Incubating API Repository to evolve and maintain the definitions and documentati * Started: July 2024 * * Incubating stage since: June 2025 + + + ## Release Information -* 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`: Public release r3.2 with **version 1.0.0** of the API device-swap is available [here](https://github.com/camaraproject/DeviceSwap/tree/r3.2). -- 1.0.0 Device Swap API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceSwap/blob/r3.2/code/API_definitions/device-swap.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r3.2/code/API_definitions/device-swap.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r3.2/code/API_definitions/device-swap.yaml) -* The latest public release is available here: https://github.com/camaraproject/DeviceSwap/releases/latest -* Other releases of this sub project are available in https://github.com/camaraproject/DeviceSwap/releases + +> [!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 [r3.2](https://github.com/camaraproject/DeviceSwap/releases/tag/r3.2) (Fall25), with the following API versions: + * **device-swap v1.0.0** + [[YAML]](https://github.com/camaraproject/DeviceSwap/blob/r3.2/code/API_definitions/device-swap.yaml) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r3.2/code/API_definitions/device-swap.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceSwap/r3.2/code/API_definitions/device-swap.yaml) +* The latest public release is always available here: https://github.com/camaraproject/DeviceSwap/releases/latest +* Other releases of this repository are available in https://github.com/camaraproject/DeviceSwap/releases * For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceSwap/blob/main/CHANGELOG.md) +_The above section is automatically synchronized by CAMARA project-administration._ + + ## Contributing * Meetings are held virtually * Schedule: Every 4 weeks Thursday at 7:30 UTC