Validate access mode for API functions #66
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/57-errorOnCreateRelated
branch
2 times, most recently
from
aba42c0
to
5469eb7
Compare
foundrytom
reviewed
Aug 22, 2023
foundrytom
approved these changes
Aug 22, 2023
feltech
force-pushed
the
work/57-errorOnCreateRelated
branch
from
5feb74b
to
6a9c9dc
Compare
Closes OpenAssetIO#57. OpenAssetIO/OpenAssetIO#1016 refined the Context access patterns to formalize the creation of "children" and other related entities via publish to an existing reference. BAL does not yet support this kind of creation, and so should error in the case. So respond appropriately to Access mode in various API functions, by calling the provided error callback, except in the case of `managementPolicy` which responds with empty `TraitsData` objects (signifying "unmanaged"). Note that for consistency, this changes the error message output when attempting to `resolve` with `kWrite` access. Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech
force-pushed
the
work/57-errorOnCreateRelated
branch
from
6a9c9dc
to
5c0f358
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 #57. See corresponding PR OpenAssetIO/OpenAssetIO#1050
OpenAssetIO/OpenAssetIO#1016 refined the Context access patterns to formalize the creation of "children" and other related entities via publish to an existing reference. BAL does not yet support this kind of creation, and so should error in the case.
So respond appropriately to Access mode in various API functions, by calling the provided error callback, except in the case of
managementPolicywhich responds with emptyTraitsDataobjects (signifying "unmanaged").Note that for consistency, this changes the error message output when attempting to
resolvewithkWriteaccess.