Skip to content

Commit 336b887

Browse files
author
Jens Kürten
committed
refactor: Rename 'attached' to 'linked' in event data models and documentation
1 parent 923f06c commit 336b887

File tree

9 files changed

+23
-108
lines changed

9 files changed

+23
-108
lines changed

csfunctions/events/document_create_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
class DocumentCreateCheckData(BaseModel):
1111
documents: list[Document] = Field(..., description="List of documents that are about to be created")
12-
attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
12+
linked_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
1313

1414

1515
class DocumentCreateCheckEvent(BaseEvent):

csfunctions/events/document_modify_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
class DocumentModifyCheckData(BaseModel):
1111
documents: list[Document] = Field(..., description="List of documents that are about to be modified")
12-
attached_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
12+
linked_parts: list[Part] = Field(..., description="List of parts that belong to the documents")
1313

1414

1515
class DocumentModifyCheckEvent(BaseEvent):

csfunctions/events/part_create_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
class PartCreateCheckData(BaseModel):
1111
parts: list[Part] = Field(..., description="List of parts that are about to be created")
12-
attached_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
12+
linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
1313

1414

1515
class PartCreateCheckEvent(BaseEvent):

csfunctions/events/part_modify_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
class PartModifyCheckData(BaseModel):
1111
parts: list[Part] = Field(..., description="List of parts that are about to be modified")
12-
attached_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
12+
linked_documents: list[Document] = Field(..., description="List of documents that are referenced by the parts.")
1313

1414

1515
class PartModifyCheckEvent(BaseEvent):

docs/reference/events.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The event is triggered before any field calculations are performed.
1818
|Attribute|Type|Description|
1919
|-|-|-|
2020
|documents| list[[Document](objects.md#document)]|List of documents that are about to be created.|
21-
|attached_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
21+
|linked_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
2222

2323
## DocumentModifyCheckEvent
2424
`csfunctions.events.DocumentModifyCheckEvent`
@@ -37,7 +37,7 @@ The event is triggered before any field calculations are performed.
3737
|Attribute|Type|Description|
3838
|-|-|-|
3939
|documents| list[[Document](objects.md#document)]|List of documents that are about to be modified.|
40-
|attached_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
40+
|linked_parts| list[[Part](objects.md#part)]|List of parts that belong to the documents.|
4141

4242

4343
## DocumentReleaseCheckEvent
@@ -143,7 +143,7 @@ The event is triggered before any field calculations are performed.
143143
|Attribute|Type|Description|
144144
|-|-|-|
145145
|parts| list[[Part](objects.md#part)]|List of parts that are about to be created.|
146-
|attached_documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
146+
|linked_documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
147147

148148
## PartModifyCheckEvent
149149
`csfunctions.events.PartModifyCheckEvent`
@@ -162,7 +162,8 @@ The event is triggered before any field calculations are performed.
162162
|Attribute|Type|Description|
163163
|-|-|-|
164164
|parts| list[[Part](objects.md#part)]|List of parts that are about to be modified.|
165-
|attached_documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
165+
|linked_documents| list[[Document](objects.md#document)]|List of documents that are referenced by the parts.|
166+
166167
## PartReleaseCheckEvent
167168
`csfunctions.events.PartReleaseCheckEvent`
168169

json_schemas/data_response.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
"properties": {
33
"response_type": {
44
"const": "data",
5-
"enum": [
6-
"data"
7-
],
85
"title": "Response Type",
96
"type": "string"
107
},

json_schemas/error_response.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
"properties": {
33
"response_type": {
44
"const": "error",
5-
"enum": [
6-
"error"
7-
],
85
"title": "Response Type",
96
"type": "string"
107
},

0 commit comments

Comments
 (0)