Add relationship access and version overrides #132
Merged
Conversation
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
Part of testing TheFoundryVisionmongers/KatanaOpenAssetIO#4. BAL would error when performing relationship queries with a non-`kRead` access mode. However, such queries are valid for publishing workflows and so must be supported in order to test host applications. So add an optional `"access"` flag that can be added to relationship definitions in the JSON database, overriding the default `kRead` access, and limiting that relationship to specific access modes. Hence no longer error when responding to relationship queries for non-`kRead` access modes (the default response instead being an empty set of entity references). Additionally, if a version relationship trait set is specified in the JSON database, then prefer that over the built-in versioning behaviour. A long term goal would be to remove the built-in versioning behaviour in favour of leveraging generic relationship queries (OpenAssetIO#88). This at least gets us part way there to support some use cases. Signed-off-by: David Feltell <david.feltell@foundry.com>
hutchinson
approved these changes
May 12, 2025
feltech
deleted the
work/KatanaOpenAssetIO/4-relationshipByAccessAndVersionOverriding
branch
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.
Part of testing TheFoundryVisionmongers/KatanaOpenAssetIO#4.
BAL would error when performing relationship queries with a non-
kReadaccess mode. However, such queries are valid for publishing workflows and so must be supported in order to test host applications.So add an optional
"access"flag that can be added to relationship definitions in the JSON database, overriding the defaultkReadaccess, and limiting that relationship to the specific access mode.Hence no longer error when responding to relationship queries for non-
kReadaccess modes (the default response instead being an empty set of entity references).Additionally, if a version relationship trait set is specified in the JSON database, then prefer that over the built-in versioning behaviour. A long term goal would be to remove the built-in versioning behaviour in favour of leveraging generic relationship queries (#88). This at least gets us part way there to support some use cases.