FEAT: Commons IP schema validation #60
Merged
Conversation
This file contains 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
- removed expansions of status enums; and - added a `ruleId` alias for validation `rule_id`.
dockmd
approved these changes
Aug 13, 2024
That's because they're incompatible with commons-ip which doesn't include spaces. I need compatibility to auto compare the results via a JSON deserialisation. Once we have compatibility we can talk about changes, but I can't change commons-ip. |
- added a `model_config` paramter to allow both `rule_id` and `ruleId` as keys in Pydantic model validation; - fixes issue with deserialisation of `rule_id` in `Rule` model.
- added a `model_validator` to the `PackageDetails` class to convert incoming JSON dictionary to a `List` for now; - added PyDantic config to `Result` to allow multiple names for `rule_id` during validation; - reverted change to dictionary as it was not necessary; - added tests and data for deserialisation of commons-ip types; and - fixed minor compiler warnings.
…ator into fix/commons-ip
- refactored `MetadataResults` to match `commons-ip`, it's probably better as well; - moved `name` from `InformationPackage` to `PackageDetails` class; - renamed `InformationPackage.package` to `InformationPackage.details`; - renamed existing `ValidationReport.convert_dict` validator to `ValidationReport.convert_representations_dict` (more explicit); - added a second validator, `VaidationReport.convert_checksum_ids`, to convert `commons-ip` checksum ids to `eark_validator` hyphenated form; - `is_valid` convenience property to `ValidationReport` class; - string constants for 'VALID' and 'INVALID'; and - fixed tests to accomodate.
|
Final time I promise @dockmd, this is now compatible with commons-ip JSON and the new validator rest service works. |
dockmd
reviewed
Aug 28, 2024
dockmd
approved these changes
Aug 28, 2024
- added `convert_status` validator to `MetadataResults` class to convert commons-ip `NOTVALID` status to `INVALID`; - moved checksum algorithm ID validation to the `PackageDetails` class; - added test and test data for status conversion; and - fixed type hinting for validation methods to `Any`.
|
@dockmd, I should have kept my mouth shut. Found another change to make to coerce a final value. I'll take a look at your suggestion about root and get a final commit up shortly. Looking to close this and merge to integrations ASAP as I can then get a test package out and an updated REST validator. |
As suggested in this [review comment](#60 (comment)), thanks.
dockmd
approved these changes
Aug 29, 2024
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.
ruleIdalias for validationrule_id.