docs: add entity relationships detail to docs - #157
Merged
Merged
Conversation
georgeRobertson
requested changes
Sep 21, 2026
Contributor
|
@stevenhsd spotted one other thing - you're not referencing any of the markdown documents in the zensical.toml so they won't show in the documentation. |
…idation-engine into docs/sr-ndsp-636_add_linkage_details
|
|
||
| Sometimes a user may choose to use the file transformation stage to `normalise` a heavily nested dataset into separate entities during the initial reading of data. This would be done by specifying different entities in the dataset section of the contract configuration in the `dischema` file. This allows for easier interaction when customising errors in the data contract or writing transformations in the business rules. | ||
|
|
||
| `Normalising` assets can lead to more complex validations being required. For example in the dataset: |
Contributor
There was a problem hiding this comment.
Suggested change
| `Normalising` assets can lead to more complex validations being required. For example in the dataset: | |
| `Normalising` assets can lead to more complex validations being required. For example in the Flights dataset: |
?
|
|
||
| ```mermaid | ||
| erDiagram | ||
| COUNTRY ||--o{ AIRPORT : "" |
Contributor
There was a problem hiding this comment.
this is a mandatory relationship
| COUNTRY ||--o{ AIRPORT : "" | ||
| AIRPORT ||--o{ FLIGHT : "" | ||
| FLIGHT ||--o{ PASSENGER : "" | ||
| AIRPORT ||--o{ STAFF_MEMBER : "" |
Contributor
There was a problem hiding this comment.
likewise - mandatory relationship
|
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
2 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.
TLDR of changes
What kind of changes does this PR introduce?
Tick all that apply
Please check if the PR fulfills these requirements