Query API(s) support include_fields query params to reduce response footprint.

Following API(s) support `include_fields`:

1. Connections
2. Presentation exchange
3. Credential exchange
4. Data agreements

Signed-off-by: George J Padayatti <[email protected]>

Author: georgepadayatti

mydata_did/patched_protocols/issue_credential/v1_0/models/credential_exchange.py

@@ -193,74 +193,93 @@ class Meta:
         description="Credential exchange identifier",
         example=UUIDFour.EXAMPLE,
     )
+
     connection_id = fields.Str(
         required=False, description="Connection identifier", example=UUIDFour.EXAMPLE
     )
+
     thread_id = fields.Str(
         required=False, description="Thread identifier", example=UUIDFour.EXAMPLE
     )
+
     parent_thread_id = fields.Str(
         required=False, description="Parent thread identifier", example=UUIDFour.EXAMPLE
     )
+
     initiator = fields.Str(
         required=False,
         description="Issue-credential exchange initiator: self or external",
         example=V10CredentialExchange.INITIATOR_SELF,
         validate=validate.OneOf(["self", "external"]),
     )
+
     role = fields.Str(
         required=False,
         description="Issue-credential exchange role: holder or issuer",
         example=V10CredentialExchange.ROLE_ISSUER,
         validate=validate.OneOf(["holder", "issuer"]),
     )
+
     state = fields.Str(
         required=False,
         description="Issue-credential exchange state",
         example=V10CredentialExchange.STATE_ACKED,
     )
+
     credential_definition_id = fields.Str(
         required=False,
         description="Credential definition identifier",
         **INDY_CRED_DEF_ID,
     )
+
     schema_id = fields.Str(
         required=False, description="Schema identifier", **INDY_SCHEMA_ID
     )
+
     credential_proposal_dict = fields.Dict(
         required=False, description="Serialized credential proposal message"
     )
+
     credential_offer_dict = fields.Dict(
         required=False, description="Serialized credential offer message"
     )
+
     credential_offer = fields.Dict(
         required=False, description="(Indy) credential offer"
     )
+
     credential_request = fields.Dict(
         required=False, description="(Indy) credential request"
     )
+
     credential_request_metadata = fields.Dict(
         required=False, description="(Indy) credential request metadata"
     )
+
     credential_id = fields.Str(
         required=False, description="Credential identifier", example=UUIDFour.EXAMPLE
     )
+
     raw_credential = fields.Dict(
         required=False,
         description="Credential as received, prior to storage in holder wallet",
     )
+
     credential = fields.Dict(
         required=False, description="Credential as stored")
+
     auto_offer = fields.Bool(
         required=False,
         description="Holder choice to accept offer in this credential exchange",
         example=False,
     )
+
     auto_issue = fields.Bool(
         required=False,
         description="Issuer choice to issue to request in this credential exchange",
         example=False,
     )
+
     auto_remove = fields.Bool(
         required=False,
         default=True,
@@ -269,14 +288,17 @@ class Meta:
         ),
         example=False,
     )
+
     error_msg = fields.Str(
         required=False,
         description="Error message",
         example="credential definition identifier is not set in proposal",
     )
+
     revoc_reg_id = fields.Str(
         required=False, description="Revocation registry identifier"
     )
+
     revocation_id = fields.Str(
         required=False, description="Credential identifier within revocation registry"
     )

mydata_did/patched_protocols/issue_credential/v1_0/routes.py

@@ -62,6 +62,8 @@
 from ....v1_0.models.data_agreement_instance_model import DataAgreementInstance, DataAgreementInstanceSchema
 from ....v1_0.utils.did.mydata_did import DIDMyData
 from ....v1_0.utils.wallet.key_type import KeyType
+from ....v1_0.utils.util import comma_separated_str_to_list
+
 
 class V10CredentialExchangeListQueryStringSchema(OpenAPISchema):
     """Parameters and validators for credential exchange list query."""
@@ -113,6 +115,13 @@ class V10CredentialExchangeListQueryStringSchema(OpenAPISchema):
         example=UUIDFour.EXAMPLE,
     )
 
+    # Response fields
+    include_fields = fields.Str(
+        required=False,
+        description="Comma separated fields to be included in the response.",
+        example="connection_id,state,presentation_exchange_id",
+    )
+
 
 class V10CredentialExchangeListResultSchema(OpenAPISchema):
     """Result schema for Aries#0036 v1.0 credential exchange query."""
@@ -384,11 +393,14 @@ class DataAgreementBoundCredentialOfferMatchInfoSchema(OpenAPISchema):
         example=UUIDFour.EXAMPLE
     )
 
+
 class SendDataAgreementNegotiationProblemReportRequestSchema(OpenAPISchema):
     """Request schema for sending problem report."""
 
