From f91d3cfd34beb068413b7bdfee68c36f780ede3e Mon Sep 17 00:00:00 2001
From: Eric Richardson <eric@polymesh.network>
Date: Tue, 20 Feb 2024 09:41:00 -0500
Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20add=20example=20fo?=
 =?UTF-8?q?r=20mediator=20affirmation=20model?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/assets/assets.controller.ts                      | 2 +-
 src/assets/models/required-mediators.model.ts        | 2 ++
 src/settlements/models/mediator-affirmation.model.ts | 3 ++-
 3 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/assets/assets.controller.ts b/src/assets/assets.controller.ts
index 7ca1fab8..98106dc7 100644
--- a/src/assets/assets.controller.ts
+++ b/src/assets/assets.controller.ts
@@ -439,7 +439,7 @@ export class AssetsController {
   @ApiOperation({
     summary: "Fetch an Asset's required mediators",
     description:
-      'This endpoint provides a list required mediators for the asset. These identities must affirm any instruction involving the asset',
+      'This endpoint provides a list of required mediators for the asset. These identities must affirm any instruction involving the asset',
   })
   @ApiParam({
     name: 'ticker',
diff --git a/src/assets/models/required-mediators.model.ts b/src/assets/models/required-mediators.model.ts
index 1e8e9195..8188649a 100644
--- a/src/assets/models/required-mediators.model.ts
+++ b/src/assets/models/required-mediators.model.ts
@@ -5,6 +5,8 @@ import { ApiProperty } from '@nestjs/swagger';
 export class RequiredMediatorsModel {
   @ApiProperty({
     description: 'Required mediators for an asset',
+    example: ['0x0600000000000000000000000000000000000000000000000000000000000000'],
+    isArray: true,
   })
   readonly mediators: string[];
 
diff --git a/src/settlements/models/mediator-affirmation.model.ts b/src/settlements/models/mediator-affirmation.model.ts
index 2d0411bd..69776bd6 100644
--- a/src/settlements/models/mediator-affirmation.model.ts
+++ b/src/settlements/models/mediator-affirmation.model.ts
@@ -13,7 +13,8 @@ export class MediatorAffirmationModel {
 
   @ApiPropertyOptional({
     description:
-      'The expiry of the affirmation. The time should be checked to ensure the affirmation is still valid',
+      'The expiry of the affirmation. If present, the time should be checked to ensure the affirmation is still valid',
+    example: new Date('05/23/2055').toISOString(),
   })
   readonly expiry?: Date;