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

Rationalise references to related objects within each entity type #45

Open
jackdos opened this issue Mar 11, 2022 · 0 comments
Open

Rationalise references to related objects within each entity type #45

jackdos opened this issue Mar 11, 2022 · 0 comments
Labels
question Further information is requested

Comments

@jackdos
Copy link
Collaborator

jackdos commented Mar 11, 2022

PAR objects reference other objects in a multiple places (Preservation Actions contain information about the tool they use, Business Rules contain information about the Preservation Actions they apply and the formats they apply to etc.), and we use two different mechanisms for doing this.

In some cases, (PreservationAction -> Tool), a full object is listed. This makes the reference type-safe and means that the full context of the object is available in its definition.

In other cases, (Business Rule -> FileFormat), just an ID is listed. This makes the object more compact (and arguably easier to read), but means that objects other than file formats can be listed in error and multiple API calls are needed to see the full context.

There are pros and cons of each method, and there may be alternatives that reach a better compromise than either of these two ways we currently have.

We should agree a single approach for recording these relationships/references.

@jackdos jackdos added the question Further information is requested label Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant