Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add a warning about non cloud routes.
  • Loading branch information
demeringo authored Dec 11, 2024
1 parent 44277ec commit 66084d3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/)
Expand Down

0 comments on commit 66084d3

Please sign in to comment.