diff --git a/README.md b/README.md index 86c0ab7..515bcfb 100644 --- a/README.md +++ b/README.md @@ -23,19 +23,25 @@ Incubating API Repository to evolve and maintain the definitions and documentati * Incubating stage since: February 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**. +## Release Information -* **NEW**: The latest public release r3.2 with version 2.1.0 of the API number-verification is available [here]( https://github.com/camaraproject/NumberVerification/releases/tag/r3.2) - - 2.1.0 Number Verification definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml) +> [!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**. -* Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/NumberVerification/releases +* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/NumberVerification/releases/tag/r3.2) (Fall25), with the following API versions: + * **number-verification v2.1.0** + [[YAML]](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml) +* The latest public release is always available here: https://github.com/camaraproject/NumberVerification/releases/latest +* Other releases of this repository are available in https://github.com/camaraproject/NumberVerification/releases * For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md) +_The above section is automatically synchronized by CAMARA project-administration._ + ## Contributing