feat(CRUK): add 1.0.0 and GWDM 2.1 mapping#130
Merged
Conversation
Add CRUK 1.0.0 model/schema/example and register in available.json.\nAdd GWDM 2.1 model/schema with helpers to map into CRUK.
Adds DataTable.size and Summary leadResearcher/leadResearchInstitute to CRUK 1.0.0 and updates the CRUK Pydantic model wiring so the generated schema matches the checked-in schema.
spco
approved these changes
May 12, 2026
calmacx
reviewed
May 12, 2026
|
|
||
| from hdr_schemata.models.GWDM.v2_0.Summary import Summary as Gwdm20Summary | ||
|
|
||
| LineSeparatedValues = constr(pattern=r"([^\r\n]+)") |
Collaborator
There was a problem hiding this comment.
Why line separated? why not use the common comma separated?
Also this definition, if it's really needed, if it is to be reused/shared, should be in the definitions and imported from there
Collaborator
Author
There was a problem hiding this comment.
I used newline separation so funder names can contain commas and to match a one-funder-per-line UI;But I have updated with the CommaSeparatedValues.
calmacx
reviewed
May 12, 2026
| with open(location, "w") as f: | ||
| json.dump(cls.model_json_schema(), f, indent=6) | ||
|
|
||
| def to_hdruk400_payload(self) -> Dict[str, Any]: |
Collaborator
There was a problem hiding this comment.
where's this used? we use the translation maps to translate between the two - not the python code. These schemas are published in python and JSON, so this wouldnt work in JSON.
Collaborator
Author
There was a problem hiding this comment.
You are right . I have updated it.
calmacx
reviewed
May 12, 2026
| from hdr_schemata.models.HDRUK.v4_0_0 import Hdruk400 | ||
| from hdr_schemata.definitions.HDRUK import Description, OneHundredFiftyCharacters | ||
|
|
||
| from .Summary import LineSeparatedValues, Summary |
Collaborator
There was a problem hiding this comment.
LineSepartedValues is a definition?
calmacx
reviewed
May 12, 2026
Comment on lines
+162
to
+188
| def to_cruk100_payload(self) -> Dict[str, Any]: | ||
| payload = self.to_hdruk400_payload() | ||
|
|
||
| # CRUK 1.0.0 extends HDRUK 4.0.0 with additional fields. | ||
| # GWDM 2.1 already has these fields, so pass them through. | ||
| if self.icons is not None: | ||
| payload["icons"] = self.icons | ||
| if self.datasetFilters is not None: | ||
| payload["datasetFilters"] = [ | ||
| df.model_dump(mode="json") if hasattr(df, "model_dump") else df | ||
| for df in self.datasetFilters | ||
| if df is not None | ||
| ] or None | ||
| if self.projectGrants is not None: | ||
| payload["projectGrants"] = [ | ||
| pg.model_dump(mode="json") if hasattr(pg, "model_dump") else pg | ||
| for pg in self.projectGrants | ||
| if pg is not None | ||
| ] or None | ||
| if self.erd is not None: | ||
| # CRUK expects a URL; GWDM carries an Image object. Prefer the image string if present. | ||
| image_value = getattr(self.erd, "image", None) | ||
| if image_value is not None and hasattr(image_value, "root"): | ||
| image_value = image_value.root | ||
| payload["erd"] = image_value | ||
|
|
||
| return payload |
Collaborator
There was a problem hiding this comment.
again - where/why is this used? translation maps in JSONata handle the translations between schemas not python code
calmacx
reviewed
May 12, 2026
- Close parenthesis in projectGrantName description (CRUK model and 1.0.0 schema). - GWDM 2.1: use CommaSeparatedValues for funders; sync 2.1 schema.json. - Remove unused Gwdm21 Python helpers (to_hdruk400 / to_cruk100); translation maps remain canonical. - test_gwdm: build Gwdm10 JSON Schema in a subprocess so $defs matches committed schema when CRUK loads first.
calmacx
approved these changes
May 19, 2026
Contributor
|
All change requests actioned, and signed off. Merging. |
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
4 participants
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.
Add CRUK 1.0.0 model/schema/example and register in available.json.\nAdd GWDM 2.1 model/schema with helpers to map into CRUK.