Cleanup JSON schemas and add ADR #174
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
gregtyler
force-pushed
the
json-schema-expansion-adr
branch
from
911f8f7 to
3701b93
Compare
hawx
reviewed
Apr 22, 2024
|
|
||
| To ensure we capture and preserve the context of LPAs, each LPA will be associated with a JSON schema at point of execution (online) or ingestion (paper). That schema will document the shape of the LPA's data. | ||
|
|
||
| The schema file will be mapped to translation files that contain any important text associated with the LPA, such as the terms the donor agreed to. There will be a file for each language a donor can use (currently English or Welsh). |
There was a problem hiding this comment.
should this also say something about the decision made that the language signed in is assumed to be the same as the contactLanguagePreference for the donor?
There was a problem hiding this comment.
I wasn't sure if we'd landed on a definitive answer for that yet so didn't want to specify it in here
`lpa.json` is now the full LPA structure. `submitted-lpa.json` is the subset of fields that should initially be initially submitted from MRLPA or scanning. Create `translation.*.json` to indicated what translation files might look like/contain. Add an ADR documenting how we will use, host and version our JSON schemas. #minor
- Use date-time in schema to reflect existing code - Use "donorTerms" rather than "terms" #patch
gregtyler
force-pushed
the
json-schema-expansion-adr
branch
from
3701b93 to
47fd963
Compare
acsauk
reviewed
Apr 22, 2024
mattmachell
reviewed
Apr 22, 2024
mattmachell
reviewed
Apr 22, 2024
docs/architecture/decisions/0004-use-json-schemas-to-define-lpa-structure.md
Show resolved
Hide resolved
mattmachell
reviewed
Apr 22, 2024
|
|
||
| As validation is currently done manually, there is a risk that the structure of the LPA will not match the JSON schema. We should introduce schema validation when storing an LPA to ensure this is not the case. | ||
|
|
||
| We need to ensure that any changes to the structure of the data are properly updated in the schema. An exception to this is before the start of private beta, since we will only be working with test data and can more easily change the schema. |
There was a problem hiding this comment.
Probably need to add something about what the intended process is for proposing new schema versions. i.e. must have clear intent and cross-team ratification (via PR?)
There was a problem hiding this comment.
I've added a bit more about this, but I don't want to get into too much specification since I don't have a strong feeling of how this will work best. I think as we see how this works into products we'll be able to define what structure and safeguards we need.
Aligns better with MRLPA and Sirius language, and is a bit clearer about it contents. #patch
For easier management between languages #patch
#patch
"InitialLpa" -> "DonorDetails" #patch
gregtyler
force-pushed
the
json-schema-expansion-adr
branch
from
204f1cc to
7e88fef
Compare
hawx
reviewed
Apr 24, 2024
mattmachell
approved these changes
Apr 24, 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.
lpa.jsonis now the full LPA structure.submitted-lpa.jsonis the subset of fields that should initially be initially submitted from MRLPA or scanning.Create
translation.*.jsonto indicated what translation files might look like/contain.Add an ADR documenting how we will use, host and version our JSON schemas.
#minor