add description to models

didx-xyz · Jul 15, 2024 · 51d1628 · 51d1628
1 parent 7638e12
commit 51d1628
Showing 1 changed file with 12 additions and 4 deletions.
diff --git a/app/models/wallet.py b/app/models/wallet.py
@@ -12,17 +12,25 @@ class SetDidEndpointRequest(BaseModel):
 
 
 class VCRecord(VCRecordAcaPy):
-    credential_id: str = Field(..., alias="record_id")
-    record_id: str = Field(..., alias="credential_id")
+    credential_id: str = Field(
+        ..., alias="record_id", description="Rename record_id to credential_id"
+    )
+    record_id: str = Field(
+        ..., alias="credential_id", description="For backwards compatibility"
+    )
 
 
 class VCRecordList(BaseModel):
     results: Optional[List[VCRecord]] = None
 
 
 class IndyCredInfo(IndyCredInfoAcaPy):
-    credential_id: str = Field(..., alias="referent")
-    referent: str = Field(..., alias="credential_id")
+    credential_id: str = Field(
+        ..., alias="referent", description="Rename referent to credential_id"
+    )
+    referent: str = Field(
+        ..., alias="credential_id", description="For backwards compatibility"
+    )
 
 
 class CredInfoList(BaseModel):