[client] deprecate SCO promote_to_indicator in favor of promote_to_indicator_v2 (#6171) #680
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
labo-flg
commented
Jun 14, 2024
labo-flg
commented
Jun 14, 2024
pycti/entities/stixCyberObservables/opencti_stix_cyber_observable_latest.py
Outdated
Show resolved
Hide resolved
labo-flg
force-pushed
the
opencti/issue/6171-promote-no-breaking-api
branch
2 times, most recently
from
ac067f5
to
31e76c4
Compare
…teToIndicator * promote incorrectly returns the original observable and is now deprecated * promoteToIndicator returns the newly created indicator
labo-flg
force-pushed
the
opencti/issue/6171-promote-no-breaking-api
branch
from
6266de4
to
ea1e330
Compare
labo-flg
force-pushed
the
opencti/issue/6171-promote-no-breaking-api
branch
from
19fddfc
to
f39d8af
Compare
labo-flg
added
the
multi-repository
labo-flg
force-pushed
the
opencti/issue/6171-promote-no-breaking-api
branch
from
11b81e1
to
e3827ba
Compare
labo-flg
changed the title
labo-flg
commented
Jun 19, 2024
| @@ -0,0 +1,256 @@ | |||
| INDICATOR_PROPERTIES = """ | |||
There was a problem hiding this comment.
For code clarity, we want to extract the entities properties (used in GQL queries) in dedicated files.
This will 1) make the business code lighter, and 2) allow to use them in several files.
As the new promote_to_indicator_v2 method returns an indicator, I'm already in 2) use-case.
Comment on lines
+13
to
+17
| @deprecation.deprecated( | ||
| deprecated_in="6.2", | ||
| removed_in="6.5", | ||
| details="Use promote_to_indicator_v2 instead.", | ||
| ) |
There was a problem hiding this comment.
This will print a warning message if the method is used, allowing our users to maintain their scripts more easily, hopefully.
labo-flg
changed the title
aHenryJard
approved these changes
Jun 25, 2024
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.
At the graphql API level:
Proposed changes
The method
api.stix_cyber_observable.promoto_to_indicatorthat uses gqlpromotemutation is kept but is now mlarked as deprecated.New method
api.stix_cyber_observable.promoto_to_indicator_v2is created to use the new gql mutation promoteToIndicator.Related issues
Checklist
Further comments
First implementation of a deprecation strategy at the level of client-python.
We use a mixin so that the
StixCyberObservableclass inherits the deprecated behavior, moved to a dedicated sub module inentities.strix_cyber_observable.StixCyberObservableDeprecatedMixinThe examples are updated to use the new API, while the old API is tested for non-regression in an integration test.
Deprecated code is meant to live for 3 major versions, and then removed from the code base.