# `proxmox-api`: idiomatic Rust bindings for the Proxmox VE HTTP API
Features:
* Types automatically generated from Proxmox VE's almost-json-schema.
* Re-usable (sub-)clients
## What's missing?
- [ ] Pattern validation
- [ ] Range validation for values
- [ ] Rust-types for well known types
## Running the generator
To run the generator, run the `generate.sh` script in the `generator` directory:
```console
$ cd generator/
$ ./generate.sh
```
The schema is generated from [PVE-schema.json](./generator/PVE-schema.json).
## License
All source code (including code snippets) is licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
[https://www.apache.org/licenses/LICENSE-2.0][L1])
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
[https://opensource.org/licenses/MIT][L2])
[L1]: https://www.apache.org/licenses/LICENSE-2.0
[L2]: https://opensource.org/licenses/MIT
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
licensed as above, without any additional terms or conditions.
This project aims to conform to [Conventional Commits]. If you make contributions,
please be so kind to stick to that format :)
[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/#summary