[client] Modularization of relation refs (#347)

Author: RomuDeuxfois

README.md

@@ -44,6 +44,12 @@ $ git push origin [branch-name]
 # Open a pull request
 ```
 
+### Install the package locally
+
+```bash
+$ pip install -e .
+```
+
 ## Documentation
 
 ### Client usage

docs/pycti/pycti.rst

@@ -68,7 +68,7 @@ Classes
 - :py:class:`StixSightingRelationship`:
   Undocumented.
 
-- :py:class:`StixCyberObservableRelation`:
+- :py:class:`StixNestedRefRelationship`:
   Undocumented.
 
 - :py:class:`Identity`:
@@ -246,11 +246,11 @@ Classes
    .. inheritance-diagram:: StixSightingRelationship
       :parts: 1
 
-.. autoclass:: StixCyberObservableRelation
+.. autoclass:: StixNestedRefRelationship
    :members:
 
    .. rubric:: Inheritance
-   .. inheritance-diagram:: StixCyberObservableRelation
+   .. inheritance-diagram:: StixNestedRefRelationship
       :parts: 1
 
 .. autoclass:: Identity

examples/create_ip_domain_resolution.py

@@ -23,13 +23,13 @@
     }
 )
 
-opencti_api_client.stix_cyber_observable_relationship.create(
+opencti_api_client.stix_nested_ref_relationship.create(
     fromId=observable_domain["id"],
     toId=observable_ip["id"],
     relationship_type="resolves-to",
 )
 
-relationships = opencti_api_client.stix_cyber_observable_relationship.list(
+relationships = opencti_api_client.stix_nested_ref_relationship.list(
     elementId=observable_domain["id"]
 )
 

pycti/__init__.py

@@ -34,10 +34,8 @@
 from .entities.opencti_report import Report
 from .entities.opencti_stix_core_relationship import StixCoreRelationship
 from .entities.opencti_stix_cyber_observable import StixCyberObservable
-from .entities.opencti_stix_cyber_observable_relationship import (
-    StixCyberObservableRelationship,
-)
 from .entities.opencti_stix_domain_object import StixDomainObject
+from .entities.opencti_stix_nested_ref_relationship import StixNestedRefRelationship
 from .entities.opencti_stix_object_or_stix_relationship import (
     StixObjectOrStixRelationship,
 )
@@ -46,7 +44,7 @@
 from .entities.opencti_tool import Tool
 from .entities.opencti_vulnerability import Vulnerability
 from .utils.constants import (
-    MultipleStixCyberObservableRelationship,
+    MultipleRefRelationship,
     StixCyberObservableTypes,
     StixMetaTypes,
 )
@@ -91,11 +89,11 @@
     "Report",
     "StixCoreRelationship",
     "StixCyberObservable",
-    "StixCyberObservableRelationship",
+    "StixNestedRefRelationship",
     "StixCyberObservableTypes",
     "StixDomainObject",
     "StixMetaTypes",
-    "MultipleStixCyberObservableRelationship",
+    "MultipleRefRelationship",
     "StixObjectOrStixRelationship",
     "StixSightingRelationship",
     "ThreatActor",

pycti/api/opencti_api_client.py

@@ -45,10 +45,10 @@
 from pycti.entities.opencti_stix_core_object import StixCoreObject
 from pycti.entities.opencti_stix_core_relationship import StixCoreRelationship
 from pycti.entities.opencti_stix_cyber_observable import StixCyberObservable
-from pycti.entities.opencti_stix_cyber_observable_relationship import (
-    StixCyberObservableRelationship,
-)
 from pycti.entities.opencti_stix_domain_object import StixDomainObject
+from pycti.entities.opencti_stix_nested_ref_relationship import (
+    StixNestedRefRelationship,
+)
 from pycti.entities.opencti_stix_object_or_stix_relationship import (
     StixObjectOrStixRelationship,
 )
@@ -166,7 +166,7 @@ def __init__(
         self.stix_cyber_observable = StixCyberObservable(self, File)
         self.stix_core_relationship = StixCoreRelationship(self)
         self.stix_sighting_relationship = StixSightingRelationship(self)
-        self.stix_cyber_observable_relationship = StixCyberObservableRelationship(self)
+        self.stix_nested_ref_relationship = StixNestedRefRelationship(self)
         self.identity = Identity(self)
         self.event = Event(self)
         self.location = Location(self)

pycti/entities/opencti_case_incident.py

@@ -537,7 +537,7 @@ def add_stix_object_or_stix_relationship(self, **kwargs):
                 + "}",
             )
             query = """
-               mutation CaseIncidentEditRelationAdd($id: ID!, $input: StixMetaRelationshipAddInput!) {
+               mutation CaseIncidentEditRelationAdd($id: ID!, $input: StixRefRelationshipAddInput!) {
                     caseIncidentRelationAdd(id: $id, input: $input) {
                         id
                     }

pycti/entities/opencti_feedback.py

@@ -554,7 +554,7 @@ def add_stix_object_or_stix_relationship(self, **kwargs):
                 + "}",
             )
             query = """
-               mutation FeedbackEditRelationAdd($id: ID!, $input: StixMetaRelationshipAddInput!) {
+               mutation FeedbackEditRelationAdd($id: ID!, $input: StixRefRelationshipAddInput!) {
                     feedbackRelationAdd(id: $id, input: $input) {
                         id
                     }

pycti/entities/opencti_grouping.py

@@ -503,7 +503,7 @@ def add_stix_object_or_stix_relationship(self, **kwargs):
                 *(stix_object_or_stix_relationship_id, id),
             )
             query = """
-               mutation GroupingEditRelationAdd($id: ID!, $input: StixMetaRelationshipAddInput) {
+               mutation GroupingEditRelationAdd($id: ID!, $input: StixRefRelationshipAddInput!) {
                    groupingRelationAdd(id: $id, input: $input) {
                         id
                    }

pycti/entities/opencti_note.py

@@ -495,7 +495,7 @@ def add_stix_object_or_stix_relationship(self, **kwargs):
                 *(stix_object_or_stix_relationship_id, id),
             )
             query = """
-               mutation NoteEdit($id: ID!, $input: StixMetaRelationshipAddInput) {
+               mutation NoteEdit($id: ID!, $input: StixRefRelationshipAddInput!) {
                    noteEdit(id: $id) {
                         relationAdd(input: $input) {
                             id

pycti/entities/opencti_observed_data.py

@@ -209,7 +209,7 @@ def __init__(self, opencti):
                         }
                         ... on Case {
                             name
-                        }                             
+                        }
                         ... on StixCoreRelationship {
                             standard_id
                             spec_version
@@ -471,7 +471,7 @@ def add_stix_object_or_stix_relationship(self, **kwargs):
                 *(stix_object_or_stix_relationship_id, id),
             )
             query = """
-               mutation ObservedDataEdit($id: ID!, $input: StixMetaRelationshipAddInput) {
+               mutation ObservedDataEdit($id: ID!, $input: StixRefRelationshipAddInput!) {
                    observedDataEdit(id: $id) {
                         relationAdd(input: $input) {
                             id