diff --git a/README.md b/README.md index 308a846..e1c0780 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ Rust client library for [Boaviztapi](https://github.com/Boavizta/boaviztapi). +> [!NOTE] +> The code of this library is _mostly_ generated automatically from the OpenAPI specification of Boavizta API. +> +> Still, some part are patched manually (See https://github.com/Boavizta/boaviztapi-sdk-rust/issues/6). +> +> This library is used and tested in the context of cloud scanner, so we know that API routes related to cloud work well. But it may still contain bugs for other non-cloud API routes. +> +> Please open an issue if you notice such behavior. + ## Versions supported - SDK version 1.3.3 supports Boavizta API 1.3.3 @@ -12,6 +21,8 @@ Rust client library for [Boaviztapi](https://github.com/Boavizta/boaviztapi). - SDK version 0.3.X supports Boavizta API of the 0.3.x series - SDK version 0.2.x support Boavizta API of the 0.2.x series (Neither SDK nor API will not be updated after release of Boavizta API v0.3.x - around June 2023) + + ## Documentation - SDK documentation (crate) [boavizta_api_sdk - Rust](https://docs.rs/boavizta_api_sdk/latest/boavizta_api_sdk/)