Skip to content

Commit

Permalink
docs: ✏️ add example for mediator affirmation model
Browse files Browse the repository at this point in the history
  • Loading branch information
polymath-eric committed Feb 20, 2024
1 parent 7f4e7e9 commit f91d3cf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/assets/assets.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 2 additions & 0 deletions src/assets/models/required-mediators.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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[];

Expand Down
3 changes: 2 additions & 1 deletion src/settlements/models/mediator-affirmation.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit f91d3cf

Please sign in to comment.