chore: improve on help texts in swagger and .env

Author: janezicmatej

.env.example.prod

@@ -40,7 +40,7 @@ ALLOWED_ORIGINS=csv,includehttp
 # History older than this many rounds will get dropped. There are 960 round
 # each day so 30 * 960 = 28800 means there will be 30 days of history kept.
 # You can comment this out to never delete history. In this case it is suggested
-# to also comment out the delte_history service from docker compose.
+# to also comment out the delete_history service from docker compose.
 HISTORY_KEEP_ROUNDS = 28800
 
 # project related

fdc/views/v1.py

@@ -34,7 +34,10 @@ def _list(self, request, *args, **kwargs):
         return response.Response(serializer.data)
 
     @extend_schema(
-        description="Retrieves the attestation minimal proofs based on voting round id",
+        description=(
+            "Returns full merkle tree with proof for each leaf for given round. "
+            "Leafs are abi decoded."
+        ),
         parameters=[ListAttestationResultV1QuerySerializer],
         responses=AttestationResultV1Serializer(many=True),
     )
@@ -43,7 +46,10 @@ def list(self, request, *args, **kwargs):
         return self._list(request, *args, **kwargs)
 
     @extend_schema(
-        description="Retrieves the attestation minimal proofs based on voting round id",
+        description=(
+            "Returns full merkle tree with proof for each leaf for given round. "
+            "Leafs are abi encoded."
+        ),
         parameters=[ListAttestationResultV1QuerySerializer],
         responses=AttestationResultRawV1Serializer(many=True),
     )
@@ -80,7 +86,10 @@ def _proof_by_request_round(self, request, *args, **kwargs):
         return response.Response(serializer.data)
 
     @extend_schema(
-        description="Retrieves the attestation request proof based on request bytes and voting round id",
+        description=(
+            "Retrieves the attestation request proof for given request bytes and "
+            "voting round. Leafs are abi decoded."
+        ),
         request=AttestationResponseProofByRequestRoundV1RequestSerializer,
         responses={
             200: AttestationResultV1Serializer,
@@ -100,7 +109,10 @@ def proof_by_request_round(self, request, *args, **kwargs):
         return self._proof_by_request_round(request, *args, **kwargs)
 
     @extend_schema(
-        description="Retrieves the attestation request proof based on request bytes and voting round id",
+        description=(
+            "Retrieves the attestation request proof for given request bytes and "
+            "voting round. Leafs are abi encoded."
+        ),
         request=AttestationResponseProofByRequestRoundV1RequestSerializer,
         responses={
             200: AttestationResultRawV1Serializer,