Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes for related data update. #52

Merged
merged 24 commits into from Aug 16, 2023
Merged

Changes for related data update. #52

merged 24 commits into from Aug 16, 2023

Conversation

ItIsJordan
Copy link
Collaborator

@ItIsJordan ItIsJordan commented Aug 3, 2023

Adds the validation changes and testing required for the related data update.

Closes #50.

Adds files for schema version v1.1.1 with symlinks.
Adds the related_to_table_dois var to submission_schema.json.
Adds the related recids var to submission_schema.json to accommodate for related recids..
Updates the schema version number to 1.1.1 in the json files (forgot).
Adds the updated schema version (1.1.1) to the list of valid versions.
Updates schema version number referenced in the README document.
Upgrades the schema version used within code
Updates the schema version number used in the tests from 1.1.0 to 1.1.1
Updates the data type for related record id storage from string to integer. This is to disallow entry of anything other than HEPData record IDs.
Reverts a change upping the minimum version checked before running a number of validator functions.  Was updated to match most recent version number, checks are actually needed above 1.1.0.
Fixed accidental inconsistencies between this data schema and the HEPData schema. Recids now has no maxLength value. Updated table DOI to match the correct maxLength value of 128 (was 64).
Now validates related DOI entries against a regular expression.
Updates TestHEPSubmission to include valid related doi/recid entries in submission.yaml
Adds invalid recid/doi testing and related test YAML files.
Removes a hardcoded flag setting the current schema version in testing as the default is to use the most recent version.
@coveralls
Copy link

coveralls commented Aug 3, 2023

Coverage Status

coverage: 100.0%. remained the same when pulling 326d392 on submission-linking into 4bd9005 on main.

Adds the virtual environment folder in venv/ to the .gitignore file.
Probably unnecessary. Added a minimum value of 1 to disable entry of negative, and 0 as an integer.
Updates validator testing to include new cases for valid submissions, and more invalid cases.
Adds some extra checks against the regex in the related submission testing.
Removes spaces on array entries in the related test yaml files.
ItIsJordan and others added 3 commits August 11, 2023 15:35
Adds a uniqueness check in the related DOI and record ID entries in the schema. Also adds testing against this functionality.
* Instead use 'related_to_hepdata_records' (suggested by @20DM).
* Move new fields to end of 'properties' in JSON schema.
* Bump version to 0.3.4 in preparation for new release.
@GraemeWatt GraemeWatt removed the request for review from sjmf August 16, 2023 14:57
Copy link
Member

@GraemeWatt GraemeWatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! I've merged the latest changes from main, renamed related_to_hepdata_recids to related_to_hepdata_records (suggested by @20DM), moved the new fields to the end of the properties in the JSON schema, and bumped the version. I'll merge to main and make a new release v0.3.4 now.

@GraemeWatt GraemeWatt merged commit dcd80d3 into main Aug 16, 2023
11 checks passed
@GraemeWatt GraemeWatt deleted the submission-linking branch August 16, 2023 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Modify JSON schema to support bidirectional linking
3 participants