Add versioning traits/specifications #51
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
Not saying this is the best solution, but it is the easy one to maintain for now. Signed-off-by: Tom Cowland <[email protected]>
Ensures that we're not inadvertently hard-wrapping docstrings and such in the wrong places. Many YAML is confusing in this respect. Signed-off-by: Tom Cowland <[email protected]>
Signed-off-by: Tom Cowland <[email protected]>
Signed-off-by: Tom Cowland <[email protected]>
foundrytom
changed the title
elliotcmorris
previously requested changes
Jul 24, 2023
feltech
reviewed
Jul 24, 2023
feltech
approved these changes
Aug 3, 2023
Adds traits and specifications that can be used to replicate the old "versioning" API methods from the core API. These were recently removed in favour of domain specific definitions such as these. We opted to add base traits for 'usage' to the package. These should be composed with the other relevant traits when defining a specification to allow runtime introspection of the trait set. Amongst other uses, this helps managers in their implementation of methods such as `managementPolicy` where they need to be able to determine the nature of the query. For relationships, this also adds traits that define the expected cardinality of the result references. This helps inform a host whether they should be using the paged API methods. Part of OpenAssetIO#48 Signed-off-by: Tom Cowland <[email protected]>
foundrytom
force-pushed
the
work/48-versionTraits
branch
from
2b155d8
to
0a867de
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.
Part of #48, examples will come separately.