Added documentation of key/field name dependency from payload.py

Cyrus Radfar · Cyrus Radfar · commit 1971e94e7215 · 2024-12-06T15:19:10.000-10:00
diff --git a/python_anvil/api_resources/payload.py b/python_anvil/api_resources/payload.py
@@ -179,6 +179,9 @@ class DocumentUpload(FileCompatibleBaseModel):
     # the client library side.
     # This might be a bug on the `pydantic` side(?) when this object gets
     # converted into a dict.
+
+    # NOTE: This field name is referenced in the models.py file, if you change it you 
+    #   must change the reference
     file: Any = None
     fields: List[SignatureField]
     font_size: int = 14
@@ -207,6 +210,9 @@ class CreateEtchPacketPayload(FileCompatibleBaseModel):
 
     name: str
     signers: List[EtchSigner]
+    # NOTE: This is a list of `AttachableEtchFile` objects, but we need to
+    # override the default `FileCompatibleBaseModel` to handle multipart/form-data
+    # uploads correctly. This field name is referenced in the models.py file.
     files: List["AttachableEtchFile"]
     signature_email_subject: Optional[str] = None
     signature_email_body: Optional[str] = None
