Créating an official foreign key field

api/rpk-api/firm/contract/models.py

@@ -6,7 +6,7 @@ from uuid import UUID
 from beanie import PydanticObjectId
 from pydantic import BaseModel, Field
 
-from firm.core.models import CrudDocument, RichtextSingleline, RichtextMultiline, DictionaryEntry
+from firm.core.models import CrudDocument, RichtextSingleline, RichtextMultiline, DictionaryEntry, ForeignKey
 from firm.core.filter import Filter, FilterSchema
 from firm.entity.models import Entity
 
@@ -25,27 +25,10 @@ class ContractDraftStatus(str, Enum):
 
 
 class DraftParty(BaseModel):
-    entity_id: PydanticObjectId = Field(
-        foreignKey={
-            "reference": {
-                "resource": "entities",
-                "schema": "Entity",
-            }
-        },
-        default="",
-        title="Partie"
-    )
+    entity_id: PydanticObjectId = ForeignKey("entities", "Entity", default="", title="Partie")
+    entity: SkipJsonSchema[Entity] = Field(default=None, exclude=True, )
     part: str = Field(title="Rôle")
-    representative_id: PydanticObjectId = Field(
-        foreignKey={
-            "reference": {
-                "resource": "entities",
-                "schema": "Entity",
-            }
-        },
-        default="",
-        title="Représentant"
-    )
+    representative_id: PydanticObjectId = ForeignKey("entities", "Entity", default="", title="Représentant")
 
     class Config:
         title = 'Partie'
@@ -74,14 +57,10 @@ class ProvisionGenuine(BaseModel):
 
 class ContractProvisionTemplateReference(BaseModel):
     type: Literal['template'] = ContractProvisionType.template
-    provision_template_id: PydanticObjectId = Field(
-        foreignKey={
-            "reference": {
-                "resource": "templates/provisions",
-                "schema": "ProvisionTemplate",
-                "displayedFields": ['title', 'body']
-            },
-        },
+    provision_template_id: PydanticObjectId = ForeignKey(
+        "templates/provisions",
+        "ProvisionTemplate",
+        displayed_fields=['title', 'body'],
         props={"parametrized": True},
         default="",
         title="Template de clause"

api/rpk-api/firm/core/models.py

@@ -114,6 +114,20 @@ def RichtextSingleline(*args, **kwargs):
     return Field(*args, **kwargs)
 
 
+def ForeignKey(resource, schema, displayed_fields=None, *args, **kwargs):
+    kwargs["foreignKey"] = {
+        "reference": {
+            "resource": resource,
+            "schema": schema,
+        }
+    }
+
+    if displayed_fields:
+        kwargs["foreignKey"]["reference"]["displayedFields"] = displayed_fields
+
+    return Field(*args, **kwargs)
+
+
 class DictionaryEntry(BaseModel):
     key: str
     value: str = ""