homogenize linked/attached parts and documents

Jens Kürten · Jens Kürten · commit 9c2fd55e768f · 2025-04-03T11:57:59.000+02:00
diff --git a/csfunctions/events/document_create_check.py b/csfunctions/events/document_create_check.py
@@ -9,7 +9,7 @@
 
 class DocumentCreateCheckData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that are about to be created")
-    linked_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
 
 
 class DocumentCreateCheckEvent(BaseEvent):
diff --git a/csfunctions/events/document_field_calculation.py b/csfunctions/events/document_field_calculation.py
@@ -10,7 +10,7 @@
 class DocumentFieldCalculationData(BaseModel):
     document: Document = Field(..., description="Current state of the document")
     action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
-    linked_parts: list[Part] = Field(..., description="Parts that belong to the document")
+    parts: list[Part] = Field(..., description="Parts that belong to the document")
 
 
 class DocumentFieldCalculationEvent(BaseEvent):
diff --git a/csfunctions/events/document_modify_check.py b/csfunctions/events/document_modify_check.py
@@ -9,7 +9,7 @@
 
 class DocumentModifyCheckData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that are about to be modified")
-    linked_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
 
 
 class DocumentModifyCheckEvent(BaseEvent):
diff --git a/csfunctions/events/document_release_check.py b/csfunctions/events/document_release_check.py
@@ -10,7 +10,7 @@
 
 class DocumentReleaseCheckData(BaseModel):
     documents: list[Document] = Field(..., description="List of documents that will be released.")
-    attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
+    parts: list[Part] = Field(..., description="List of parts that belong to the documents")
     dialog_data: DocumentReleasedDialogData
 
 
diff --git a/csfunctions/events/engineering_change_release_check.py b/csfunctions/events/engineering_change_release_check.py
@@ -8,8 +8,8 @@
 
 
 class EngineeringChangeReleaseCheckData(BaseModel):
-    attached_documents: list[Document] = Field(..., description="List of included documents.")
-    attached_parts: list[Part] = Field(..., description="List of included parts.")
+    documents: list[Document] = Field(..., description="List of included documents.")
+    parts: list[Part] = Field(..., description="List of included parts.")
     engineering_changes: list[EngineeringChange] = Field(
         ..., description="List of engineering changes that will be released."
     )
diff --git a/csfunctions/events/part_create_check.py b/csfunctions/events/part_create_check.py
@@ -9,7 +9,7 @@
 
 class PartCreateCheckData(BaseModel):
     parts: list[Part] = Field(..., description="List of parts that are about to be created")
-    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
 
 
 class PartCreateCheckEvent(BaseEvent):
diff --git a/csfunctions/events/part_field_calculation.py b/csfunctions/events/part_field_calculation.py
@@ -11,7 +11,7 @@ class PartFieldCalculationData(BaseModel):
     part: Part = Field(..., description="Current state of the part")
     action: Literal["create", "modify", "copy", "index"] = Field(..., description="Action being performed")
 
-    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
 
 
 class PartFieldCalculationEvent(BaseEvent):
diff --git a/csfunctions/events/part_modify_check.py b/csfunctions/events/part_modify_check.py
@@ -9,7 +9,7 @@
 
 class PartModifyCheckData(BaseModel):
     parts: list[Part] = Field(..., description="List of parts that are about to be modified")
-    linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
 
 
 class PartModifyCheckEvent(BaseEvent):
diff --git a/csfunctions/events/part_release_check.py b/csfunctions/events/part_release_check.py
@@ -10,7 +10,7 @@
 
 class PartReleaseCheckData(BaseModel):
     parts: list[Part] = Field(..., description="List of parts that will be released.")
-    attached_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
+    documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
     dialog_data: PartReleasedDialogData
 
 