-    explain = fields.Str(description="Describe the problem", required=True, example="Data agreement context decorator not found in the didcomm message.")
-    problem_code = fields.Str(description="Problem code", required=True, example=DataAgreementNegotiationProblemReportReason.DATA_AGREEMENT_CONTEXT_INVALID.value)
+    explain = fields.Str(description="Describe the problem", required=True,
+                         example="Data agreement context decorator not found in the didcomm message.")
+    problem_code = fields.Str(description="Problem code", required=True,
+                              example=DataAgreementNegotiationProblemReportReason.DATA_AGREEMENT_CONTEXT_INVALID.value)
 
 
 @docs(tags=["issue-credential"], summary="Fetch all credential exchange records")
@@ -416,8 +428,18 @@ async def credential_exchange_list(request: web.BaseRequest):
     }
 
     try:
+
         records = await V10CredentialExchange.query(context, tag_filter, post_filter)
-        results = [record.serialize() for record in records]
+
+        # Fields to be included in the response.
+        include_fields = request.query.get("include_fields")
+        include_fields = comma_separated_str_to_list(
+            include_fields) if include_fields else None
+
+        # Serialise presentation exchange records and customize it based on include_fields.
+        results = ADAManager.serialize_credential_exchange_records(
+            records, True, include_fields)
+
     except (StorageError, BaseModelError) as err:
         raise web.HTTPBadRequest(reason=err.roll_up) from err
 
@@ -1539,11 +1561,12 @@ async def send_data_agreement_reject_message_for_credential_offer(request: web.B
 
         await outbound_handler(data_agreement_negotiation_reject_message, connection_id=cred_ex_record.connection_id)
 
-    except (ADAManagerError,StorageError) as err:
+    except (ADAManagerError, StorageError) as err:
         raise web.HTTPBadRequest(reason=err.roll_up) from err
 
     return web.json_response(cred_ex_record.serialize())
 
+
 @docs(
     tags=["issue-credential"], summary="Send data agreement negotiation problem report message"
 )
@@ -1579,11 +1602,9 @@ async def send_data_agreement_negotiation_problem_report(request: web.BaseReques
         )
     except StorageNotFoundError as err:
         raise web.HTTPNotFound(reason=err.roll_up) from err
-    
 
     if not cred_ex_record.data_agreement:
         raise web.HTTPBadRequest(reason=f"Data agreement is not available.")
-    
 
     # Initialize ADA manager
     ada_manager = ADAManager(context)
@@ -1597,7 +1618,6 @@ async def send_data_agreement_negotiation_problem_report(request: web.BaseReques
         if not connection_record.is_ready:
             raise web.HTTPForbidden(
                 reason=f"Connection {connection_id} not ready")
-        
 
         data_agreement_negotiation_problem_report = await ada_manager.construct_data_agreement_negotiation_problem_report_message(
             connection_record=connection_record,
@@ -1611,7 +1631,7 @@ async def send_data_agreement_negotiation_problem_report(request: web.BaseReques
             data_agreement_negotiation_problem_report_message=data_agreement_negotiation_problem_report,
         )
 
-    except (ADAManagerError,StorageError) as err:
+    except (ADAManagerError, StorageError) as err:
         raise web.HTTPBadRequest(reason=err.roll_up) from err
 
     return web.json_response({})
@@ -1675,19 +1695,18 @@ async def send_data_agreement_termination_message(request: web.BaseRequest):
         if not connection_record.is_ready:
             raise web.HTTPForbidden(
                 reason=f"Connection {connection_id} not ready")
-        
+
         # Fetch wallet from context
         wallet: IndyWallet = await context.inject(BaseWallet)
-        
+
         pairwise_local_did_record = await wallet.get_local_did(connection_record.my_did)
         principle_did = DIDMyData.from_public_key_b58(
             pairwise_local_did_record.verkey, key_type=KeyType.ED25519)
-        
+
         if data_agreement_instance.principle_did != principle_did.did:
             raise web.HTTPBadRequest(
                 reason=f"Only the principle can terminate the data agreement."
             )
-        
 
         (data_agreement_instance, data_agreement_terminate_message) = await ada_manager.construct_data_agreement_termination_terminate_message(
             data_agreement_instance=data_agreement_instance,
@@ -1702,11 +1721,12 @@ async def send_data_agreement_termination_message(request: web.BaseRequest):
 
         await outbound_handler(data_agreement_terminate_message, connection_id=cred_ex_record.connection_id)
 
-    except (ADAManagerError,StorageError) as err:
+    except (ADAManagerError, StorageError) as err:
         raise web.HTTPBadRequest(reason=err.roll_up) from err
 
     return web.json_response(cred_ex_record.serialize())
 
+
 async def register(app: web.Application):
     """Register routes."""