WIP: using pydantic for validation of proxmoxer responses #137
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
As discussed in #133 …
This makes use of the OpenAPI description document for the proxmox api
https://github.com/LUMASERV/proxmox-ve-openapi/blob/main/reference/spec.v2.yaml
and
https://github.com/koxudaxi/datamodel-code-generator
to generate pydanticv2 models.
The description document provides a good starting point and allows quick changes.
I've adjusted the description document to be more compact, set some title and fixed some errors.
Having a validated model to work with makes sure the properties exist and have a defined type.
Validation allows catching invalid/unexpected responses before processing them.
This is not complete, it's meant to serve as demo of the building blocks.
ISSUE TYPE