[Docs] Add Jupyter Notebook illustrating entityTraits #69
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/entityTraitsNotebook
branch
2 times, most recently
from
7d906b2 to
9f1619e
Compare
foundrytom
reviewed
Nov 21, 2023
|
Btw - a nice thing here is by the time the work is done and this is passing we should have some usefull specifcations from #22 |
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
37246ed to
9a9acd0
Compare
feltech
added a commit
to feltech/OpenAssetIO-Manager-BAL
that referenced
this pull request
Feb 23, 2024
Discovered whilst updating OpenAssetIO/OpenAssetIO-MediaCreation#69 after OpenAssetIO/OpenAssetIO#1217. The API docs for `resolve` say > Only traits that are applicable to each entity, and for which the manager has data, will be imbued in the result. However, if an entity in the JSON library has a trait as part of its trait set, but that trait has no properties (either because that trait has no associated properties, or because it's not set in the JSON), then it was imbued in the `TraitsData` regardless. Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
f67eac0 to
cf630c3
Compare
|
Update on this rather long-running notebook(s). It's updated to use the changes in OpenAssetIO/OpenAssetIO-Manager-BAL#90 and is working nicely. CI still targets PyPI releases for dependencies however, so either we need to retarget it, or wait til the next release, before this PR can be merged. |
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
6df8e78 to
e94f7c9
Compare
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
e94f7c9 to
66703d4
Compare
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
66703d4 to
5788493
Compare
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
5788493 to
7422704
Compare
elliotcmorris
approved these changes
May 10, 2024
Part of OpenAssetIO/OpenAssetIO#31. This notebook was originally used to sketch out the design of the `entityTraits` API method, elicit discussion, and come to a shared understanding of the feature as a team. Being an executable document, the notebook now functions as tested documentation and an e2e test suite for the feature, utilising the OpenAssetIO ecosystem beyond the core `entityTraits` API method (i.e. convenience signatures, BAL, `managementPolicy`). Signed-off-by: David Feltell <david.feltell@foundry.com>
Part of OpenAssetIO/OpenAssetIO#31. This notebook came as an appendix to illustrating usage of `entityTraits` in the original design notebook for that API method (see previous commit). However, during review it became apparent that a generic resolve and republish workflow is a distinct use-case, and not specific to `entityTraits`. So it was moved to its own notebook. Signed-off-by: David Feltell <david.feltell@foundry.com>
feltech
force-pushed
the
work/entityTraitsNotebook
branch
from
7422704 to
0530d4b
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.
Add a notebook illustrating the usage of
entityTraits, as specified in OpenAssetIO/OpenAssetIO#31.Add another notebook illustrating advanced usage of
entityTraitsin a generic resolve-and-republish workflow.The idea in the first instance is to provoke discussion and provide a reference as the feature is further refined.
An ideal outcome is that this document continues to be iterated as the feature(s) is developed, incorporating changes in design as well as new corner cases that need defining.
Eventually this should lead to an executable specification of the feature, which also serves as example documentation.
Dependencies
The notebook has dependencies on work in other repos, in particular
Manager.entityTraitsmethod OpenAssetIO#31kManagerDrivenandkRequiredtoPolicyAccessOpenAssetIO#1209entityTraitsOpenAssetIO#1217entityTraitsOpenAssetIO-Manager-BAL#89