Support defaultEntityReference
#122
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
feltech
force-pushed
the
work/53-defaultEntityReference
branch
from
09717f1
to
4f54754
Compare
foundry-markf
approved these changes
Aug 29, 2024
Closes OpenAssetIO#53. Add support for the `defaultEntityReference` API method, which provides a way for hosts to get a "starting point" for further queries. Add a new top-level dictionary to the JSON database `defaultEntities`, which has a mapping per access mode of trait set to entity reference. If no matching trait set is found in the JSON database, then respond with `kInvalidTraitSet`. In real-world managers, an unrecognised trait set would probably elicit a response of `None` (for "no appropriate default"), rather than exception. But here we make a `None` response explicit by specifying `null` in the JSON database. Signed-off-by: David Feltell <[email protected]>
feltech
force-pushed
the
work/53-defaultEntityReference
branch
from
4f54754
to
0b76500
Compare
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.
Closes #53. Add support for the
defaultEntityReferenceAPI method, which provides a way for hosts to get a "starting point" for further queries.Add a new top-level dictionary to the JSON database
defaultEntities, which has a mapping per access mode of trait set to entity reference.If no matching trait set is found in the JSON database, then respond with
kInvalidTraitSet. In real-world managers, an unrecognised trait set would probably elicit a response ofNone(for "no appropriate default"), rather than exception. But here we make aNoneresponse explicit by specifyingnullin the JSON database.