diff --git a/docs/reference/events.md b/docs/reference/events.md
@@ -18,7 +18,7 @@ The event is triggered before any field calculations are performed.
 |Attribute|Type|Description|
 |-|-|-|
 |documents| list[[Document](objects.md#document)]|List of documents that are about to be created.|
-|linked_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
+|parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
 
 ## DocumentModifyCheckEvent
 `csfunctions.events.DocumentModifyCheckEvent`
@@ -37,7 +37,7 @@ The event is triggered before any field calculations are performed.
 |Attribute|Type|Description|
 |-|-|-|
 |documents| list[[Document](objects.md#document)]|List of documents that are about to be modified.|
-|linked_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
+|parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
 
 
 ## DocumentReleaseCheckEvent
@@ -57,7 +57,7 @@ Be aware that the document is not released yet and the release might still be ab
 |Attribute|Type|Description|
 |-|-|-|
 |documents| list[[Document](objects.md#document)]|List of documents that will be released.|
-|attached_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
+|parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
 |dialog_data|DocumentReleaseDialogData|Contents of the dialog.|
 
 **DocumentReleaseCheckDialogData:**
@@ -106,7 +106,7 @@ The event expects a DataResponse containing a dictionary of field names and thei
 |-|-|-|
 |document|[Document](objects.md#document)|Current state of the document|
 |action|Literal["create", "modify", "copy", "index"]|Action being performed|
-|linked_parts|list[[Part](objects.md#part)]|Parts that belong to the document|
+|parts|list[[Part](objects.md#part)]|Parts that belong to the document|
 
 
 
@@ -127,8 +127,8 @@ Be aware that the engineering change is not released yet and the release might s
 |Attribute|Type|Description|
 |-|-|-|
 |engineering_changes| list[[EngineeringChange](objects.md#engineeringchange)]|List of engineering changes that will be released.|
-|attached_documents| list[[Document](objects.md#document)]|List of included documents.|
-|attached_parts| list[[Part](objects.md#part)]|List of included parts.|
+|documents| list[[Document](objects.md#document)]|List of included documents.|
+|parts| list[[Part](objects.md#part)]|List of included parts.|
 
 
 ## EngineeringChangeReleasedEvent
@@ -163,7 +163,7 @@ The event is triggered before any field calculations are performed.
 |Attribute|Type|Description|
 |-|-|-|
 |parts| list[[Part](objects.md#part)]|List of parts that are about to be created.|
-|linked_documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
+|documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
 
 ## PartModifyCheckEvent
 `csfunctions.events.PartModifyCheckEvent`
@@ -182,7 +182,7 @@ The event is triggered before any field calculations are performed.
 |Attribute|Type|Description|
 |-|-|-|
 |parts| list[[Part](objects.md#part)]|List of parts that are about to be modified.|
-|linked_documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
+|documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
 
 ## PartReleaseCheckEvent
 `csfunctions.events.PartReleaseCheckEvent`
@@ -201,7 +201,7 @@ Be aware that the part is not released yet and the release might still be aborte
 |Attribute|Type|Description|
 |-|-|-|
 |parts| list[[Part](objects.md#part)]|List of parts that will released.|
-|attached_documents| list[[Document](objects.md#document)]|List of documents that belong to the released parts.|
+|documents| list[[Document](objects.md#document)]|List of documents that belong to the released parts.|
 |dialog_data|PartReleaseDialogData|Contents of the dialog.|
 
 **PartReleaseCheckDialogData:**
@@ -250,7 +250,7 @@ The event expects a DataResponse containing a dictionary of field names and thei
 |-|-|-|
 |part|[Part](objects.md#part)|Current state of the part|
 |action|Literal["create", "modify", "copy", "index"]|Action being performed|
-|linked_documents| list[[Document](objects.md#document)]|List of documents that belong to the part|
+|documents| list[[Document](objects.md#document)]|List of documents that belong to the part|
 
 
 ## WorkflowTaskTriggerEvent

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,8 @@`
`8`	`8`
`9`	`9`
`10`	`10`	`class EngineeringChangeReleaseCheckData(BaseModel):`
`11`		`- attached_documents: list[Document] = Field(..., description="List of included documents.")`
`12`		`- attached_parts: list[Part] = Field(..., description="List of included parts.")`
	`11`	`+ documents: list[Document] = Field(..., description="List of included documents.")`
	`12`	`+ parts: list[Part] = Field(..., description="List of included parts.")`
`13`	`13`	`engineering_changes: list[EngineeringChange] = Field(`
`14`	`14`	`..., description="List of engineering changes that will be released."`
`15`	`15`	`)`